File length: 5308443
# Quickstart -  Introduction
Source: https://supertokens.com/docs/quickstart/introduction

## Overview

This quickstart will guide you through how to set up a basic project that uses **SuperTokens** to authenticate users.
The tutorial shows an **Email/Password** login flow, rendered by either our **Prebuilt UI components** or by your own **Custom UI**.



## Before you start

Before going into the actual tutorial, let's get a clear picture of how **SuperTokens** works and some of the terms that we will use throughout the documentation.

### SuperTokens Core

The main service that provides all the functionality is called the **SuperTokens Core**. SDKs communicate over an API with this service in order to
perform authentication related tasks.

Unlike with other providers, the **SuperTokens Frontend SDK** never talks to the **Authentication Service** directly.
All the requests target your existing **Backend Service**.
From there, the **Backend SDKs** are used to expose new authentication routes. Those in turn communicate with the **SuperTokens Core**.

You can check the following diagram for a high level overview of how the services will interact within an authentication setup that involves **SuperTokens**.

<Tabs
  defaultValue="ms"
  values={[
    { label: "Managed service", value: "ms" },
    { label: "Self hosted", value: "ss" },
  ]}
>
  <TabItem value="ms">
    <img
      src="/img/architecture/managed_service_without_dashboard.png"
      alt="Flowchart of architecture when using SuperTokens managed service"
    />
  </TabItem>
  <TabItem value="ss">
    <img
      src="/img/architecture/self_hosted_without_dashboard.png"
      alt="Flowchart of architecture when self-hosting SuperTokens"
    />
  </TabItem>
</Tabs>

:::info Edge Cases

- You can also host the **SuperTokens Core** yourself. In that case your backend will communicate with a service that exists inside your infrastructure.
- If you are using a backend for which we do not have an SDK, you will have to spin up an additional auth service in a language for which we do have a backend SDK (NodeJS, Python or Golang).
  :::

### Recipes

The functionalities that **SuperTokens** provides are bundled into objects that can be referred to as **Recipes**.
Everything from _authentication methods_ to _session and user management_ can be included under this concept.
In the following sections, we will see how recipes get initialised and configured and how you can customise them to fit your use case.

Now that we have cleared all this out, we can move forward with the actual tutorial.
Go to the next page to see how to configure your [Frontend Application](./frontend-setup).

# Quickstart -  Frontend Setup
Source: https://supertokens.com/docs/quickstart/frontend-setup

Start the setup by configuring your frontend application to use **SuperTokens** for authentication.

This guide uses the **SuperTokens pre-built UI** components.
If you want to create your own interface please check the **Custom UI** tutorial.



<PrebuiltUIInstructions>

## 1. Install the SDK

Run the following command in your terminal to install the package.

<Tabs>
  <Tab value="reactjs">
    <Tabs>
      <Tab value="npm7+">
        ```bash 
          npm i -s supertokens-auth-react
        ```
      </Tab>
      <Tab value="npm6">
        ```bash
        npm i -s supertokens-auth-react supertokens-web-js
        ```
      </Tab>
      <Tab value="yarn">
        ```bash
        yarn add supertokens-auth-react supertokens-web-js
        ```
      </Tab>
      <Tab value="pnpm">
        ```bash
        pnpm add supertokens-auth-react supertokens-web-js
        ```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="angular">
    <Tabs>
      <Tab value="npm7+">
        ```bash
        npm i -s supertokens-web-js
        ```
      </Tab>
      <Tab value="npm6">
        ```bash
        npm i -s supertokens-web-js
        ```
      </Tab>
      <Tab value="yarn">
        ```bash
        yarn add supertokens-web-js
        ```
      </Tab>
      <Tab value="pnpm">
        ```bash
        pnpm add supertokens-web-js
        ```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="vue">
    <Tabs>
      <Tab value="npm7+">
        ```bash
        npm i -s supertokens-web-js
        ```
      </Tab>
      <Tab value="npm6">
        ```bash
        npm i -s supertokens-web-js
        ```
      </Tab>
      <Tab value="yarn">
        ```bash
        yarn add supertokens-web-js
        ```
      </Tab>
      <Tab value="pnpm">
        ```bash
        pnpm add supertokens-web-js
        ```
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## 2. Initialize the SDK



<Tabs showMobileTab>
  <Tab value="reactjs">
    In your main application file call the `SuperTokens.init` function to initialize the SDK.
    The `init` call includes the [main configuration details](/docs/references/frontend-sdks/reference#sdk-configuration), as well as the **recipes** that you use in your setup.
    After that you have to wrap the application with the `SuperTokensWrapper` component.
    This provides authentication context for the rest of the UI tree.

    ```tsx

// highlight-start

SuperTokens.init({
  appInfo: {
    // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration
    appName: "<APP_NAME>",
    apiDomain: "<API_DOMAIN>",
    websiteDomain: "<WEBSITE_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
    websiteBasePath: "<WEBSITE_BASE_PATH>",
  },
  recipeList: [EmailPassword.init(), Session.init()],
});
// highlight-end

/* Your App */
class App extends React.Component {
  render() {
    return (
      // highlight-next-line
      <SuperTokensWrapper>
        {/*Your app components*/}
        // highlight-next-line
      </SuperTokensWrapper>
    );
  }
}
```
  </Tab>
  <Tab value="angular">
    Before we initialize the `supertokens-web-js` SDK let's see how we use it in our Angular app.

    **Architecture**

    - The `supertokens-web-js` SDK is responsible for session management and providing helper functions to check if a session exists, or validate the access token claims on the frontend (for example, to check for user roles before showing some UI). We initialise this SDK on the root of your Angular app, so that all pages in your app can use it.
    - You have to create a `<WEBSITE_BASE_PATH>*` route in the Angular app which renders our pre-built UI. which also needs to be initialised, but only on that route.

    **Creating the `<WEBSITE_BASE_PATH>` route**

    - Use the Angular CLI to generate a new route

      ```bash
      ng generate module auth --route auth --module app.module
      ```

    - Add the following code to your `auth` angular component

    ```tsx title="/app/auth/auth.component.ts"

  @Component({
    selector: "app-auth",
    template: '<div id="supertokensui"></div>',
  })
  export class AuthComponent implements OnDestroy, AfterViewInit {
    constructor(
      private renderer: Renderer2,
      @Inject(DOCUMENT) private document: Document,
    ) {}

    ngAfterViewInit() {
      this.loadScript("^{prebuiltUIVersion}");
    }

    ngOnDestroy() {
      // Remove the script when the component is destroyed
      const script = this.document.getElementById("supertokens-script");
      if (script) {
        script.remove();
      }
    }

    private loadScript(src: string) {
      const script = this.renderer.createElement("script");
      script.type = "text/javascript";
      script.src = src;
      script.id = "supertokens-script";
      script.onload = () => {
        supertokensUIInit({
          appInfo: {
            appName: "<APP_NAME>",
            apiDomain: "<API_DOMAIN>",
            websiteDomain: "<WEBSITE_DOMAIN>",
            apiBasePath: "<API_BASE_PATH>",
            websiteBasePath: "<WEBSITE_BASE_PATH>",
          },
          recipeList: [
            supertokensUIEmailPassword.init(),
            supertokensUISession.init(),
          ],
        });
      };
      this.renderer.appendChild(this.document.body, script);
    }
  }
  ```

    - In the `loadScript` function, we provide the SuperTokens config for the UI. We add the emailpassword and session recipe.

    - Initialize the `supertokens-web-js` SDK in your angular app's root component. This provides session management across your entire application.

    ```tsx title="/app/auth/auth.component.ts"

  @Component({
    selector: "app-auth",
    template: '<div id="supertokensui"></div>',
  })
  export class AuthComponent implements OnDestroy, AfterViewInit {
    constructor(
      private renderer: Renderer2,
      @Inject(DOCUMENT) private document: Document,
    ) {}

    ngAfterViewInit() {
      this.loadScript("^{prebuiltUIVersion}");
    }

    ngOnDestroy() {
      // Remove the script when the component is destroyed
      const script = this.document.getElementById("supertokens-script");
      if (script) {
        script.remove();
      }
    }

    private loadScript(src: string) {
      const script = this.renderer.createElement("script");
      script.type = "text/javascript";
      script.src = src;
      script.id = "supertokens-script";
      script.onload = () => {
        supertokensUIInit({
          appInfo: {
            appName: "<APP_NAME>",
            apiDomain: "<API_DOMAIN>",
            websiteDomain: "<WEBSITE_DOMAIN>",
            apiBasePath: "<API_BASE_PATH>",
            websiteBasePath: "<WEBSITE_BASE_PATH>",
          },
          recipeList: [
            supertokensUIEmailPassword.init(),
            supertokensUISession.init(),
          ],
        });
      };
      this.renderer.appendChild(this.document.body, script);
    }
  }
  ```
  </Tab>
  <Tab value="vue">
    Before we initialize the `supertokens-web-js` SDK let's see how we use it in our Vue app

    **Architecture**

    - The `supertokens-web-js` SDK is responsible for session management and providing helper functions to check if a session exists, or validate the access token claims on the frontend (for example, to check for user roles before showing some UI). We initialise this SDK on the root of your Vue app, so that all pages in your app can use it.
    - We create a `<WEBSITE_BASE_PATH>*` route in the Vue app which renders our pre-built UI which also needs to be initialised, but only on that route.

    **Creating the `<WEBSITE_BASE_PATH>` route**

    - Create a new file `AuthView.vue`, this Vue component is used to render the auth component:

    ```tsx
  <script lang="ts">
      export default defineComponent({
          setup() {
              const loadScript = (src: string) => {
                  const script = document.createElement('script');
                  script.type = 'text/javascript';
                  script.src = src;
                  script.id = 'supertokens-script';
                  script.onload = () => {
                      supertokensUIInit({
                          appInfo: {
                              appName: "<APP_NAME>",
                              apiDomain: "<API_DOMAIN>",
                              websiteDomain: "<WEBSITE_DOMAIN>",
                              apiBasePath: "<API_BASE_PATH>",
                              websiteBasePath: "<WEBSITE_BASE_PATH>"
                          },
                          recipeList: [
                              supertokensUIEmailPassword.init(),
                              supertokensUISession.init(),
                          ],
                      });
                  };
                  document.body.appendChild(script);
              };

              onMounted(() => {
                  loadScript('^{prebuiltUIVersion}');
              });

              onUnmounted(() => {
                  const script = document.getElementById('supertokens-script');
                  if (script) {
                      script.remove();
                  }
              });
          },
      });
  </script>

  <template>
      <div id="supertokensui" />
  </template>
  ```

      - In the `loadScript` function, we provide the SuperTokens config for the UI. We add the emailpassword and session recipe.

    - Initialize the `supertokens-web-js` SDK in your Vue app's `main.ts` file. This provides session management across your entire application.

    ```tsx title="/main.ts "
  // @ts-ignore
  // @ts-ignore
  // @ts-ignore

  SuperTokens.init({
    appInfo: {
      appName: "<APP_NAME>",
      apiDomain: "<API_DOMAIN>",
      apiBasePath: "<API_BASE_PATH>",
    },
    recipeList: [Session.init()],
  });

  const app = createApp(App);

  app.use(router);

  app.mount("#app");
  ```
  </Tab>
</Tabs>

## 3. Configure Routing

<Tabs showMobileTab>
  <Tab value="reactjs">
    In order for the **pre-built UI** to be rendered inside your application, you have to specify which routes show the authentication components.
    The **React SDK** uses [**React Router**](https://reactrouter.com/en/main) under the hood to achieve this.
    Based on whether you already use this package or not in your project, there are two different ways of configuring the routes.

    <Question question="Do you use react-router-dom?" defaultAnswer="Yes">
      <Answer title="Yes">
        Call the `getSuperTokensRoutesForReactRouterDom` method from within any `react-router-dom` `Routes` component.
        ```tsx

// highlight-next-line

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        {/*This renders the login UI on the <WEBSITE_BASE_PATH> route*/}
                        // highlight-next-line
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [EmailPasswordPreBuiltUI])}
                        {/*Your app routes*/}
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```
        :::important
If you are using `useRoutes`, `createBrowserRouter` or have routes defined in a different file, you need to adjust the code sample.
Please see [this issue](https://github.com/supertokens/supertokens-auth-react/issues/581#issuecomment-1246998493) for further details.
```tsx

function AppRoutes() {
  const authRoutes = getSuperTokensRoutesForReactRouterDom(
    reactRouterDom,
    [/* Add your UI recipes here e.g. EmailPasswordPrebuiltUI, PasswordlessPrebuiltUI, ThirdPartyPrebuiltUI */]
  );

  const routes = useRoutes([
    ...authRoutes.map(route => route.props),
    // Include the rest of your app routes 
  ]);

  return routes;
}

function App() {
  return (
    <SuperTokensWrapper>
      <BrowserRouter>
          <AppRoutes />
      </BrowserRouter>
    </SuperTokensWrapper>
  );
}
```
:::
      </Answer>
      <Answer title="No">
        Add the highlighted code snippet to your root level `render` function.
        ```tsx

class App extends React.Component {
    render() {
        // highlight-start
        if (canHandleRoute([EmailPasswordPreBuiltUI])) {
            // This renders the login UI on the <WEBSITE_BASE_PATH> route
            return getRoutingComponent([EmailPasswordPreBuiltUI])
        }
        // highlight-end

        return (
            <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
        );
    }

}
```
      </Answer>
    </Question>
  </Tab>
  <Tab value="angular">
    Update your angular router so that all auth related requests load the `auth` component
    ```tsx title="/app/app-routing.module.ts"

const routes: Routes = [
  // highlight-start
  {
    path: "^{appInfo.websiteBasePath_withoutForwardSlash}",
    // @ts-ignore
    loadChildren: () => import("./auth/auth.module").then((m) => m.AuthModule),
  },

  {
    path: "**",
    // @ts-ignore
    loadChildren: () => import("./home/home.module").then((m) => m.HomeModule),
  },
  // highlight-end
];

@NgModule({
  imports: [RouterModule.forRoot(routes)],
  exports: [RouterModule],
})
export class AppRoutingModule {}
```
  </Tab>
  <Tab value="vue">
    Update your Vue router so that all auth related requests load the `AuthView` component
    ```tsx title="/router/index.ts"
// @ts-ignore
// @ts-ignore
// @ts-ignore

const router = createRouter({
  // @ts-ignore
  history: createWebHistory(import.meta.env.BASE_URL),
  routes: [
    {
      path: "/",
      name: "home",
      component: HomeView,
    },
    {
      path: "<WEBSITE_BASE_PATH>/:pathMatch(.*)*",
      name: "auth",
      component: AuthView,
    },
  ],
});

export default router;
```
  </Tab>
</Tabs>

## 4. Handle Session Tokens

This part is handled automatically by the **Frontend SDK**.
You don't need to do anything.
The step serves more as a way for us to tell you how is this handled under the hood.

After you call the `init` function, the **SDK** adds interceptors to both `fetch` and `XHR`, XMLHTTPRequest. The latter is used by the `axios` library.
The interceptors save the session tokens that are generated from the authentication flow.
Those tokens are then added to requests initialized by your frontend app which target the backend API.
By default, the tokens are stored through session cookies but you can also switch to [header based authentication](/docs/post-authentication/session-management/switch-between-cookies-and-header-authentication).

## 5. Secure Application Routes

In order to prevent unauthorized access to certain parts of your frontend application you can use our utilities.
Follow the code samples below to understand how to do this.

<Tabs>
  <Tab value="reactjs">
    You can wrap your components with the `<SessionAuth>` react component. This ensures that your component renders only if the user is logged in. If they are not logged in, the user is redirected to the login page.
    ```tsx
    // highlight-next-line
    // @ts-ignore

    class App extends React.Component {
      render() {
        return (
          <BrowserRouter>
            <Routes>
              <Route
                path="/dashboard"
                element={
                  // highlight-start
                  <SessionAuth>
                    {/*Components that require to be protected by authentication*/}
                    <MyDashboardComponent />
                  </SessionAuth>
                  // highlight-end
                }
              />
            </Routes>
          </BrowserRouter>
        );
      }
    }
    ```
  </Tab>
  <Tab value="angular">
    You can use the `doesSessionExist` function to check if a session exists in all your routes.
      ```tsx

      async function doesSessionExist() {
        if (await Session.doesSessionExist()) {
          // user is logged in
        } else {
          // user has not logged in yet
        }
      }
      ```
  </Tab>
  <Tab value="vue">
    You can use the `doesSessionExist` function to check if a session exists in all your routes.
      ```tsx

      async function doesSessionExist() {
        if (await Session.doesSessionExist()) {
          // user is logged in
        } else {
          // user has not logged in yet
        }
      }
      ```
  </Tab>
</Tabs>

## 6. View the login UI

You can check the login UI by visiting the `<WEBSITE_BASE_PATH>` route, in your frontend application.
To review all the components of our pre-built UI please follow [this link](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/auth-page--playground).

</PrebuiltUIInstructions>

<CustomUIInstructions name="custom-ui">

## 1. Install the SDK

Use the following command to install the required package.

<Tabs>
  <Tab value="web">
    <Tabs>
      <Tab value="npm">
        ```bash
        npm i -s supertokens-web-js
        ```
      </Tab>
      <Tab value="scripts">

          <Tabs.Section>
          You need to add all of the following scripts to your app
          </Tabs.Section>

          ```html
          <script src="^{webJsVersions.website}"></script>
          <script src="^{webJsVersions.supertokens}"></script>
          <script src="^{webJsVersions.session}"></script>
          <script src="^{webJsVersions.emailpassword}"></script>
          ```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="mobile">
    :::info
    If you want to implement a common authentication experience for both web and mobile, please look at our [**Unified Login guide**](/docs/authentication/unified-login/introduction).
    :::
    <Tabs>
      <Tab value="reactnative">
        ```bash
        npm i -s supertokens-react-native
# IMPORTANT: If you already have @react-native-async-storage/async-storage as a dependency, make sure the version is 1.12.1 or higher
        npm i -s @react-native-async-storage/async-storage
        ```
      </Tab>
      <Tab value="android">
        Add to your `settings.gradle`:
        ```bash
        dependencyResolutionManagement {
            ...
            repositories {
                ...
                maven { url 'https://jitpack.io' }
            }
        }
        ```

        Add the following to you app level's `build.gradle`:
        ```bash
        implementation 'com.github.supertokens:supertokens-android:X.Y.Z'
        ```

        You can find the latest version of the SDK [here](https://github.com/supertokens/supertokens-android/releases) (ignore the `v` prefix in the releases).
      </Tab>
      <Tab value="ios">

#### Using Cocoapods

        Add the Cocoapod dependency to your Podfile

        ```bash
        pod 'SuperTokensIOS'
        ```

#### Using Swift Package Manager

        Follow the [official documentation](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app) to learn how to use Swift Package Manager to add dependencies to your project.

        When adding the dependency use the `master` branch after you enter the supertokens-ios repository URL:

        ```bash
        https://github.com/supertokens/supertokens-ios
        ```

</Tab>

<Tab value="flutter">

Add the dependency to your pubspec.yaml

```bash
supertokens_flutter: ^X.Y.Z
```

You can find the latest version of the SDK [here](https://github.com/supertokens/supertokens-flutter/releases) (ignore the `v` prefix in the releases).

</Tab>

</Tabs>

</Tab>

</Tabs>

## 2. Initialise SuperTokens



Call the SDK init function at the start of your application.
The invocation includes the [main configuration details](/docs/references/frontend-sdks/reference#sdk-configuration), as well as the **recipes** that you use in your setup.

<Tabs>
  <Tab value="web">
    <Tabs>
      <Tab value="npm">
        ```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        EmailPassword.init(),
    ],
});
```
      </Tab>
      <Tab value="scripts">
        ```tsx
supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init(),
        supertokensEmailPassword.init(),
    ],
});
```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="mobile">
    <Tabs>
      <Tab value="reactnative">

  ```tsx

  SuperTokens.init({
      apiDomain: "<API_DOMAIN>",
      apiBasePath: "<API_BASE_PATH>",
  });
  ```
      </Tab>
      <Tab value="android">
        Add the `SuperTokens.init` function call at the start of your application.
        ```kotlin
      </Tab>
      <Tab value="ios">
        ```swift
      </Tab>
      <Tab value="flutter">
  ```dart

  void main() {
      SuperTokens.init(
          apiDomain: "<API_DOMAIN>",
          apiBasePath: "<API_BASE_PATH>",
      );
  }
  ```

      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## 3. Add the Login UI

The **Email/Password** flow involves two types of user interfaces. 
One for registering and creating new users, the *Sign Up Form*.
And one for the actual authentication attempt, the *Sign In Form*.
If you are provisioning users from a different method you can skip over adding the sign up form.

### 3.1 Add the Sign Up form

<Tabs>
  <Tab value="web">
    For the **Sign Up** flow you have to first add the UI elements which render your form.
    After that, call the following function when the user submits the form that you have previously created. 
    <Tabs>
      <Tab value="npm">

```tsx

async function signUpClicked(email: string, password: string) {
    try {
        let response = await signUp({
            formFields: [{
                id: "email",
                value: email
            }, {
                id: "password",
                value: password
            }]
        })

        if (response.status === "FIELD_ERROR") {
            // one of the input formFields failed validation
            response.formFields.forEach(formField => {
                if (formField.id === "email") {
                    // Email validation failed (for example incorrect email syntax),
                    // or the email is not unique.
                    window.alert(formField.error)
                } else if (formField.id === "password") {
                    // Password validation failed.
                    // Maybe it didn't match the password strength
                    window.alert(formField.error)
                }
            })
        } else if (response.status === "SIGN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign up was not allowed.
            window.alert(response.reason)
        } else {
            // sign up successful. The session tokens are automatically handled by
            // the frontend SDK.
            window.location.href = "/homepage"
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

      </Tab>
      <Tab value="scripts">

```tsx
async function signUpClicked(email: string, password: string) {
    try {
        let response = await supertokensEmailPassword.signUp({
            formFields: [{
                id: "email",
                value: email
            }, {
                id: "password",
                value: password
            }]
        })

        if (response.status === "FIELD_ERROR") {
            // one of the input formFields failed validation
            response.formFields.forEach(formField => {
                if (formField.id === "email") {
                    // Email validation failed (for example incorrect email syntax),
                    // or the email is not unique.
                    window.alert(formField.error)
                } else if (formField.id === "password") {
                    // Password validation failed.
                    // Maybe it didn't match the password strength
                    window.alert(formField.error)
                }
            })
        } else if (response.status === "SIGN_UP_NOT_ALLOWED") { 
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in was not allowed.
            window.alert(response.reason)
        } else {
            // sign up successful. The session tokens are automatically handled by
            // the frontend SDK.
            window.location.href = "/homepage"
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

      </Tab>
    </Tabs>
  </Tab>
  <Tab value="mobile">
    For the **Sign Up** flow you have to first add the UI elements which render your form.
    After that, call the following API when the user submits the form that you have previously created.

    ```bash
    curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signup' \
    --header 'Content-Type: application/json; charset=utf-8' \
    --data-raw '{
        "formFields": [{
            "id": "email",
            "value": "john@example.com"
        }, {
            "id": "password",
            "value": "somePassword123"
        }]
    }'
    ```

    The response body from the API call has a `status` property in it:
    - `status: "OK"`: User creation was successful. The response also contains more information about the user, for example their user ID.
    - `status: "FIELD_ERROR"`: One of the form field inputs failed validation. The response body contains information about which form field input based on the `id`:
        - The email could fail validation if it's syntactically not an email, of it it's not unique.
        - The password could fail validation if it's not string enough (as defined by the backend password validator).

        Either way, you want to show the user an error next to the input form field.
    - `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should be displayed on the frontend.
    - `status: "SIGN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during MFA. The `reason` prop that's in the response body contains a support code using which you can see why the sign up was not allowed.

  </Tab>
</Tabs>

The `formFields` input is a key-value array. You must provide it an `email` and a `password` value at a minimum. If you want to provide additional items, for example the user's name or age, you can append it to the array like so:

```json
{
    "formFields": [{
        "id": "email",
        "value": "john@example.com"
    }, {
        "id": "password",
        "value": "somePassword123"
    }, {
        "id": "name",
        "value": "John Doe"
    }]
}
```

On the backend, the `formFields` array is available to you for consumption.

On success, the backend sends back session tokens as part of the response headers which are automatically handled by our frontend SDK for you.

#### How to check if an email is unique

As a part of the sign up form, you may want to explicitly check that the entered email is unique.
Whilst this is already done via the sign up API call, it may be a better UX to warn the user about a non unique email right after they finish typing it.

<Tabs>
  <Tab value="web">
    <Tabs>
      <Tab value="npm">
        ```tsx

async function checkEmail(email: string) {
    try {
        let response = await doesEmailExist({
            email
        });

        if (response.doesExist) {
            window.alert("Email already exists. Please sign in instead")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```
      </Tab>
      <Tab value="scripts">
        ```tsx
async function checkEmail(email: string) {
    try {
        let response = await supertokensEmailPassword.doesEmailExist({
            email
        });

        if (response.doesExist) {
            window.alert("Email already exists. Please sign in instead")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="mobile">

```bash
curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/emailpassword/email/exists?email=john@example.com'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: The response also contains a `exists` boolean which is `true` if the input email already belongs to an email password user.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should be displayed on the frontend.

</Tab>
</Tabs>

### 3.2 Add the Sign In Form

<Tabs>
  <Tab value="web">
    For the **Sign In** flow you have to first add the UI elements which render your form.
    After that, call the following function when the user submits the form that you have previously created. 
    <Tabs>
      <Tab value="npm">
        ```tsx

async function signInClicked(email: string, password: string) {
    try {
        let response = await signIn({
            formFields: [{
                id: "email",
                value: email
            }, {
                id: "password",
                value: password
            }]
        })

        if (response.status === "FIELD_ERROR") {
            response.formFields.forEach(formField => {
                if (formField.id === "email") {
                    // Email validation failed (for example incorrect email syntax).
                    window.alert(formField.error)
                }
            })
        } else if (response.status === "WRONG_CREDENTIALS_ERROR") {
            window.alert("Email password combination is incorrect.")
        } else if (response.status === "SIGN_IN_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in was not allowed.
            window.alert(response.reason)
        } else {
            // sign in successful. The session tokens are automatically handled by
            // the frontend SDK.
            window.location.href = "/homepage"
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```
      </Tab>
      <Tab value="scripts">
        ```tsx
async function signInClicked(email: string, password: string) {
    try {
        let response = await supertokensEmailPassword.signIn({
            formFields: [{
                id: "email",
                value: email
            }, {
                id: "password",
                value: password
            }]
        })

        if (response.status === "FIELD_ERROR") {
            // one of the input formFields failed validation
            response.formFields.forEach(formField => {
                if (formField.id === "email") {
                    // Email validation failed (for example incorrect email syntax).
                    window.alert(formField.error)
                }
            })
        } else if (response.status === "WRONG_CREDENTIALS_ERROR") {
            window.alert("Email password combination is incorrect.")
        } else if (response.status === "SIGN_IN_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in was not allowed.
            window.alert(response.reason)
        } else {
            // sign in successful. The session tokens are automatically handled by
            // the frontend SDK.
            window.location.href = "/homepage"
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="mobile">
    For the **Sign In** flow you have to first add the UI elements which render your form.
    After that, call the following API when the user submits the form that you have previously created. 
    ```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signin' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "formFields": [{
        "id": "email",
        "value": "john@example.com"
    }, {
        "id": "password",
        "value": "somePassword123"
    }]
}'
```

    The response body from the API call has a `status` property in it:
    - `status: "OK"`: User sign in was successful. The response also contains more information about the user, for example their user ID.
    - `status: "WRONG_CREDENTIALS_ERROR"`: The input email and password combination is incorrect.
    - `status: "FIELD_ERROR"`: This indicates that the input email did not pass the backend validation - probably because it's syntactically not an email. You want to show the user an error next to the email input form field.
    - `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should be displayed on the frontend.
    - `status: "SIGN_IN_NOT_ALLOWED"`: This can happen during automatic account linking or during MFA. The `reason` prop that's in the response body contains a support code using which you can see why the sign in was not allowed.
  
  </Tab>
</Tabs>

On success, the backend sends back session tokens as part of the response headers which are automatically handled by our frontend SDK for you.

## 4. Handle Session Tokens

You can use sessions with SuperTokens in two modes:
- Using `httpOnly` cookies
- Authorization bearer token.

Our frontend SDK uses `httpOnly` cookie based session for websites by default as it secures against tokens theft via XSS attacks. 
For other platforms, like mobile apps, we use a bearer token in the `Authorization` header by default.

### With the Frontend SDK

<Tabs>
<Tab value="web">

:::success
No action required.
:::

Our frontend SDK handles everything for you. You only need to make sure that you have called `supertokens.init` before making any network requests.

Our SDK adds interceptors to `fetch` and `XHR` (used by `axios`) to save and add session tokens from and to the request.

By default, our web SDKs use cookies to provide credentials.

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">
  <Tabs.Section>
    Our frontend SDK handles everything for you. You only need to make sure that you have added our network interceptors as shown below
  </Tabs.Section>
  <Tabs.Section py="0">

:::note
By default our mobile SDKs use a bearer token in the Authorization header to provide credentials.
:::
  </Tabs.Section>

<Tabs>
  <Tab value="axios">
    <Tabs.Section>                      

<Question
    cardVariant="ghost"
    questionSize="4"
    defaultAnswer="Yes"
    question={() => {
            return (
                <span>Are you using <code>axios.create</code>?</span>
            )
        }}>
<Answer title="Yes">

```tsx
// highlight-next-line

let axiosInstance = axios.create({/*...*/});
// highlight-next-line
SuperTokens.addAxiosInterceptors(axiosInstance);

async function callAPI() {
    // use axios as you normally do
    let response = await axiosInstance.get("https://yourapi.com");
}
```

</Answer>

<Answer title="No">

:::important
You must call `addAxiosInterceptors` on all `axios` imports.
:::

```tsx
// highlight-start
SuperTokens.addAxiosInterceptors(axios);
// highlight-end

async function callAPI() {
    // use axios as you normally do
    let response = await axios.get("https://yourapi.com");
}
```

</Answer>
</Question>

                                    </Tabs.Section>

  </Tab>
  <Tab value="fetch">
                          

:::success
When using `fetch`, network interceptors are added automatically when you call `supertokens.init`. So no action needed here.
:::

  </Tab>
 
</Tabs>

</Tab>

<Tab value="android">

<Question question="Which library are you using for networking?">
<Answer title="HttpURLConnection">

```kotlin

```dart
// Import http from the SuperTokens package

Future<void> makeRequest() async {
    Uri uri = Uri.parse("http://localhost:3001/api");
    var response = await http.get(uri);
    // handle response
}
```

<h4>Using a custom HTTP client</h4>

If you use a custom HTTP client and want to use SuperTokens, you can simply provide the SDK with your client. All requests continue to use your client along with the session logic that SuperTokens provides.

```dart
// Import http from the SuperTokens package

Future<void> makeRequest() async {
    Uri uri = Uri.parse("http://localhost:3001/api");

    // Initialise your custom client
    var customClient = http.Client();
    // provide your custom client to SuperTokens
    var httpClient = http.Client(client: customClient);

    var response = await httpClient.get(uri);
    // handle response
}
```

</Answer>
<Answer title="Dio">

<h4>Add the SuperTokens interceptor</h4>

Use the extension method provided by the SuperTokens SDK to enable interception on your `Dio` client. This allows the SuperTokens SDK to handle session tokens for you.

```dart

void setup() {
  Dio dio = Dio();  // Create a Dio instance.
  dio.addSupertokensInterceptor();
}
```

<h4>Making network requests</h4>

You can make requests as you normally would with `dio`.

```dart

void setup() {
    Dio dio = Dio(
        // Provide your config here
    );
    dio.addSupertokensInterceptor();

    var response = dio.get("http://localhost:3001/api");
    // handle response
}
```

</Answer>
</Question>

:::note
By default our mobile SDKs use a bearer token in the Authorization header to provide credentials.
:::

</Tab>

</Tabs>

</Tab>
</Tabs>

### Without the Frontend SDK

:::caution
We highly recommend using our frontend SDK to handle session token management. It saves you a lot of time.
:::

In this case, you need to manually handle the tokens and session refreshing, and decide if you are going to use header or cookie-based sessions.

For browsers, we recommend cookies, while for mobile apps (or if you don't want to use the built-in cookie manager) you should use header-based sessions.

<Question question="Which request authentication mode are you using?" defaultAnswer="Cookie">
    
<Answer title="Cookie">

#### During the Login Action 

You should attach the `st-auth-mode` header to calls to the login API, but this header is safe to attach to all requests. In this case it should be set to "cookie".

The login API returns the following headers:
- `Set-Cookie`: This contains the `sAccessToken`, `sRefreshToken` cookies which are `httpOnly` and are automatically managed by the browser. For mobile apps, you need to setup cookie handling yourself, use our SDK or use a header based authentication mode.
- `front-token` header: This contains information about the access token:
    - The userID
    - The expiry time of the access token
    - The payload added by you in the access token.
    
    Here is the structure of the token:
    ```tsx
    let frontTokenFromRequestHeader = "...";
    let frontTokenDecoded = JSON.parse(decodeURIComponent(escape(atob(frontTokenFromRequestHeader))));
    console.log(frontTokenDecoded);
    /*
    {
        ate: 1665226412455, // time in milliseconds for when the access token expires, and then a refresh is required
        uid: "....", // user ID
        up: {
            sub: "..",
            iat: ..,
            ... // other access token payload
        }
    }
    
    */
    ```

    This token is mainly used for cookie based auth because you don't have access to the actual access token on the frontend (for security reasons), but may want to read its payload (for example to know the user's role). This token itself is not signed and hence can't be used in place of the access token itself. You may want to save this token in `localstorage` or in frontend cookies (using `document.cookies`).

- `anti-csrf` header (optional): By default it's not required, so it's not sent. But if this is sent, you should save this token as well for use when making requests.

#### When You Make Network Requests to Protected APIs

The `sAccessToken` gets attached to the request automatically by the browser. Other than that, you need to add the following headers to the request:
- `rid: "anti-csrf"` - this prevents against anti-CSRF requests. If your `apiDomain` and `websiteDomain` values are exactly the same, then this is not necessary.
- `anti-csrf` header (optional): If this was provided to you during login, then you need to add that token as the value of this header.
- You need to set the `credentials` header to `true` or `include`. This is achieved different based on the library you are using to make requests.

An API call can potentially update the `sAccessToken` and `front-token` tokens, for example if you call the `mergeIntoAccessTokenPayload` function on the `session` object on the backend. This kind of update is reflected in the response headers for your API calls. The headers contain new values for:
- `sAccessToken`: This is as a new `Set-Cookie` header and is managed by the browser automatically.
- `front-token`: This should be read and saved by you in the same way as it's being done during login.

#### Handling session refreshing

If any of your API calls return with a status code of `401`, it means that the access token has expired. This requires you to refresh the session before retrying the same API call.

You can call the refresh API as follows:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/session/refresh' \
--header 'Cookie: sRefreshToken=...'
```

:::note
- You may also need to add the `anti-csrf` header to the request if that was provided to you during sign in.
- The cURL command above shows the `sRefreshToken` cookie as well, but this is added by the web browser automatically, so you don't need to add it explicitly.
:::

The result of a session refresh is either:
- Status code `200`: This implies a successful refresh. The set of tokens returned here is the same as when the user logs in, so you can handle them in the same way.
- Status code `401`: This means that the refresh token is invalid, or has been revoked. You must ask the user to login again. Remember to clear the `front-token` that you saved on the frontend earlier.

</Answer>

<Answer title="Header (Authorization Bearer)">

##### During the Login Action

You should attach the `st-auth-mode` header to calls to the login API, but this header is safe to attach to all requests. In this case it should be set to "header".

The login API returns the following headers:
- `st-access-token`: This contains the current access token associated with the session. You should save this in your application (e.g., in frontend `localstorage`).
- `st-refresh-token`: This contains the current refresh token associated with the session. You should save this in your application (e.g., in frontend `localstorage`).

#### When You Make Network Requests to Protected APIs

You need to add the following headers to request:
- `authorization: Bearer {access-token}`
- You need to set the `credentials` to `true` or `include`. This is achieved different based on the library you are using to make requests.

An API call can potentially update the `access-token`, for example if you call the `mergeIntoAccessTokenPayload` function on the `session` object on the backend. This kind of update is reflected in the response headers for your API calls. The headers contain new values for `st-access-token`

These should be read and saved by you in the same way as it's being done during login.

#### Handling session refreshing

If any of your API calls return with a status code of `401`, it means that the access token has expired. This requires you to refresh the session before retrying the same API call.

You can call the refresh API as follows:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/session/refresh' \
--header 'authorization: Bearer {refresh-token}'
```

The result of a session refresh is either:
- Status code `200`: This implies a successful refresh. The set of tokens returned here is the same as when the user logs in, so you can handle them in the same way.
- Status code `401`: This means that the refresh token is invalid, or has been revoked. You must ask the user to login again. Remember to clear the `st-refresh-token` and `st-access-token` that you saved on the frontend earlier.

</Answer>

</Question>

## 5. Protect Frontend Routes

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

You can use the `doesSessionExist` function to check if a session exists.

```tsx

async function doesSessionExist() {
    if (await Session.doesSessionExist()) {
        // user is logged in
    } else {
        // user has not logged in yet
    }
}
```

</Tab>

<Tab value="scripts">

You can use the `doesSessionExist` function to check if a session exists.

```tsx
async function doesSessionExist() {
    if (await Session.doesSessionExist()) {
        // user is logged in
    } else {
        // user has not logged in yet
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

You can use the `doesSessionExist` function to check if a session exists.

```tsx

async function doesSessionExist() {
    if (await SuperTokens.doesSessionExist()) {
        // user is logged in
    } else {
        // user has not logged in yet
    }
}
```

</Tab>

<Tab value="android">

You can use the `doesSessionExist` function to check if a session exists.

```kotlin

Future<bool> doesSessionExist() async {
    return await SuperTokens.doesSessionExist();
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

## 6. Add a Sign Out Action

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.

<Tabs>
  <Tab value="web">
    <Tabs>
      <Tab value="npm">
        ```tsx

        async function logout () {
          // highlight-next-line
          await Session.signOut(); 
          window.location.href = "/auth"; // or to wherever your logic page is
        }
        ```
      </Tab>
      <Tab value="scripts">
        ```tsx
        async function logout () {
          // highlight-next-line
          await supertokensSession.signOut(); 
          window.location.href = "/auth"; // or to wherever your logic page is
        }
        ```
      </Tab>
    </Tabs>
  </Tab>
<Tab value="mobile">
  <Tabs>
    <Tab value="reactnative">

```tsx

async function logout () {
  // highlight-next-line
  await SuperTokens.signOut(); 
  // navigate to the login screen..
}
```
    </Tab>
    <Tab value="android">

```kotlin
        // navigate to the login screen..
    }
}
```
    </Tab>
    <Tab value="ios">

```swift

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

- 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 sign out 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 do an automatic session refresh before revoking the session.

</CustomUIInstructions>

:::success 🎉 Congratulations 🎉

Congratulations! You've successfully integrated your frontend app with SuperTokens.

The [next section](./backend-setup) guides you through setting up your backend and then you should be able to complete a login flow.

:::

# Quickstart -  Backend Setup
Source: https://supertokens.com/docs/quickstart/backend-setup

Let's got through the changes required so that your backend can expose the **SuperTokens** authentication features.

## 1. Install the SDK

Run the following command in your terminal to install the package.

<Tabs>

<Tab value="nodejs">

```bash
npm i -s supertokens-node
```

</Tab>

<Tab value="go">

```bash
go get github.com/supertokens/supertokens-golang
```

</Tab>
<Tab value="python">

```bash
pip install supertokens-python
```

</Tab>
</Tabs>

:::info

At the moment we only have SDKs for **Node.js**, **Python** and **Go**. 
If you wish to use **SuperTokens** with other languages you will have to create a separate authentication service.
Please check [our guide](/docs/references/backend-sdks/other-frameworks) that shows you how to resolve this.

:::

## 2. Initialize the SDK



You will have to initialize the **Backend SDK** alongside the code that starts your server.
The init call will include [configuration details](/docs/references/backend-sdks/reference#sdk-configuration) for your app, how the backend will connect to the **SuperTokens Core**, as well as the **Recipes** that will be used in your setup.

<Tabs>
  <Tab value="nodejs">
    <Tabs exclude={["awsLambda", "nextjs", "nestjs"]} showAppTypeSelect>
      <Tab value="express">
        ```tsx 

supertokens.init({
    framework: "express",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        EmailPassword.init(), // initializes signin / sign up features
        Session.init() // initializes session features
    ]
});

```
      </Tab>
      <Tab value="hapi">
        ```tsx

supertokens.init({
    framework: "hapi",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        EmailPassword.init(), // initializes signin / sign up features
        Session.init() // initializes session features
    ]
});
```
      </Tab>
      <Tab value="fastify">
        ```tsx

supertokens.init({
    framework: "fastify",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        EmailPassword.init(), // initializes signin / sign up features
        Session.init() // initializes session features
    ]
});
```
      </Tab>
      <Tab value="koa">
        ```tsx

supertokens.init({
    framework: "koa",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        EmailPassword.init(), // initializes signin / sign up features
        Session.init() // initializes session features
    ]
});
```
      </Tab>
      <Tab value="loopback">
        ```tsx

supertokens.init({
    framework: "loopback",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        EmailPassword.init(), // initializes signin / sign up features
        Session.init() // initializes session features
    ]
});
```
      </Tab>
    </Tabs>
  </Tab>
  <Tab value="go" showAppTypeSelect>
		<Tabs>
      ```go
    </Tabs>
  </Tab>
  <Tab value="python">
    <Tabs showAppTypeSelect>
      <Tab value="fastapi">
        ```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import emailpassword, session

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='fastapi',
    recipe_list=[
	    session.init(), # initializes session features
        emailpassword.init()
    ],
    mode='asgi' # use wsgi if you are running using gunicorn
)
```
      </Tab>
      <Tab value="flask">
        ```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import emailpassword, session

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='flask',
    recipe_list=[
	    session.init(), # initializes session features
        emailpassword.init()
    ]
)
```
      </Tab>
      <Tab value="django">
        ```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import emailpassword, session

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='django',
    recipe_list=[
	    session.init(), # initializes session features
        emailpassword.init()
    ],
    mode='asgi' # use wsgi if you are running django server in sync mode
)
```
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

:::info Multiple frontend domains
To handle clients from different domains with the same SuperTokens instance, use the `origin` property in the `appInfo` object instead of `websiteDomain`.
The property accepts a function that receives the original request as an input and should return a valid domain.
Make sure to whitelist all the domains during CORS configuration.

Keep in mind that with this setup, each frontend application will not share authentication sessions.
Users will have to authenticate separately for each domain.
To configure a shared authentication experiece between multiple services check the [Unified Login](/docs/authentication/unified-login/introduction) documentation.
:::

## 3. Add the SuperTokens APIs and Configure CORS

Now that the SDK is initialized you need to expose the endpoints that will be used by the frontend SDKs.
Besides this, your server's CORS, Cross-Origin Resource Sharing, settings should be updated to allow the use of the authentication headers required by **SuperTokens**.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

<Tabs.Section>

:::important

- Add the `middleware` BEFORE all your routes.
- Add the `cors` middleware BEFORE the SuperTokens middleware as shown below.
:::

</Tabs.Section>

```tsx 

let app = express();

app.use(
	cors({
		// highlight-start
		origin: "<WEBSITE_DOMAIN>",
		allowedHeaders: ["content-type", ...supertokens.getAllCORSHeaders()],
		credentials: true,
		// highlight-end
	}),
);

// IMPORTANT: CORS should be before the below line.
// highlight-next-line
app.use(middleware());

// ...your API routes
```

</Tab>
<Tab value="hapi">

<Tabs.Section>

Register the `plugin`.

</Tabs.Section>

```tsx

let server = Hapi.server({
	port: 8000,
	routes: {
		// highlight-start
		cors: {
			origin: ["<WEBSITE_DOMAIN>"],
			additionalHeaders: [...supertokens.getAllCORSHeaders()],
			credentials: true,
		},
		// highlight-end
	},
});

(async () => {
	// highlight-next-line
	await server.register(plugin);

	await server.start();
})();

// ...your API routes
```

</Tab>
<Tab value="fastify">

<Tabs.Section>

Register the `plugin`. Also register [`@fastify/formbody`](https://github.com/fastify/fastify-formbody) plugin.

</Tabs.Section>

```tsx

let fastify = fastifyImport();

// ...other middlewares
// highlight-start
fastify.register(cors, {
	origin: "<WEBSITE_DOMAIN>",
	allowedHeaders: ["Content-Type", ...supertokens.getAllCORSHeaders()],
	credentials: true,
});
// highlight-end

(async () => {
	// highlight-next-line
	await fastify.register(formDataPlugin);
	// highlight-next-line
	await fastify.register(plugin);

	await fastify.listen({ port: 8000 });
})();

// ...your API routes
```

</Tab>
<Tab value="koa">

<Tabs.Section>

:::important
Add the `middleware` BEFORE all your routes.
:::

</Tabs.Section>

```tsx

let app = new Koa();

app.use(
	cors({
		// highlight-start
		origin: "<WEBSITE_DOMAIN>",
		allowHeaders: ["content-type", ...supertokens.getAllCORSHeaders()],
		credentials: true,
		// highlight-end
	}),
);

// highlight-next-line
app.use(middleware());

// ...your API routes
```

</Tab>
<Tab value="loopback">

<Tabs.Section>

:::important
Add the `middleware` BEFORE all your routes.
:::

</Tabs.Section>

```tsx

let app = new RestApplication({
	rest: {
		cors: {
			// highlight-start
			origin: "<WEBSITE_DOMAIN>",
			allowedHeaders: ["content-type", ...supertokens.getAllCORSHeaders()],
			credentials: true,
			// highlight-end
		},
	},
});

// highlight-next-line
app.middleware(middleware);

// ...your API routes
```

</Tab>

</Tabs>
</Tab>

<Tab value="go">

<Tabs>

<Tab value="http">

<Tabs.Section>

Use the `supertokens.Middleware` and the `supertokens.GetAllCORSHeaders()` functions as shown below.

</Tabs.Section>

```go

let app = express();

// ...your API routes

// highlight-start
// Add this AFTER all your routes
app.use(errorHandler());
// highlight-end

// your own error handler
app.use((err: unknown, req: Request, res: Response, next: NextFunction) => {
	/* ... */
});
```

</Tab>
<Tab value="hapi">

<Tabs.Section>

No additional `errorHandler` is required.

</Tabs.Section>

</Tab>

<Tab value="fastify">

<Tabs.Section>

Add the `errorHandler` **Before all your routes and plugin registration**

</Tabs.Section>

```tsx

let fastify = Fastify();

// highlight-next-line
fastify.setErrorHandler(errorHandler());

// ...your API routes
```

</Tab>

<Tab value="koa">

<Tabs.Section>

No additional `errorHandler` is required.

</Tabs.Section>

</Tab>

<Tab value="loopback">

<Tabs.Section>

No additional `errorHandler` is required.

</Tabs.Section>

</Tab>

</Tabs>

</Tab>

<Tab value="go">

:::info
You can skip this step
:::

</Tab>
<Tab value="python">

:::info
You can skip this step
:::

</Tab>
</Tabs>

## 5. Secure Application Routes

Now that your server can authenticate users, the final step that you need to take care of is to prevent unauthorized access to certain parts of the application.

<Tabs>

<Tab value="nodejs">

For your APIs that require a user to be logged in, use the `verifySession` middleware.

<Tabs>

<Tab value="express">

```tsx

let app = express();

// highlight-start
app.post("/like-comment", verifySession(), (req: SessionRequest, res) => {
	let userId = req.session!.getUserId();
	// highlight-end
	//....
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
	path: "/like-comment",
	method: "post",
	//highlight-start
	options: {
		pre: [
			{
				method: verifySession(),
			},
		],
	},
	handler: async (req: SessionRequest, res) => {
		let userId = req.session!.getUserId();
		//highlight-end
		//...
	},
});
```

</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post(
	"/like-comment",
	{
		preHandler: verifySession(),
	},
	(req: SessionRequest, res) => {
		let userId = req.session!.getUserId();
		//highlight-end
		//....
	},
);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/like-comment", verifySession(), (ctx: SessionContext, next) => {
	let userId = ctx.session!.getUserId();
	//highlight-end
	//....
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
	//highlight-start
	constructor(
		@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext,
	) {}
	@post("/like-comment")
	@intercept(verifySession())
	@response(200)
	handler() {
		let userId = (this.ctx as SessionContext).session!.getUserId();
		//highlight-end
		//....
	}
}
```

</Tab>
</Tabs>

</Tab>
<Tab value="go">

For your APIs that require a user to be logged in, use the `VerifySession` middleware.

<Tabs>
<Tab value="http">

```go

# Quickstart -  Next Steps
Source: https://supertokens.com/docs/quickstart/next-steps

## Overview

Now that you have completed the quickstart guide there are a few more things that you need to take care of on the road towards a production ready authentication experience.

## Configure the Core Service

If you have signed up and deployed a SuperTokens environment already, you can skip this step.
Otherwise, please follow these instructions to use the correct **SuperTokens Core** instance in your application.

The steps show you how to connect to a **SuperTokens Managed Service Environment**.
If you want to self host the core instance please check the [following guide](/docs/deployment/self-host-supertokens).

### 1. Sign up for a SuperTokens account

Open this [page](https://supertokens.com/auth) in order to access the account creation page.
Select the account that you want to use and wait for the action to complete.

### 2. Create a deployment

<img
	alt="Integration with SuperTokens SDKs"
	width="700px"
	src="/img/quickstart-next-steps-0.png"
/>

After you have signed up, you can skip over the initial wizard that generates an example application.
You already have created one by going though the quickstart guide.
Once you are on the main dashboard page, select a region that is closest to where your services are hosted.
Click **Deploy** and wait for the action to complete.

Our internal service will deploy a separate environment based on your selection.
After this process is complete, the UI will render the new list of deployments.

:::info

The initial setup flow only configures a development environment.
In order to use SuperTokens in production, you will have to create a separate deployment.

:::

### 3. Connect the Backend SDK with SuperTokens 🔌

<img
	alt="SuperTokens managed service dashboard connectionURI and API key"
	width="700px"
	src="/img/quickstart-next-steps-1.png"
/>

Select the newly created deployment in order to access its details.
Copy the `Connection URI` and `API Key` values from this page and paste them in your backend code.

<Tabs>

<Tab value="nodejs">

```tsx

supertokens.init({
	// highlight-start
	supertokens: {
		connectionURI: "<CONNECTION_URI>",
		apiKey: "<API_KEY>",
	},
	// highlight-end
	appInfo: {
		apiDomain: "...",
		appName: "...",
		websiteDomain: "...",
	},
	recipeList: [],
});
```

</Tab>
<Tab value="go">

```go
  </ReferenceCard>
	<ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides">
  <ReferenceCard.Title>Post Sign In Actions</ReferenceCard.Title>
  <ReferenceCard.Description>Add custom logic in the authentication flow.</ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

## Explore Additional Features

You can also review the additional features that **SuperTokens** exposes.
Those can help you extend the authentication implementation on different levels.

<ReferenceCard.Grid>
    <ReferenceCard href="/docs/deployment/self-host-supertokens">
      <ReferenceCard.Title>Self Host SuperTokens Core</ReferenceCard.Title>
      <ReferenceCard.Description>Run the SuperTokens in your own infrastructure.</ReferenceCard.Description>
      </ReferenceCard>
	<ReferenceCard href="/docs/migration/overview">
      <ReferenceCard.Title>Migration Guide</ReferenceCard.Title>
      <ReferenceCard.Description>Migrate your data from other authentication providers.</ReferenceCard.Description>
      </ReferenceCard>
	<ReferenceCard href="/docs/additional-verification/mfa/introduction">
      <ReferenceCard.Title>Multi Factor Authentication</ReferenceCard.Title>
      <ReferenceCard.Description>Set up additional authentication layers in you sign in process.</ReferenceCard.Description>
      </ReferenceCard>
	<ReferenceCard href="/docs/post-authentication/dashboard/introduction">
      <ReferenceCard.Title>User Management Dashboard</ReferenceCard.Title>
      <ReferenceCard.Description>Administrate your users from the SuperTokens Dashboard.</ReferenceCard.Description>
      </ReferenceCard>
	<ReferenceCard href="/docs/additional-verification/user-roles/introduction">
  <ReferenceCard.Title>User Roles and Permissions</ReferenceCard.Title>
  <ReferenceCard.Description>Adjust the authorization settings in your application.</ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Quickstart -  Example App
Source: https://supertokens.com/docs/quickstart/example-applications

## Overview

The fastest way to run a quick demo of **SuperTokens** is to use our cli to generate an example application.
You will get a quick understanding of how the authentication experience works and the overall setup of a project.



## Project Structure

The command will create a new folder based on the application name that you have specified.
Inside it you will find a project configured to support an authentication flow based on the recipe that you have chosen.

## Next Steps

If you want more explanations on how to integrate **SuperTokens** with your application, please check our [**Quickstart Guide**](/docs/quickstart/introduction).

Otherwise, you can explore the other sections of the documentation that expand on the features of **SuperTokens** and 
offer you in-depth instructions on how to use them.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/deployment/self-host-supertokens">
    <ReferenceCard.Title>
      Self Host SuperTokens Core
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Run the SuperTokens in your own infrastructure.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/migration/overview">
    <ReferenceCard.Title>Migration Guide</ReferenceCard.Title>
    <ReferenceCard.Description>Migrate your data from other authentication providers.</ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/additional-verification/mfa/introduction">
    <ReferenceCard.Title>Multi Factor Authentication</ReferenceCard.Title>
    <ReferenceCard.Description>Set up additional authentication layers in you sign in process.</ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/post-authentication/dashboard/introduction">
    <ReferenceCard.Title>User Management Dashboard</ReferenceCard.Title>
    <ReferenceCard.Description>Administrate your users from the SuperTokens Dashboard.</ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/additional-verification/user-roles/introduction">
    <ReferenceCard.Title>User Roles and Permissions</ReferenceCard.Title>
    <ReferenceCard.Description>Adjust the authorization settings in your application.</ReferenceCard.Description>
  </ReferenceCard>

</ReferenceCard.Grid>

# Quickstart -  Build with AI Tools
Source: https://supertokens.com/docs/quickstart/build-with-ai-tools

## Overview

If you plan on using large language models (LLMs) to assist in the process of integrating SuperTokens, the documentation exposes a set of helpers that can aid you.

## Text documentation

You can access all the documentation as plain text markdown files by appending `.md` to the end of any URL or by using the `Copy Markdown` button, from the top right part of each page.
For example, you can find the plain text version of this page at [https://supertokens.com/docs/quickstart/build-with-ai-tools.md](https://supertokens.com/docs/quickstart/build-with-ai-tools.md).

This plain text format is ideal for AI tools and agents as it:
-  Contains fewer formatting tokens.
-  Displays content that might otherwise be hidden in the HTML or JavaScript-rendered version (such as content in tabs).
-  Maintains a clear markdown hierarchy that LLMs can easily parse and understand.
-  Can be read in a paginated format using the `offset` and `length` query parameters.

### `/llms.txt`

The documentation website hosts an [/llms.txt file](https://supertokens.com/docs/llms.txt) which instructs AI tools and agents on how to retrieve the plain text versions of our pages.
The file follows an [emerging standard](https://llmstxt.org/) for enhancing content accessibility to LLMs.

Additionally, to access the entire documentation content in a single page you can use the [/llms-full.txt file](https://supertokens.com/docs/llms-full.txt).
Keep in mind that this file is really large and might get ignored by LLMs.
You can use the `offset` and `length` query parameters to paginate the content.

## Model Context Protocol (MCP) Server

If you want to leverage the agentic capabilities of an LLM tool you can use the **SuperTokens Model Context Protocol** (MCP) server.
The server exposes a set of tools which instruct the LLM on how to access and read the documentation as well as how to administer your authentication integration.

### Installation

You can use the MCP server in two ways:
- over HTTP, as an endpoint exposed by your current server
- as a CLI script, over STDIO

#### Using HTTP

<Steps>

### Install the plugin

<Tabs>
  <Tab value="npm" label="npm">
    ```bash 
    npm i -s supertokens-mcp-plugin
    ```
  </Tab>
  <Tab value="yarn" label="yarn">
    ```bash 
    yarn add supertokens-mcp-plugin
    ```
  </Tab>
  <Tab value="pnpm" label="pnpm">
    ```bash
    pnpm add supertokens-auth-react supertokens-web-js
    ```
  </Tab>
</Tabs>

### Update the SDK initialization code

Initialize and include the `SuperTokensAdminMcpServer` in your SDK configuration.
You have to specify how the client will be authorized through either [claim validators](/docs/additional-verification/session-verification/claim-validation) or through custom logic defined in the `validateTokenPayload` function.

```ts

const adminMcpServer = new SuperTokensAdminMcpServer({
  path: "/mcp/admin",
  validateTokenPayload: async (accessTokenPayload) => {
    // Use custom logic to authenticate who can access the admin MCP server
    return { status: "OK" };
  },
  claimValidators: [UserRoleClaim.validators.includes("admin")],
});

export const SuperTokensConfig = {
  supertokens: {
    connectionURI: "<SUPERTOKENS_CONNECTION_URI>",
    apiKey: "<SUPERTOKENS_API_KEY>",
  },
  appInfo: {
    appName: "<APP_NAME>",
    apiDomain: "<API_DOMAIN>",
    websiteDomain: "<WEBSITE_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
    websiteBasePath: "<WEBSITE_BASE_PATH>",
  },
  recipeList: [
    // Include your existing recipes here
    // The OAuth2Provider recipe is required for the MCP authorization process
    OAuth2Provider.init(),
  ],
  // Pass the MCP server through the plguin configuration section
  experimental: {
    plugins: [
      SuperTokensMcpPlugin.init({
        mcpServers: [adminMcpServer],
      }),
    ],
  },
};
```

### Add the MCP server in a client configuration

<Tabs>
  <Tab value="cursor" label="Cursor">
Add the following to your `~/.cursor/mcp.json` file.
To learn more, see the [Cursor documentation](https://docs.cursor.com/context/model-context-protocol).

```json
{
  "mcpServers": {
    "server-with-authentication": {
      "command": "npx",
      "args": ["mcp-remote", "<API_DOMAIN>/mcp"]
    }
  }
}
```
  </Tab>
  <Tab value="vscode" label="VS Code">

Add the following to your `.vscode/mcp.json` file.
To learn more, see the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).

```json
{
  "servers": {
    "server-with-authentication": {
      "command": "npx",
      "args": ["mcp-remote", "<API_DOMAIN>/mcp"]
    }
  }
}
```
  </Tab>
  <Tab value="windsurf" label="Windsurf">
Add the following to your `~/.codeium/windsurf/mcp_config.json` file.
To learn more, see the [Windsurf documentation](https://docs.windsurf.com/windsurf/cascade/mcp).

```json
{
  "mcpServers": {
    "server-with-authentication": {
      "command": "npx",
      "args": ["mcp-remote", "<API_DOMAIN>/mcp"]
    }
  }
}
```
  </Tab>
  <Tab value="claude" label="Claude">
Add the following to your `claude_desktop_config.json` file.
To learn more, see the [Claude Desktop documentation](https://modelcontextprotocol.io/quickstart/user).

  ```json
{
  "mcpServers": {
    "server-with-authentication": {
      "command": "npx",
      "args": ["mcp-remote", "<API_DOMAIN>/mcp"]
    }
  }
}
  ```
  </Tab>
</Tabs>

</Steps>

#### Using STDIO

If you plan on using the server locally you can run it directly through `npx`.
You have to provide a set of environment variables that match the SDK configuration values.

<Tabs>
  <Tab value="cursor" label="Cursor">
Add the following to your `~/.cursor/mcp.json` file.
To learn more, see the [Cursor documentation](https://docs.cursor.com/context/model-context-protocol).

```json
{
  "mcpServers": {
    "supertokens": {
      "command": "npx",
      "args": ["-y", "supertokens-mcp-plugin"],
      "env": {
	"APP_NAME":"<APP_NAME>",
	"API_DOMAIN":"<API_DOMAIN>",
	"WEBSITE_DOMAIN":"<WEBSITE_DOMAIN>",
	"API_BASE_PATH":"<API_BASE_PATH>",
	"WEBSITE_BASE_PATH":"<WEBSITE_BASE_PATH>",
	"CONNECTION_URI":"<CONNECTION_URI>",
	"API_KEY":"API_KEY"
      }
    }
  }
}
```
  </Tab>
  <Tab value="vscode" label="VS Code">

Add the following to your `.vscode/mcp.json` file.
To learn more, see the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).

```json
{
  "servers": {
    "supertokens": {
      "command": "npx",
      "args": ["-y", "supertokens-mcp-plugin"],
      "env": {
	"APP_NAME":"<APP_NAME>",
	"API_DOMAIN":"<API_DOMAIN>",
	"WEBSITE_DOMAIN":"<WEBSITE_DOMAIN>",
	"API_BASE_PATH":"<API_BASE_PATH>",
	"WEBSITE_BASE_PATH":"<WEBSITE_BASE_PATH>",
	"CONNECTION_URI":"<CONNECTION_URI>",
	"API_KEY":"API_KEY"
      }
    }
  }
}
```
  </Tab>
  <Tab value="windsurf" label="Windsurf">

Add the following to your `~/.codeium/windsurf/mcp_config.json` file.
To learn more, see the [Windsurf documentation](https://docs.windsurf.com/windsurf/cascade/mcp).

```json
{
  "mcpServers": {
    "supertokens": {
      "command": "npx",
      "args": ["-y", "supertokens-mcp-plugin"],
      "env": {
	"APP_NAME":"<APP_NAME>",
	"API_DOMAIN":"<API_DOMAIN>",
	"WEBSITE_DOMAIN":"<WEBSITE_DOMAIN>",
	"API_BASE_PATH":"<API_BASE_PATH>",
	"WEBSITE_BASE_PATH":"<WEBSITE_BASE_PATH>",
	"CONNECTION_URI":"<CONNECTION_URI>",
	"API_KEY":"API_KEY"
      }
    }
  }
}
```
  </Tab>
  <Tab value="claude" label="Claude">

Add the following to your `claude_desktop_config.json` file.
To learn more, see the [Claude Desktop documentation](https://modelcontextprotocol.io/quickstart/user).

```json
{
  "mcpServers": {
    "supertokens": {
      "command": "npx",
      "args": ["-y", "supertokens-mcp-plugin"],
      "env": {
	"APP_NAME":"<APP_NAME>",
	"API_DOMAIN":"<API_DOMAIN>",
	"WEBSITE_DOMAIN":"<WEBSITE_DOMAIN>",
	"API_BASE_PATH":"<API_BASE_PATH>",
	"WEBSITE_BASE_PATH":"<WEBSITE_BASE_PATH>",
	"CONNECTION_URI":"<CONNECTION_URI>",
	"API_KEY":"API_KEY"
      }
    }
  }
}
```
  </Tab>
</Tabs>

# Quickstart - Integrations -  Vercel Guide
Source: https://supertokens.com/docs/quickstart/integrations/vercel

This page only talks about what environment variables to use when you are deploying an application on Vercel.
For a full set of instructions on how to integrate **SuperTokens** in a **Next.js** project, please see either our [app router](/docs/quickstart/integrations/nextjs/app-directory/about) or [pages router](/docs/quickstart/integrations/nextjs/app-directory/about) guides.

## Working with Vercel's inspect and production URL

Vercel provides one production URL per app and one unique inspect URL per deployment.
To get SuperTokens to work with dynamic URLs, you need to make the following changes to the [`appInfo` object](/docs/references/frontend-sdks/reference#sdk-configuration):

### On the frontend



<PrebuiltUIInstructions>

```text
appInfo = {
    apiDomain: window.location.origin,
    websiteDomain: window.location.origin,
    ...
}
```

</PrebuiltUIInstructions>

<CustomUIInstructions>

```text appInfo = {
    apiDomain: window.location.origin
    ...
}
```
</CustomUIInstructions>

### On the backend

```text
appInfo = {
    apiDomain: process.env.VERCEL_URL,
    websiteDomain: process.env.VERCEL_URL,
    ...
},
```

Vercel adds an environment variable to the backend - `VERCEL_URL`, which points to the current URL that the app is deployed on. This allows SuperTokens to work on all inspect URLs generated by Vercel without you having to keep changing your code.

:::note
The above setting works only if your backend and frontend are deployed on the same URL. If you are using a different backend and using Vercel only for your frontend, then:
- Set the `apiDomain` on the frontend and backend to point to your backend.
- The `websiteDomain` on the frontend should be `window.location.origin`, but on the backend, it should be equal to your production deployment URL. This will break certain features of the app for inspect URL deployments, but it will work as expected for production deployments.
:::

# Quickstart - Integrations - AWS Lambda -  Quickstart Guide
Source: https://supertokens.com/docs/quickstart/integrations/aws-lambda/quickstart-guide

The following guide shows you how to use **SuperTokens** in an AWS Lambda environment.
You can also check out the [example repository](https://github.com/supertokens/supertokens-node/tree/master/examples/aws/with-emailpassword) for a full implementation.

## Before you start

These instructions assume that you have completed the [quickstart guide](/docs/quickstart/frontend-setup).
If not, please go through it and create the example application before you start this tutorial.

## Steps

:::caution
Follow the [quickstart guide](/docs/quickstart/frontend-setup) first to learn how to set up the frontend.
:::

### 1. Set up API Gateway

#### 1.1 Create a REST API Gateway

We will be using AWS API Gateway to create a REST API that will be used to communicate with our Lambda functions. 

<img src="/img/integration-lambda/create-api-gateway.png" alt="Create API gateway step UI"/>

#### 1.2 Set up authentication routes

Create a `/auth` resource and then `/auth/{proxy+}` resources.
This will act as a catch-all for all SuperTokens auth routes.
**Enable CORS** while creating the proxy resource. 

<img src="/img/integration-lambda/create-proxy-route.png" alt="Create proxy route step UI"/>

<img src="/img/integration-lambda/route-creation-complete.png" alt="Route creation complete step UI"/>

#### 1.3 Attach lambda to the `ANY` method of the proxy resource

Click on the "ANY" method and then "Integration" to configure the lambda function.
Check **Lambda proxy integration** and then select your lambda function.

<img src="/img/integration-lambda/configure-lambda-integration.png" alt="Configure lambda integration UI"/>

:::important

Ensure that the **Lambda proxy integration** toggle is turned on.

:::

#### 1.4 Enable CORS for the proxy path

Click on the `{proxy+}` resource and then "Enable CORS" button to open the CORS configuration page. 

<img src="/img/integration-lambda/click-enable-cors.png" alt="Enable CORS for the proxy path UI" />

In the CORS configuration page do the following:
    - Select the 'Default 4XX' and 'Default 5XX' checkboxes under Gateway responses
    - Select the 'OPTIONS' checkbox under Methods
    - Add `rid,fdi-version,anti-csrf,st-auth-mode` to the existing `Access-Control-Allow-Headers`
    - Set `Access-Control-Allow-Origin` to `'<WEBSITE_DOMAIN>'`
    - Select `Access-Control-Allow-Credentials` checkbox

<img src="/img/integration-lambda/configure-cors.png" alt="CORS configuration page"/>

#### 1.5 Deploy the API Gateway

Click the **Deploy API** button in the top right corner to deploy the API. During deployment, you'll be prompted to create a stage; for this tutorial, name the stage `dev`. After deployment, you will receive your `Invoke URL`.

:::important
Update `apiDomain`, `apiBasePath`, and `apiGatewayPath` in both Lambda configuration and your frontend config if they have changed post API Gateway configuration.
:::

### 2. Set up Lambda layer

#### 2.1 Create Lambda layer with required libraries

<Tabs exclude={["go", "otherFrameworks"]}>

<Tab value="nodejs">

```bash
mkdir lambda && cd lambda

npm i -s supertokens-node @middy/core @middy/http-cors
mkdir nodejs && cp -r node_modules nodejs
zip -r supertokens-node.zip nodejs/
```

</Tab>
<Tab value="python">

```bash
mkdir lambda && cd lambda

pip install --target ./python fastapi uvicorn mangum nest_asyncio supertokens-python
cd python && rm -r *dist-info **/__pycache__ && cd ..
zip -r supertokens-python.zip python/
```

</Tab>
</Tabs>

#### 2.2 Upload SuperTokens lambda layer

Open AWS Lambda dashboard and click on layers:
<img src="/img/integration-lambda/sidebar.png" alt="AWS Lambda sidebar UI" height="300" />

Click "Create Layer" button:
<img src="/img/integration-lambda/create-layer.png" alt="Create layer button UI" width="600" />

Give a name for your layer, upload the zip and select the runtime

<Tabs exclude={["go", "otherFrameworks"]}>
  <Tab value="nodejs">
    <img src="/img/integration-lambda/node-lambda-layer.png" alt="Lambda layer node configuration UI"/>
  </Tab>
  <Tab value="python">
    <img src="/img/integration-lambda/python-lambda-layer.png" alt="Lambda layer python configuration UI"/>
  </Tab>
</Tabs>

### 3. Set up Lambda

#### 3.1 Create a new lambda

 Click "Create Function" in the AWS Lambda dashboard, enter the function name and runtime, and create your Lambda function.
<Tabs exclude={["go" ]}>
  <Tab value="nodejs">
    <img src="/img/integration-lambda/create-function-node.png" alt="Create new Lambda configurations UI Node"/>
  </Tab>
  <Tab value="python">
    <img src="/img/integration-lambda/create-function-python.png" alt="Create new Lambda configurations UI Python"/>
  </Tab>
</Tabs>

#### 3.2 Link lambda layer with the lambda function

Scroll to the bottom and look for the `Layers` tab. Click on `Add a layer`
<img src="/img/integration-lambda/add-a-layer.png" alt="Link Lambda function with the Lambda layer" width="700"/>

Select `Custom Layer` and then select the layer we created in the first step:

<Tabs exclude={["go" ]}>
  <Tab value="nodejs">
    <img src="/img/integration-lambda/add-layer-detail-node.png" alt="Link custom layer with Lambda function Node"/>
  </Tab>
  <Tab value="python">
    <img src="/img/integration-lambda/link-python-layer.png" alt="Link custom layer with Lambda function Python"/>
  </Tab>
</Tabs>

#### 3.3 Create a backend config file

Using the editor provided by AWS, create a new config file and write the following code:



<Tabs exclude={["go"]}>
<Tab value="nodejs">

```tsx title="config.mjs" showAppTypeSelect

export function getBackendConfig() {
  return {
    framework: "awsLambda",
    supertokens: {
      connectionURI: "<CORE_URI>",
      // apiKey: "^{coreInfo.key}",
    },
    appInfo: {
      // learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration 
      appName: "<APP_NAME>",
      apiDomain: "<API_DOMAIN>",
      websiteDomain: "<WEBSITE_DOMAIN>",
      apiBasePath: "<API_BASE_PATH>",
      websiteBasePath: "<WEBSITE_BASE_PATH>",
      apiGatewayPath: "/dev"
    },
    recipeList: [
      EmailPassword.init(),
      Session.init(),
    ],
    isInServerlessEnv: true,
  }
}
```

</Tab>

<Tab value="python">

```python title="config.py" showAppTypeSelect
from supertokens_python.recipe import emailpassword, session
from supertokens_python import SupertokensConfig, InputAppInfo

supertokens_config = SupertokensConfig(
    connection_uri="<CORE_URI>",
    # api_key="^{coreInfo.key}"
)

app_info = InputAppInfo(
    # learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration
    app_name="<APP_NAME>",
    api_domain="<API_DOMAIN>",
    website_domain="<WEBSITE_DOMAIN>",
    api_base_path="<API_BASE_PATH>",
    website_base_path="<WEBSITE_BASE_PATH>",
    api_gateway_path="/dev",
)

framework = "fastapi"

recipe_list = [
    session.init(),
    emailpassword.init(),
]
```

</Tab>

</Tabs>

:::important
In the above code, notice the extra config of `apiGatewayPath` that was added to the `appInfo` object.
The value of this should be whatever you have set as the value of your [AWS stage](https://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html) which scopes your API endpoints.
For example, you may have a stage name per development environment:
- One for development (`/dev`).
- One for testing (`/test`).
- One for prod (`/prod`).

So the value of `apiGatewayPath` should be set according to the above based on the environment it's running under.

You also need to change the `apiBasePath` on the frontend config to append the stage to the path. For example, if the frontend is query the development stage and the value of `apiBasePath` is `/auth`, you should change it to `/dev/auth`.
:::

:::note
You may edit the `apiBasePath` and `apiGatewayPath` value later if you haven't setup the API Gateway yet. 
:::

#### 3.4 Add the SuperTokens auth middleware

Using the editor provided by AWS, create/replace the handler file contents with the following code:

<Tabs exclude={["go", "otherFrameworks"]}>
<Tab value="nodejs">

```tsx title="index.mjs"
// @ts-ignore

supertokens.init(getBackendConfig());

export const handler = middy(
    // @ts-ignore
    middleware((event) => {
      // SuperTokens middleware didn't handle the route, return your custom response
      return {
        body: JSON.stringify({
            msg: "Hello!",
        }),
        statusCode: 200,
      };
    })
)
    .use(
        cors({
            origin: getBackendConfig().appInfo.websiteDomain,
            credentials: true,
            headers: ["Content-Type", ...supertokens.getAllCORSHeaders()].join(", "),
            methods: "OPTIONS,POST,GET,PUT,DELETE",
        })
    )
    .onError((request) => {
        throw request.error;
    });
```

<img src="/img/integration-lambda/add-auth-middleware-node.png" alt="Add SuperTokens auth middleware UI"/>
<br/>
:::important
Since, we are using `esm` imports, we will need to set `NODE_OPTIONS="--experimental-specifier-resolution=node"` flag in the lambda environment variables. See the [Node.js](https://nodejs.org/docs/latest-v16.x/api/esm.html#customizing-esm-specifier-resolution-algorithm) documentation for more information.

<img src="/img/integration-lambda/add-env-var-node.png" alt="Configuring environment variables UI"/>
:::

</Tab>

<Tab value="python">

```python title="handler.py"
// @ts-ignore

supertokens.init(getBackendConfig());

const httpHandler = middy(
    // @ts-ignore
    middleware((event) => {
      // SuperTokens middleware didn't handle the route, return your custom response
      return {
        body: JSON.stringify({
            msg: "Hello!",
        }),
        statusCode: 200,
      };
    })
)
    .use(
        cors({
            origin: getBackendConfig().appInfo.websiteDomain,
            credentials: true,
            headers: ["Content-Type", ...supertokens.getAllCORSHeaders()].join(", "),
            methods: "OPTIONS,POST,GET,PUT,DELETE",
        })
    )
    .onError((request) => {
        throw request.error;
    });

// @ts-expect-error
const postAuth = async (event, context) => {
  // Plugins generally inject a `source` property in the event object.
  if (event.source === 'serverless-plugin-warmup') {
    console.info('postAuth 010: warming up lambda. Bypassing authMiddleware.');
    return {
      statusCode: 200,
      body: JSON.stringify({ message: 'Warm-up successful' }),
    };
  }

  return httpHandler(event, context);
};

export const handler = postAuth;
```

# Quickstart - Integrations - AWS Lambda -  Session verification
Source: https://supertokens.com/docs/quickstart/integrations/aws-lambda/session-verification

The following page shows you three different ways to verify sessions in a lambda integration.
Choose the one that works best based on the particularities of your use case.

:::caution
This guide only applies to scenarios which involve **SuperTokens Session Access Tokens**.

If you are implementing either, [**Unified Login**](/docs/authentication/unified-login/introduction) or [**Microservice Authentication**](/docs/authentication/m2m/introduction), features that make use of **OAuth2 Access Tokens**, please check the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to verify those types of tokens.
:::

## Using Session Verification 

When building your own APIs, you may need to verify the session of the user before proceeding further.
SuperTokens SDK exposes a `verifySession` function that can be utilized for this.
In this guide, we will be creating a `/user` `GET` route that will return the current session information.

### 1. Add `/user` `GET` route in your API Gateway

Create a `/user` resource and then `GET` method in your API Gateway. Configure the lambda integration and CORS just like we did [for the auth routes](/docs/quickstart/integrations/aws-lambda/quickstart-guide#13-attach-lambda-to-the-any-method-of-the-proxy-resource).

### 2. Create a file in your lambda to handle the `/user` route.

<Tabs exclude={["go", "otherFrameworks"]}>
<Tab value="nodejs">

An example of this is [here](https://github.com/supertokens/supertokens-node/blob/master/examples/aws/with-emailpassword/backend/user.mjs).

```tsx title="user.mjs"
// @ts-ignore

supertokens.init(getBackendConfig());

type AuthorizerEvent = SessionEvent & APIGatewayAuthorizerEvent; 

const lambdaHandler = async (event: AuthorizerEvent) => {
    return {
        body: JSON.stringify({
            sessionHandle: event.session?.getHandle(),
            userId: event.session?.getUserId(),
            accessTokenPayload: event.session?.getAccessTokenPayload(),
        }),
        statusCode: 200,
    };
};

export const handler = middy(verifySession(lambdaHandler))
    .use(
        cors({
            origin: getBackendConfig().appInfo.websiteDomain,
            credentials: true,
            headers: ["Content-Type", ...supertokens.getAllCORSHeaders()].join(", "),
            methods: "OPTIONS,POST,GET,PUT,DELETE",
        })
    )
    .onError((request) => {
        throw request.error;
    });
```

Now, import this function in your `index.mjs` handler file as shown below:

```tsx title="index.mjs"
// @ts-ignore
// highlight-start
// @ts-ignore
// highlight-end

supertokens.init(getBackendConfig());

export const handler = middy(
    middleware((event) => {

        // highlight-start
        if (event.path === "/user") {
            return userHandler(event);
        // highlight-end
        }
      
        return {
            body: JSON.stringify({
                msg: "Hello!",
            }),
            statusCode: 200,
        };
    })
)
    .use(
        cors({
            origin: getBackendConfig().appInfo.websiteDomain,
            credentials: true,
            headers: ["Content-Type", ...supertokens.getAllCORSHeaders()].join(", "),
            methods: "OPTIONS,POST,GET,PUT,DELETE",
        })
    )
    .onError((request) => {
        throw request.error;
    });
```

:::note
The `verifySession` middleware automatically returns a 401 Unauthorised error if the session is not valid. You can alter the default behaviour by passing `{ sessionRequired: false }` as the second argument to the `verifySession` middleware.

If each API route has its own lambda function, you can skip using the SuperTokens auth middleware. Instead, ensure to call `supertokens.init` and include the `Session` recipe in the `recipeList` for each respective lambda function.
:::

</Tab>
<Tab value="python">

```python title="handler.py"

```python title="auth.py"
We can then use `getSession()` to get the session.

```tsx title="index.mjs"

// @ts-expect-error

supertokens.init(getBackendConfig());

type AuthorizerEvent = SessionEvent & APIGatewayAuthorizerEvent; 

export const handler = async function (event: AuthorizerEvent) {
    try {
        const session = await Session.getSession(event, event, { sessionRequired: false });
        if (session) {
            return generateAllow(session.getUserId(), event.methodArn, {
                setCookie: event.supertokens.response.cookies.join(', '),
            });
        } else {
            return generateAllow("", event.methodArn, {
                setCookie: event.supertokens.response.cookies.join(', '),
            });
        }
    } catch (ex: any) {
        if (ex.type === "TRY_REFRESH_TOKEN" || ex.type === "UNAUTHORISED") {
            throw new Error("Unauthorized");
        }
        if (ex.type === "INVALID_CLAIMS") {
            return generateDeny("", event.methodArn, {
                body: JSON.stringify({
                    message: "invalid claim",
                    claimValidationErrors: ex.payload,
                }),
                setCookie: event.supertokens.response.cookies.join(", "),
            });
        }
        throw ex;
    }
}

const generatePolicy = function (principalId: string, effect: StatementEffect, resource: string, context?: any) {
    const policyDocument: PolicyDocument = {
        Version: '2012-10-17',
        Statement: [],
    };

    const statementOne: Statement = {
        Action: 'execute-api:Invoke',
        Effect: effect,
        Resource: resource,
    };

    policyDocument.Statement[0] = statementOne;

    const authResponse: AuthResponse = {
        principalId: principalId,
        policyDocument: policyDocument,
        context,
    };

    return authResponse;
}

const generateAllow = function (principalId: string, resource: string, context?: any) {
    return generatePolicy(principalId, 'Allow', resource, context);
};

const generateDeny = function (principalId: string, resource: string, context?: any) {
    return generatePolicy(principalId, 'Deny', resource, context);
};
```

</Tab>
</Tabs>

### 3. Configure the Authorizer

- Go to the `Authorizers` tab in the API Gateway configuration
- Click **Create new Authorizer** and add it
    - Fill the name field
    - Set "Lambda function" to the one created above
    - Set "Lambda Event Payload" to Request
    - Delete the empty "Identity Source"
    - Click "Create"

### 4. Configure API Gateway

- In your API Gateway, create the resources and methods you require, enabling CORS if necessary (see [setup API gateway](/docs/quickstart/integrations/aws-lambda/quickstart-guide#1-set-up-api-gateway) for details)
- Select each method you want to enable the Authorizer and configure it to use the new `Authorizer`
    - Click on "Method Request"
    - Edit the "Authorization" field in Settings and set it to the one we just created.
    - Go back to the method configuration and click on "Integration Request"
        - Set up the integration you require (see [AppSync](/docs/quickstart/integrations/aws-lambda/appsync-integration) for an example)
        - Add a header mapping to make use of the context set in the lambda.
            - Open "HTTP Headers"
            - Add all headers required (e.g., "x-user-id" mapped to "context.authorizer.principalId")
            - Repeat for any values from the context you want to add as a Header

    - Go back to the method configuration and click on "Method Response"
        - Open the dropdown next to the 200 status code
        - Add the "Set-Cookie" header
        - Add any other headers that should be present on the response.

    - Go back to the method configuration and click on "Integration Response"
        - Open the dropdown
        - Open "Header Mappings"
        - Add "Set-Cookie" mapped to "context.authorizer.setCookie"
- In the API Gateway left menu, select "Gateway Responses"
    - Select "Access Denied"
        - Click "Edit"
        - Add response headers:
            - Add `Access-Control-Allow-Origin` with value `'<WEBSITE_DOMAIN>'`
            - Add `Access-Control-Allow-Credentials` with value `'true'`. **Don't miss out on those quotes else it won't get configured correctly.**
            - Add "Set-Cookie" with value `context.authorizer.setCookie` **no quotes**
        - Under response templates:
            - Select `application/json`:
            - Set "Response template body" to `$context.authorizer.body`
        - Click "Save"
    - Select "Unauthorized"
        - Add response headers:
            - Add `Access-Control-Allow-Origin` with value `'<WEBSITE_DOMAIN>'`
            - Add `Access-Control-Allow-Credentials` with value `'true'`. **Don't miss out on those quotes else it won't get configured correctly.**
        - Click "Save"
- Deploy your API and test it

---

## Using JWT Authorizers

:::caution

AWS supports JWT authorizers for HTTP APIs and not REST APIs on the API Gateway service. For REST APIs follow the [Lambda authorizer](/docs/quickstart/integrations/aws-lambda/session-verification#using-lambda-authorizers) guide

This guide will work if you are using **SuperTokens Session Tokens**.

If you implementing an **OAuth2** setup, through the [**Unified Login**](/docs/authentication/unified-login/introduction) or the [**Microservice Authentication**](/docs/authentication/m2m/client-credentials) features, you will have to manually set the token audience property. 
Please check the referenced pages for more information.

:::

### 1. Add the `aud` claim in the JWT based on the authorizer configuration



<Tabs exclude={["go"]}>

<Tab value="nodejs">

```tsx title="config.mjs" showAppTypeSelect

export function getBackendConfig() {
  return {
    framework: "awsLambda",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        // highlight-start
      Session.init({
          exposeAccessTokenToFrontendInCookieBasedAuth: true,
          override: {
            functions: function (originalImplementation) {
                return {
                    ...originalImplementation,
                    createNewSession: async function (input) {
                        input.accessTokenPayload = {
                            ...input.accessTokenPayload,
                            /*
                            * AWS requires JWTs to contain an audience (aud) claim
                            * The value for this claim should be the same
                            * as the value you set when creating the
                            * authorizer
                            */
                            aud: "jwtAuthorizers",
                        };

                        return originalImplementation.createNewSession(input);
                    },
                };
            }
        },
      }),
    ],
    // highlight-end
    isInServerlessEnv: true,
  }
}
```
</Tab>

<Tab value="python">

```python title="config.py" showAppTypeSelect
from supertokens_python.recipe import session
from supertokens_python import (
    InputAppInfo,
    SupertokensConfig,
)
from supertokens_python.recipe.session.interfaces import RecipeInterface as SessionRecipeInterface

from typing import Any, Dict, Optional
from supertokens_python.types import RecipeUserId

supertokens_config = SupertokensConfig(
    connection_uri="<CORE_URI>",
    api_key="^{coreInfo.key}"
)

app_info = InputAppInfo(
    # learn more about this on https://supertokens.com/docs/session/appinfo
    app_name="<APP_NAME>",
    api_domain="<API_DOMAIN>",
    website_domain="<WEBSITE_DOMAIN>",
    api_base_path="<API_BASE_PATH>",
    website_base_path="<WEBSITE_BASE_PATH>",
    api_gateway_path="/dev",
)

framework = "fastapi"

# highlight-start
def override_session_functions(oi: SessionRecipeInterface) -> SessionRecipeInterface:
    oi_create_new_session = oi.create_new_session

    async def create_new_session(
        user_id: str,
        recipe_user_id: RecipeUserId,
        access_token_payload: Optional[Dict[str, Any]],
        session_data_in_database: Optional[Dict[str, Any]],
        disable_anti_csrf: Optional[bool],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):
        # AWS requires JWTs to contain an audience (aud) claim
        # The value for this claim should be the same as the
        # value you set when creating the authorizer

        # highlight-next-line
        if access_token_payload is None:
            access_token_payload = {}

        access_token_payload["aud"] = "jwtAuthorizers"
        return await oi_create_new_session(user_id, recipe_user_id, access_token_payload, session_data_in_database, disable_anti_csrf, tenant_id, user_context)

    oi.create_new_session = create_new_session
    return oi
# highlight-end

recipe_list = [
    # highlight-start
    session.init(
        override=session.InputOverrideConfig(
            functions=override_session_functions,
        ),
        expose_access_token_to_frontend_in_cookie_based_auth=True,
    ),
    # highlight-end
]
```

</Tab>

</Tabs>

### 2. Configure your authorizer

- Go to the "Authorizers" tab in the API Gateway configuration and select the "Manage authorizers" tab
- Click "Create", in the creation screen select "JWT" as the "Authorizer type"
- Enter a name for your authorizer (You can enter any name for this field)
- Use `$request.header.Authorization` for the "Identity source". This means that API requests will contain the JWT as a Bearer token under the request header "Authorization".
- Use `<API_DOMAIN>/<apiGatewayPath>/<API_BASE_PATH>` for the "Issuer URL".
- Set a value for the "Audience" field, this will be the value you expect the JWT to have under the `aud` claim. In the backend config above the value is set to `"jwtAuthorizers"`

### 3. Add the authorizer to your API
- In the "Authorization" section select the "Attach authorizers to routes" tab
- Click on the route you want to add the authorizer to and select the authorizer you created from the dropdown
- Click "Attach authorizer"
- Deploy your changes and test your API

### 4. Check for auth claims of the JWT

Once the JWT authorizer successfully validates the JWT, the claims of the JWT will be available to your lambda functions via `$event.requestContext.authorizer.jwt.claims`. You should check for the right authorization access here. 
For example, if one of your lambda functions requires that the user's email is verified, then it should check for the `jwt` payload's `st-ev` claim value to be `{v: true, t:...}`, else it should reject the request. Similar checks need to be done to enforce the right user role or if 2FA is completed or not.
This is required because SuperTokens issues JWTs immediately after the user signs up / logs in, regardless of if all the authorisation checks pass or not. Functions exposed by our SDK like `verifySession` or `getSession` do these authorisation checks on their own, but since these functions are not used in the this flow, you will have to check them on your own.

# Quickstart - Integrations - AWS Lambda -  AppSync integration
Source: https://supertokens.com/docs/quickstart/integrations/aws-lambda/appsync-integration

## Overview

A Lambda Authorizer configured like in the [Authorizer guide](/docs/quickstart/integrations/aws-lambda/session-verification#using-lambda-authorizers) can help integrate SuperTokens with an AppSync service.  

## Before you start

The following steps assume that you already have configured **SuperTokens** in AWS Lambda.
If not, please refer to the [AWS Lambda integration guide](/docs/quickstart/integrations/aws-lambda/quickstart-guide).

## Steps

### 1. Set up the AppSync service

Set up the AppSync service with an API key authorization. For more details, please see the [AWS documentation](https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html).

### 2. Configure the API Gateway with the authorizer

Follow the [Authorizer guide](/docs/quickstart/integrations/aws-lambda/session-verification#using-lambda-authorizers) to set up the API Gateway with the `/auth`, and `/graphql` resources set up. `/auth` should be pointed to a lambda that handles the auth APIs.

When setting up the POST method on `/graphql`, you should use the following settings:
- Integration type: AWS service
- AWS Region: the region of the AppSync service
- AWS Service: AppSync Data Plane
- AWS Subdomain: the part of the domain of the GraphQL service before `.appsync-api.`
- HTTP method: POST
- Action type: Use path override
- Path override: `/graphql`
- Execution role: the ARN of an execution role that is authorized to call the AppSync service (e.g.: `AWSAppSyncInvokeFullAccess`)

### 3. Set up the integration headers

Configure the "Integration Request" of the `/graphql` POST method.

- Add `HTTP Header` mappings:
    - "x-api-key": The API key of the App Sync service, wrapped in single quotes.
    - "x-user-id": `context.authorizer.principalId`, without quotes.

### 4. Consume the context in resolvers

You can access the headers you mapped above in resolvers through the context. (e.g., $context.request.headers.custom) For more information, please see the [resolver context](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference.html) docs.

# Quickstart - Integrations -  GraphQL Session Verification
Source: https://supertokens.com/docs/quickstart/integrations/graphql

## Before you start 

These instructions only show you how to perform **session verification** in a GraphQL context.
You will first have to go through the [quickstart guide](/docs/quickstart/frontend-setup) to configure **SuperTokens** and then return to this page.

:::caution
This guide only applies to scenarios which involve **SuperTokens Session Access Tokens**.

If you are implementing either, [**Unified Login**](/docs/authentication/unified-login/introduction) or [**Microservice Authentication**](/docs/authentication/m2m/introduction), features that make use of **OAuth2 Access Tokens**, please check the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to verify those types of tokens.
:::

## Using the GraphQL context 

We want to use the `Session.getSession` function in the `context` function to verify the session, and add the `userId` into our context so that our resolvers can read it.
If the user id not logged in, we will set the `userId` to `undefined` in the context

```tsx

let app = express();

const typeDefs = '...'
const resolvers = {/* ... */ }

const server = new ApolloServer({
    typeDefs,
    resolvers,
})

server.start().then(() => {
    app.use(express.json(), expressMiddleware(server, {

        // Note: This example uses the `req` and `res` argument to access headers,
        // but the arguments received by `context` vary by integration.
        // This means they vary for Express, Fastify, Lambda, etc.
        context: async ({ req, res }) => {
            // highlight-start
            try {
                let session = await Session.getSession(req, res, {
                    sessionRequired: false
                })
                return {
                    userId: session !== undefined ? session.getUserId() : undefined
                };
            } catch (err) {
                if (Session.Error.isErrorFromSuperTokens(err)) {
                    throw new GraphQLError('Session related error', {
                        extensions: {
                            code: 'UNAUTHENTICATED',
                            http: { status: err.type === Session.Error.INVALID_CLAIMS ? 403 : 401 },
                        },
                    });
                }
                throw err;
            }
            // highlight-end
        },
    }))

    app.listen(3001, () => {
        console.log("Server started");
    })
})
```

In the above code snippet, we first attempt to verify the session using the `Session.getSession` function.
If the session is valid, we will add the `userId` to the context.
If the access token has expired, we will throw an error with a status code of `401`.
If a session claim has failed (for example if the user's email is not verified) we will return a status code of `403`.

The `401` status code will cause the session refresh flow to start, which will give a new access token to the user, or else if the session was revoked, the user will be logged out.

In case the user is not logged in, the `Session.getSession` function will throw return `undefined`, in which case, your resolvers will not have a `userId` in the context.

The downside of this method is that if you want to mutate the session's access token payload in one of your resolvers, then you don't have access to the `session` object in there. This is where the method below comes into the picture:

## Using the GraphQL resolver 

Unlike the method above, we will be doing session verification on a per resolver basis here.
This means that you will have access to the `session` object in your resolver using which you can update the information in the session (like its access token payload).

We start by creating a helper function (a sort of middleware for your resolver) which you will have to call in all of your resolvers that require a session:

```tsx

async function withSession<T>(contextValue: any, resolver: (session: SessionContainer) => Promise<T>) {
    try {
        let session = await Session.getSession(contextValue.req, contextValue.res);
        return await resolver(session);
    } catch (err) {
        if (Session.Error.isErrorFromSuperTokens(err)) {
            throw new GraphQLError('Session related error', {
                extensions: {
                    code: 'UNAUTHENTICATED',
                    http: { status: err.type === Session.Error.INVALID_CLAIMS ? 403 : 401 },
                },
            });
        }
    }
}
```

In the above function, we attempt to verify the session using `Session.getSession`. If the session is valid, we will call the `resolver` function with the `session` object. If the access token has expired, or if the session does not exist, we will throw an error with a status code of `401`. If a session claim has failed (for example if the user's email is not verified) we will return a status code of `403`.

For this resolver to work, we will have to add the `req` and `res` object into the GraphQL context. This can be done as follows:

```tsx

let app = express();

const typeDefs = '...'
const resolvers = {/* ... */}

const server = new ApolloServer({
    typeDefs,
    resolvers,
})

server.start().then(() => {
    app.use(express.json(), expressMiddleware(server, {
        // Note: This example uses the `req` and `res` argument to access headers,
        // but the arguments received by `context` vary by integration.
        // This means they vary for Express, Fastify, Lambda, etc.
        context: async ({req, res}) => {
            // highlight-start
            return {
                req, res
            };
            // highlight-end
        },
    }))

    app.listen(3001, () => {
        console.log("Server started");
    })
})
```

Finally, we can use our `withSession` in our resolvers as shown below:

```tsx
declare let getUserName: any; // REMOVE_FROM_OUTPUT
declare let withSession: (contextValue: any, func: (sessoin: any) => Promise<any>) => Promise<any>; // REMOVE_FROM_OUTPUT
declare let typeDefs: any; // REMOVE_FROM_OUTPUT

const server = new ApolloServer({
    typeDefs,
    resolvers: {
        Query: {
            userProfile: async (_: any, __: any, contextValue) => {
                // highlight-start
                // starts of your resolver code..
                return await withSession(contextValue, async (session) => {
                    // getUserName is a custom application function...
                    let name = await getUserName(session.getUserId())

                    return {
                        userId: session.getUserId(), 
                        sessionHandle: session.getHandle(),
                        name
                    };
                });
                // highlight-end
            }
        },
    },
})
```

# Quickstart - Integrations -  Hasura Guide
Source: https://supertokens.com/docs/quickstart/integrations/hasura

## Before you start 

The tutorial assumes that you already have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

Using SuperTokens with Hasura requires you to host your own API layer that uses our Backend SDK.
If you do not want to host your own server you can use a serverless environment to achieve this.

:::caution
This guide only applies to scenarios which involve **SuperTokens Session Access Tokens**.

If you are implementing either, [**Unified Login**](/docs/authentication/unified-login/introduction) or [**Microservice Authentication**](/docs/authentication/m2m/introduction), features that make use of **OAuth2 Access Tokens**, please check the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to verify those types of tokens.
:::

## Steps

### 1. Expose the access token to the frontend

For cookie based auth, the access token is not available on the frontend by default.
In order to expose it, you need to set the `exposeAccessTokenToFrontendInCookieBasedAuth` config to `true`.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            exposeAccessTokenToFrontendInCookieBasedAuth: true
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            exposeAccessTokenToFrontendInCookieBasedAuth: true,
            override: {
                functions: function (originalImplementation) {
                    return {
                        ...originalImplementation,
                        createNewSession: async function (input) {
                            //highlight-start
                            input.accessTokenPayload = {
                                ...input.accessTokenPayload,
                                "https://hasura.io/jwt/claims": {
                                    "x-hasura-user-id": input.userId,
                                    "x-hasura-default-role": "user",
                                    "x-hasura-allowed-roles": ["user"],
                                }
                            };
                            //highlight-end

                            return originalImplementation.createNewSession(input);
                        },
                    };
                }
            },
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

async function getToken(): Promise<void> {
    // highlight-next-line
    const accessToken = await Session.getAccessToken();
    console.log(accessToken);
}
```

</Tab>
<Tab value="scripts">

```tsx
async function getToken(): Promise<void> {
    // highlight-next-line
    const accessToken = await supertokensSession.getAccessToken();
    console.log(accessToken);
}
```

</Tab>
</Tabs>
</TabItem>

<TabItem value="mobile">

<Tabs>
<Tab value="reactnative">

```tsx

async function getToken(): Promise<void> {
    // highlight-next-line
    const accessToken = await SuperTokens.getAccessToken();
    console.log(accessToken);
}
```

</Tab>

<Tab value="android">

```kotlin

Future<String?> getToken() async {
    return await SuperTokens.getAccessToken();
}
```

</Tab>
</Tabs>

</TabItem>
</Tabs>

#### 5.2 Make an HTTP requests

```tsx

async function makeRequest() {
  let url = "...";
  let jwt = "..."; // Refer to step 5.a
  let response = await axios.get(url, {
    // highlight-start
    headers: {
      "Authorization": `Bearer ${jwt}`,
    },
    // highlight-end
  });
}
```

## Local development

If you are using Hasura cloud and testing your backend APIs in your local environment, JWT verification will fail because Hasura will not be able to query the JWKS endpoint (because the cloud can not query your local environment i.e localhost, 127.0.0.1). 

To solve this problem you will need to expose your locally hosted backend APIs to the internet. For example you can use [ngrok](https://ngrok.com/).
After that, you need to configure Hasura to use the `<ngrokURL>/<API_BASE_PATH>/jwt/jwks.json` as the JWKS endpoint (explained in [step 4](#4-configure-hasura-environment-variables))

# Quickstart - Integrations -  NestJS guide
Source: https://supertokens.com/docs/quickstart/integrations/nestjs

## Overview

Integrating SuperTokens into a NestJS backend differs in some aspects from the main quickstart guide.
That's because of the additional framework specific entities that are involved.
To aid the process you can use the `supertokens-nestjs` package which exposes abstractions that speed up the setup.

## Before you start

This guide assumes that you have already completed the [main quickstart guide](/docs/quickstart/introduction).
If not, please go through it before continuing with this page.
You need to first understand how to configure the required recipes and run a sample project.

You can also explore the [example projects](https://github.com/supertokens/supertokens-nestjs/tree/main/examples) for complete code references on how to use the libraries.

## Steps

### 1. Install the required packages 

```bash
npm i -s supertokens-node supertokens-nestjs
```

### 2. Initialize the `SuperTokensModule` 

Inside your main application module, initialize the **SuperTokensModule** with your required configuration.

```tsx

@Module({
  imports: [
    SuperTokensModule.forRoot({
      // Choose between 'express' and 'fastify'
      // If you are using fastify make sure to also set the fastifyAdapter property
      framework: 'express',
      supertokens: {
        connectionURI: '...',
      },
      appInfo: {
        appName: '...',
        apiDomain: '...',
        websiteDomain: '...',
      },
      recipeList: [
        /* ... */
      ],
    }),
  ],
  controllers: [
    /* ... */
  ],
  providers: [
    /* ... */
  ],
})
export class AppModule {}
```

:::info Tip
You can use the `SuperTokensModule.forRootAsync` if you want to load the configuration asynchronously.
:::

### 3. Update the `bootstrap` function

Inside your `bootstrap` function, you have to update the CORS configuration and set the exception filter.
**SuperTokens** generates a set of CORS headers that the authentication flow requires.
And, the global filter ensures that all authentication related errors get handled by the SDK.

```tsx
// @ts-expect-error
// @ts-expect-error

async function bootstrap() {
  const app = await NestFactory.create(AppModule)
  app.enableCors({
    origin: [appInfo.websiteDomain],
    allowedHeaders: ['content-type', ...supertokens.getAllCORSHeaders()],
    credentials: true,
  })
  app.useGlobalFilters(new SuperTokensExceptionFilter())

  await app.listen(3001)
}
```
### 4. Add the `SuperTokensAuthGuard`

The `SuperTokensAuthGuard` automatically marks the routes that it targets as protected.
By default session validation gets performed based on the default configuration provided in the `Session.init` call.
You can customize the validation logic with decorators. 
More on that in the next step.

#### As a global guard

This applies the `SuperTokensAuthGuard` to all routes in exposed by controllers registered in that module.

```tsx

@Module({
  imports: [
    /* ... */
  ],
  controllers: [
    /* ... */
  ],
  providers: [
    {
      provide: APP_GUARD,
      useClass: SuperTokensAuthGuard,
    },
  ],
})
export class AppModule {}
```

#### As a controller guard

This applies the `SuperTokensAuthGuard` only to the routes defined in the controller.

```tsx

@Controller()
@UseGuards(SuperTokensAuthGuard)
export class AppController {}
```

### 5. Manage authentication with decorators

The `supertokens-nestjs` package exposes two sets of decorators:
- Function decorators like `VerifySession` and `PublicAccess` that you can use on controller methods to customize the session validation logic.
- Parameter decorators like `Session` that you can use to access the session data in your controller methods.

```tsx

@Controller()
class AppController {
  @Get('/user')
  @VerifySession()
  async getUserInfo(@Session('userId') userId: string) {}

  @Get('/user/:userId')
  @VerifySession({
    roles: ['admin'],
  })
  async deleteUser(@Session() session: SessionContainer) {}

  @Get('/user/profile')
  @PublicAccess()
  async getUserProfile() {}
}
```

:::info tip
With the `VerifySession` decorator, you can specify the following options:
| Option | Type | Description |
|--------|------|-------------|
| `roles` | `string[]` | Roles that the user must have to access the route |
| `permissions` | `string[]` | Permissions that the user must have to access the route |
| `requiresMfa` | `boolean` | Indicates whether the user must have MFA enabled to access the route |
| `requireEmailVerification` | `boolean` | Indicates whether the user must have their email verified to access the route |
| `options` | `VerifySessionOptions` | The value that normally passed to the `getSession` or `verifySession` functions. Use it if you want additional levels of customization. |

:::

### 6. Configure SuperTokens core

<Question
    question={() => {
        return (
            <span>Are you using <code>https://try.supertokens.com</code> as the connection URI in the init function?</span>
        )
    }} defaultAnswer="Yes">
<Answer title="Yes">

You need to setup an instance of the SuperTokens core for your app (that your backend should connect to). You have two options:
- [Managed service](/docs/quickstart/next-steps#configure-the-core-service)
- [Self hosted](/docs/deployment/self-host-supertokens) 

</Answer>
<Answer title="No">

:::success
You have successfully completed the quick setup! Head over to the "Post login operations" or "Common customizations" section.
:::

</Answer>
</Question>

# Quickstart - Integrations -  Netlify Guide
Source: https://supertokens.com/docs/quickstart/integrations/netlify

## Overview 

The following guide gets you though how to add SuperTokens to a Netlify serverless API.
You can also check out the [example repository](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-netlify) for a full working example.

## Before you start

This guide assumes that you are using Netlify for hosting your serverless API functions.
If this is not the case, and you are only hosting your frontend using Netlify, please follow the [Quick setup guide](/docs/quickstart/frontend-setup) instead.

## Steps

### 1. Setup the frontend

Follow the [initial quickstart guide](/docs/quickstart/frontend-setup) to configure the frontend.

### 2. Setup the backend

#### 2.1 Install the SuperTokens node package

```bash
npm i supertokens-node
```

#### 2.2 Create a configuration file 

Create a `config` folder in the root directory of your project.
Create a `supertokensConfig.js` inside the `config` folder.
An example of this file can be found [here](https://github.com/supertokens/supertokens-auth-react/blob/master/examples/with-netlify/config/supertokensConfig.js).

#### 2.3 Create a backend configuration function



```tsx title="/config/supertokensConfig.ts" showAppTypeSelect

function getBackendConfig() {
  return {
    framework: "awsLambda",
    supertokens: {
      connectionURI: "<CORE_URI>",
      apiKey: "^{coreInfo.key}",
    },
    appInfo: {
      // learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration
      appName: "<APP_NAME>",
      apiDomain: "<API_DOMAIN>",
      websiteDomain: "<WEBSITE_DOMAIN>",
      apiBasePath: "<API_BASE_PATH>",
      websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
      EmailPassword.init(),
      Session.init(),
    ],
    isInServerlessEnv: true,
  }
}

module.exports.getBackendConfig = getBackendConfig;

```

### 3. Expose the authentication APIs

We will add all the backend APIs for auth on `/.netlify/functions/auth/*`.
This can be changed by setting the `apiBasePath` property in the `appInfo` object on the backend and frontend.
For the rest of this page, we will assume you are using `/.netlify/functions/auth/*`.

#### 3.1 Create the `netlify/functions/auth.js` page

Be sure to create the `netlify/functions/` folder.
An example of this can be found [here](https://github.com/supertokens/supertokens-auth-react/blob/master/examples/with-netlify/netlify/functions/auth.js).

```tsx title="netlify/functions/auth.ts"
// @ts-ignore

supertokens.init(getBackendConfig());

module.exports.handler = middy(middleware(async (event, context) => {
    if (event.httpMethod === "OPTIONS") {
        return {
            statusCode: 200,
            body: ""
        }
    }
    
    return {
        statusCode: 404,
        body: "Not Found",
    }
})).use(
    cors({
        origin: getBackendConfig().appInfo.websiteDomain,
        credentials: true,
        headers: ["Content-Type", ...supertokens.getAllCORSHeaders()].join(", "),
        methods: "OPTIONS,POST,GET,PUT,DELETE",
    })
).onError(request => {
    throw request.error;
});
```

:::important
- Notice that we called `supertokens.init` above. We will need to call this in all API endpoints that use any functions related to SuperTokens.
- `CORS` is only needed if you are hosting your frontend using a separate domain (if your website domain is different that your API's domain).
:::

#### 3.2 Use the login widget
If you are now able to sign in or sign up, this means the backend setup is done correctly! If not, please feel free to ask questions on [Discord](https://supertokens.com/discord)

### 4. Add session verification 

:::caution
This guide only applies to scenarios which involve **SuperTokens Session Access Tokens**.

If you are implementing either, [**Unified Login**](/docs/authentication/unified-login/introduction) or [**Microservice Authentication**](/docs/authentication/m2m/introduction), features that make use of **OAuth2 Access Tokens**, please check the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to verify those types of tokens.
:::

For this guide, we will assume that we want an API `/.netlify/functions/user GET` which returns the current session information.

#### 4.1 Create a new file `netlify/functions/user.js`

An example of this is [here](https://github.com/supertokens/supertokens-auth-react/blob/master/examples/with-netlify/netlify/functions/user.js).

#### 4.2 Call the `supertokens.init` function

Remember that whenever we want to use any functions from the `supertokens-node` lib, we have to call the `supertokens.init` function at the top of that serverless function file.

```tsx title="netlify/functions/user.ts"
// @ts-ignore

supertokens.init(getBackendConfig())
```

#### 4.3 Use session verification with your API handler

We use the `verifySession()` middleware to verify a session.

```tsx title="netlify/functions/user.ts"
// @ts-ignore

supertokens.init(getBackendConfig());

const handler = async (event: SessionEvent) => {
    return {
        body: JSON.stringify({
            sessionHandle: event.session!.getHandle(),
            userId: event.session!.getUserId(),
            accessTokenPayload: event.session!.getAccessTokenPayload(),
        }),
    };
};

module.exports.handler = middy(verifySession(handler)).use(
    cors({
        origin: getBackendConfig().appInfo.websiteDomain,
        credentials: true,
        headers: ["Content-Type", ...supertokens.getAllCORSHeaders()].join(", "),
        methods: "OPTIONS,POST,GET,PUT,DELETE",
    })
).onError(request => {
    throw request.error;
});
```

# Quickstart - Integrations -  Supabase Guide
Source: https://supertokens.com/docs/quickstart/integrations/supabase

## Overview

The following guide shows you how to integrate a Next.js app with SuperTokens and Supabase.
It includes instructions on how to:
- Create a Supabase project with a table to store your user data
- Create a Supabase JWT and store the user's session
- Enable row level security policies in your Supabase table to ensure only authorized users can access their data

In this example, the user's email is stored mapped to their SuperTokens userId in Supabase.

You can also check an [example repository](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-supabase) for specific references.

## Before you start 

The guide does not include instructions on how to setup a Next.js app with SuperTokens.
To do this you can follow the [app router](/docs/quickstart/integrations/nextjs/app-directory/about) or [pages router](/docs/quickstart/integrations/nextjs/app-directory/about) instructions.

## Steps

### 1. Configure Supabase

Supabase provides a database with authentication and authorization features. This guide uses Supabase to store the user's info mapped to their SuperTokens `userId`.

#### 1.1 Create a new Supabase project

1. From your [Supabase dashboard](https://app.supabase.com/), click New project.
2. Enter a Name for your Supabase project.
3. Enter a secure Database Password.
4. Select the same Region you host your app's backend in.
5. Click Create new project.

![Supabase dashboard](/img/thirdpartyemailpassword/supabase/supabase_dashboard_create.png)

#### 1.2 Create the user table in Supabase

1. From the sidebar menu in the [Supabase dashboard](https://app.supabase.com/), click Table editor, then New table.
2. Enter `users` as the `Name` field.
3. Select `Enable Row Level Security (RLS).`
4. Remove the default columns
5. Create two new columns:
  - `user_id` as `varchar` as primary key
  - email as `varchar`
6. Click `Save` to create the new table.

![Supabase table create](/img/thirdpartyemailpassword/supabase/supabase_table_create.png)

### 2. Setup JWT creation

In this section, the SuperTokens backend is overridden to create a JWT signed with Supabase's secret which contains the user's `userId`.
This token is used on the frontend and backend to read and write to Supabase's database.

#### 2.1 Integrate your Next.js app with SuperTokens

Follow either the [app router](/docs/quickstart/integrations/nextjs/app-directory/about) or [pages router](/docs/quickstart/integrations/nextjs/app-directory/about) guides for instructions on how to configure your application.

#### 2.2 Save the Supabase configuration values

Retrieve the Supabase configuration values from the dashboard and add them to your `.env` file:

```bash
// retrieve the following from your supabase dashboard

NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_KEY=
SUPABASE_SIGNING_SECRET=
```

#### 2.3 Create the Supabase JWT 

In the Next.js app when a user signs up, you'll want to store the user's email in Supabase.
The email can then be retrieved from Supabase and displayed on the frontend.
To use the Supabase client to query the database, you need to create a JWT signed with your Supabase app's signing secret.
This JWT also needs to contain the user's `userId` so Supabase knows an authorized user is making the request.
To create this flow, SuperTokens needs to be modified so that, when a user signs up or signs in, a JWT signed with Supabase's signing secret is created and attached to the user's session.
Attaching the JWT to the user's session allows the Supabase JWT to be retrieved on the frontend and backend (post session verification), which can then be used to query Supabase.

To create the JWT signed with Supabase's signing secret, the `jsonwebtoken` library is used.

```bash
npm install jsonwebtoken
```

The JWT can be added to the user's session by overriding the `createNewSession` function and adding it to the `accessTokenPayload`

```ts
// config/backendConfig.ts

let appInfo: AppInfo = {
    appName: "TODO: add your app name",
    apiDomain: "TODO: add your website domain",
    websiteDomain: "TODO: add your website domain"
}

let supabase_signing_secret = process.env.SUPABASE_SIGNING_SECRET || "TODO: Your Supabase Signing Secret";

let backendConfig = (): TypeInput => {
    return {
        framework: "express",
        supertokens: {
            connectionURI: "https://try.supertokens.com",
        },
        appInfo,
        recipeList: [
            // @ts-ignore
            EmailPassword.init({/*...*/}),
            SessionNode.init({
                override: {
                    functions: (originalImplementation) => {
                        return {
                            ...originalImplementation,
                            createNewSession: async function (input) {
                                const payload = {
                                    userId: input.userId,
                                    exp: Math.floor(Date.now() / 1000) + 60 * 60,
                                };

                                const supabase_jwt_token = jwt.sign(payload, supabase_signing_secret);

                                input.accessTokenPayload = {
                                    ...input.accessTokenPayload,
                                    supabase_token: supabase_jwt_token,
                                };

                                return await originalImplementation.createNewSession(input);
                            },
                        };
                    },
                },
            }),
        ],
        isInServerlessEnv: true,
    };
};
```

### 3. Create a Supabase client

A client is created to interact with Supabase using the `supabase-js` library.

#### 3.1 Install the `supabase-js` library

    ```bash
    npm install @supabase/supabase-js
    ```

#### 3.2 Create a new file called `utils/supabase.ts` and add the following:

    ```ts
    // utils/supabase.ts

    let supabase_url = process.env.NEXT_PUBLIC_SUPABASE_URL || "TODO: Your Supabase URL"
    let supabase_key = process.env.NEXT_PUBLIC_SUPABASE_KEY || "TODO: Your Supabase Key"

    const getSupabase = (access_token: string) => {
      const supabase = createClient(
        supabase_url,
        supabase_key
      )

      supabase.auth.session = () => ({
        access_token,
        token_type: "",
        user: null
      })

      return supabase
    }

    export { getSupabase }
    ```

### 4. Insert users into Supabase when they sign up

In this example app, the user can sign up via Email-Password authentication.
The API needs to be overridden such that when a user signs up, their email mapped to their userId is stored in Supabase.

#### 4.1 Override the Email-Password sign up function

```ts
// config/backendConfig.ts

let appInfo: AppInfo = {
    appName: "TODO: add your app name",
    apiDomain: "TODO: add your website domain",
    websiteDomain: "TODO: add your website domain"
}

// take a look at the Creating Supabase Client section to see how to define getSupabase
let getSupabase: any;

let backendConfig = (): TypeInput => {
    return {
        framework: "express",
        supertokens: {
            connectionURI: "https://try.supertokens.com",
        },
        appInfo,
        recipeList: [
            ^{recipeNameCapitalLetters}.init({
                override: {
                    apis: (originalImplementation) => {
                        return {
                            ...originalImplementation,
                            // the signUpPOST function handles sign up
                            signUpPOST: async function (input) {
                                if (originalImplementation.signUpPOST === undefined) {
                                    throw Error("Should never come here");
                                }

                                let response = await originalImplementation.signUpPOST(input);

                                if (response.status === "OK" && response.user.loginMethods.length === 1 && input.session === undefined) {

                                    // retrieve the accessTokenPayload from the user's session
                                    const accessTokenPayload = response.session.getAccessTokenPayload();

                                    // create a supabase client with the supabase_token from the accessTokenPayload
                                    const supabase = getSupabase(accessTokenPayload.supabase_token);

                                    // store the user's email mapped to their userId in Supabase
                                    const { error } = await supabase
                                        .from("users")
                                        .insert({ email: response.user.emails[0], user_id: response.user.id });

                                    if (error !== null) {

                                        throw error;
                                    }
                                }

                                return response;
                            },
                        };
                    },
                },
            }),
            SessionNode.init({/*...*/}),
        ],
        isInServerlessEnv: true,
    };
};

```

The Email-Password sign up flow is changed by overriding the `signUpPOST` API.
When a user signs up, the `supabase_token` is retrieved from the user's `accessTokenPayload`(this was added in the previous step where the `createNewSession` function was changed) and used to query Supabase to insert the new user's information.

### 5. Retrieve the user email on the frontend



<PrebuiltUIInstructions>

With the backend setup, the frontend can be modified to retrieve the user's email from Supabase.

```tsx
// pages/index.tsx

// take a look at the Creating Supabase Client section to see how to define getSupabase
let getSupabase: any;

export default function Home() {
  return (
    // The ProtectedPage component is wrapped with the SessionAuth so only an
    // authenticated user can access it.
    <SessionAuth>
      <ProtectedPage />
    </SessionAuth>
  )
}

function ProtectedPage() {
  // retrieve the authenticated user's accessTokenPayload and userId from the sessionContext
  const session = useSessionContext()

  const [userEmail, setEmail] = useState('')
  useEffect(() => {
    async function getUserEmail() {
      if (session.loading) {
        return;
      }
      // retrieve the supabase client who's JWT contains users userId, this is
      // used by supabase to check that the user can only access table entries which contain their own userId
      const supabase = getSupabase(session.accessTokenPayload.supabase_token)

      // retrieve the user's name from the users table whose email matches the email in the JWT
      const { data } = await supabase.from('users').select('email').eq('user_id', session.userId)

      if (data.length > 0) {
        setEmail(data[0].email)
      }
    }
    getUserEmail()
  }, [session])

  if (session.loading) {
    return null;
  }

  return (
    <div>
      <Head>
        <title>SuperTokens 💫</title>
        <link rel="icon" href="/favicon.ico" />
      </Head>

      <main>
        <p>
          You are authenticated with SuperTokens! (UserId: {session.userId})
          <br />
          Your email retrieved from Supabase: {userEmail}
        </p>
      </main>
    </div>
  )
}
```

</PrebuiltUIInstructions>

<CustomUIInstructions>

With the backend setup, the frontend can be modified to retrieve the user's email from Supabase.

```tsx

// take a look at the Creating Supabase Client section to see how to define getSupabase
let getSupabase: any;

async function getEmailFromSupabase() {
  if (await Session.doesSessionExist()) {
    let accessTokenPayload = await Session.getAccessTokenPayloadSecurely();
    const supabase = getSupabase(accessTokenPayload.supabase_token)

    const { data } = await supabase.from('users').select('email').eq('user_id', await Session.getUserId())

    if (data.length > 0) {
      return data[0].email;
    }
    return undefined;
  }
  throw new Error("Session does not exist");
}
```

</CustomUIInstructions>

As seen above, the access token payload is fetched from SuperTokens to retrieve the authenticated user's Supabase access token which can be used to fetch the user's email from Supabase.

### 6. Enforce row level security for select and insert requests

To enforce Row Level Security for the Users table, you need to create policies for Select and Insert requests.
These polices retrieve the `userId` from the JWT and check if it matches the `userId` in the Supabase table.
A PostgreSQL function is needed to extract the `userId` from the JWT.

The payload in the JWT has the following structure:

```bash
{
    userId,
    exp
}
```

#### 6.1 Create PostgreSQL function to retrieve `userId` from JWT

To create the PostgreSQL function, navigate back to the Supabase dashboard, select `SQL` from the sidebar menu, and click `New query`. This creates a new query called `new sql snippet`, which allows you to run any SQL against the Postgres database.
Write the following and click `Run`.

    ```bash
    create or replace function auth.user_id() returns text as $$
    select nullif(current_setting('request.jwt.claims', true)::json->>'userId', '')::text;
    $$ language sql stable;
    ```

- This creates a function called `auth.user_id()`, which inspects the `userId` field of our JWT payload.

#### 6.2 Create Policies for `SELECT` and `INSERT` queries:

##### `SELECT` query policy

The first policy checks whether the user is the owner of the email being retrieved.

- Select `Authentication` from the Supabase sidebar menu, click `Policies`, and then `New Policy` on the `Users` table.

    ![Create policy](/img/thirdpartyemailpassword/supabase/create_policy.png)

- From the modal, select `Create a policy from scratch` and add the following.

    ![select policy](/img/thirdpartyemailpassword/supabase/policy_config_select.png)

- This policy is calling the PostgreSQL function we just created to get the currently logged in user's ID `auth.user_id()` and checking whether this matches the `user_id` column for the current `email`. If it does, then it allows the user to select it, otherwise it continues to deny.

- Click `Review` and then `Save policy`.

##### `INSERT` query policy

The second policy checks whether the `user_id` being inserted is the same as the `userId` in the JWT.

- Create another policy and add the following:

    ![insert policy](/img/thirdpartyemailpassword/supabase/policy_config_insert.png)

Similar to the previous policy, the PostgreSQL function that was created is called to get the currently logged in user's ID and check whether this matches the `user_id` column for the row being inserted. If it does, then it allows the user to insert the row, otherwise it continues to deny.

Click `Review` and then `Save policy`.

### 6.3 Test your changes

You can now sign up and you should see the following screen:

![auth screen](/img/thirdpartyemailpassword/supabase/supabase_app_authenticated_screen.png)

If you navigate to your table you should see a new row with the user's `user_id` and `email`.

![table with user](/img/thirdpartyemailpassword/supabase/table_with_user.png)

# Authentication -  Overview
Source: https://supertokens.com/docs/authentication/overview

Discover all the ways in which you can authenticate your users with **SuperTokens**.

## Authentication Methods

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/introduction">
    <ReferenceCard.Title>
      Email/Password
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Basic authentication using email and password.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/passwordless/introduction">
    <ReferenceCard.Title>
      Passwordless
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Authentication through magic links or one-time codes.
    </ReferenceCard.Description>
  </ReferenceCard>
<ReferenceCard.GridHelper />
  <ReferenceCard href="/docs/authentication/social/introduction">
    <ReferenceCard.Title>
      Social Login
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Login flow that uses third-party providers for authentication.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/passkeys/introduction">
    <ReferenceCard.Title>
      Passkeys
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Passwordless authentication using biometrics, security keys, or device-based credentials.
    </ReferenceCard.Description>
  </ReferenceCard>
<ReferenceCard.GridHelper />
  <ReferenceCard href="/docs/authentication/enterprise/introduction">
    <ReferenceCard.Title>
      Enterprise Login
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Instructions on how to configure your application to support multiple tenants and enterprise authentication methods.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/unified-login/introduction">
    <ReferenceCard.Title>
      Unified Login
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Details on how to create a common authentication experience for all your products.
    </ReferenceCard.Description>
  </ReferenceCard>
<ReferenceCard.GridHelper />
  <ReferenceCard href="/docs/authentication/m2m/introduction">
    <ReferenceCard.Title>
       Machine to Machine Authentication
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Guides on authenticating microservices using SuperTokens.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

## Additional Resources

For information on other features exposed by SuperTokens, please refer to the following resources:

<ReferenceCard.Grid>
			<ReferenceCard href="/docs/additional-verification/mfa/introduction">
    <ReferenceCard.Title>
          Multi-Factor Authentication
    </ReferenceCard.Title>
    <ReferenceCard.Description>
          Set up additional verification layers in you sign in process.
    </ReferenceCard.Description>
			</ReferenceCard>
			<ReferenceCard href="/docs/additional-verification/attack-protection-suite/introduction">
    <ReferenceCard.Title>
          Attack Protection Suite
    </ReferenceCard.Title>
    <ReferenceCard.Description>
          Enable additional security features that shield your app.
    </ReferenceCard.Description>
			</ReferenceCard>
<ReferenceCard.GridHelper />
			<ReferenceCard href="/docs/deployment/self-host-supertokens">
    <ReferenceCard.Title>
          Self Hosting
    </ReferenceCard.Title>
    <ReferenceCard.Description>
          Deploy SuperTokens in your own infrastructure.
    </ReferenceCard.Description>
			</ReferenceCard>

			<ReferenceCard href="/docs/migration/overview">
    <ReferenceCard.Title>
          Migration Guide
    </ReferenceCard.Title>
    <ReferenceCard.Description>
          Learn how to migrate from an existing authentication provider.
    </ReferenceCard.Description>
			</ReferenceCard>
		
</ReferenceCard.Grid>

# Authentication - Email Password -  Customize form fields
Source: https://supertokens.com/docs/authentication/email-password/customize-the-sign-in-form

## Before you start

The following instructions are only relevant if you are using the pre-built UI components. 
If you have created your own authentication UI, you can skip this guide.

## Modify labels and placeholders 

To change the labels and placeholders of the fields update the `formFields` property, in the recipe configuration.

<Tabs exclude={["mobile"]}>

<Tab value="reactjs">

```tsx preview="/img/emailpassword/signin-with-default-values.png"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signInForm: {
                    // highlight-start
                    formFields: [{
                        id: "email",
                        label: "customFieldName",
                        placeholder: "Custom value"
                    }]
                // highlight-end
                }
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signin-with-default-values.png" previewAlt="Prebuilt form UI with custom labels and placeholder"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signInForm: {
                    // highlight-start
                    formFields: [{
                        id: "email",
                        label: "customFieldName",
                        placeholder: "Custom value"
                    }]
                    // highlight-end
                }
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

---

## Set default values

Add a `getDefaultValue` option in the `formFields` configuration to pre-fill the inputs.
Keep in mind that the function needs to return a string.

<Tabs exclude={["mobile"]}>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/signin-with-default-values.png" previewAlt="Pre-built sign in form UI with default values for fields"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signInForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        // highlight-start
                        getDefaultValue: () => "john.doe@gmail.com"
                        // highlight-end
                    }]
                }
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signin-with-default-values.png" previewAlt="Pre-built sign in form UI with default values for fields"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signInForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        // highlight-start
                        getDefaultValue: () => "john.doe@gmail.com"
                        // highlight-end
                    }]
                }
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

---

## Change the optional error message

When you try to submit the login form without filling in the required fields, the UI, by default, shows an error stating that the `Field is not optional`.
To customize this message set the `nonOptionalErrorMsg` property to a custom string.

<Tabs exclude={["mobile"]}>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/signin-with-custom-error-msg.png" previewAlt="Pre-built sign in UI with custom error message"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signInForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        placeholder: "Email",
                        // highlight-start
                        nonOptionalErrorMsg: "Please add your email"
                        // highlight-end
                    }]
                }
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signin-with-custom-error-msg.png" previewAlt="Pre-built sign in UI with custom error message"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signInForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        placeholder: "Email",
                        // highlight-start
                        nonOptionalErrorMsg: "Please add your email"
                        // highlight-end
                    }]
                }
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

---

##  Custom field validators 

To add custom validation logic to the sign in form, update the sign up form configuration.
The `email` and `password` fields validation synchronizes between the two forms.

Check the [sign up form instructions](/docs/authentication/email-password/customize-the-sign-up-form#change-the-default-email-and-password-validators) for more details.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-up-form#change-the-default-email-and-password-validators" label="Custom Validators" />
  <ReferenceCard href="/docs/authentication/email-password/password-hashing" label="Password Hashing" />
  <ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/email-password/implement-username-login" label="Username login" />
  <ReferenceCard href="/docs/authentication/email-password/password-reset" label="Password reset" />
</ReferenceCard.Grid>

# Authentication - Email Password -  Customize the sign up form
Source: https://supertokens.com/docs/authentication/email-password/customize-the-sign-up-form

## Before you start

The next instructions assume that you have a working application that uses **SuperTokens** for authentication.
If not, please refer to the [quickstart guide](/docs/quickstart/frontend-setup) and then return here.



## Add extra fields

To include more fields in the sign up form, you need to first update both the frontend and backend configuration.
Then, when the sing up payload arrives on the backend, you should add a way to persist those values.

### 1. Add the new fields to the UI

<CustomUIInstructions>

You first need to add the new fields to your sign up interface.
Given that you are using a custom implementation, the steps vary based on your code.
After you have updated the form, ensure that the submit action follows the next example.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function signUpClicked(email: string, password: string, name: string, age: number, country: string) {
    let response = await signUp({
        formFields: [{
            id: "email",
            value: email
        }, {
            id: "password",
            value: password
        },{
            id: "name",
            value: name
        }, {
            id: "age",
            value: age + ""
        }, {
            id: "country",
            value: country
        }]
    })
    // ... rest of the code
}
```

</Tab>
<Tab value="scripts">

```tsx
async function signUpClicked(email: string, password: string, name: string, age: number, country: string) {
    let response = await supertokensEmailPassword.signUp({
        formFields: [{
            id: "email",
            value: email
        }, {
            id: "password",
            value: password
        }, {
            id: "name",
            value: name
        }, {
            id: "age",
            value: age + ""
        }, {
            id: "country",
            value: country
        }]
    })
    // ... rest of the code
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">



```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signup'
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "formFields": [{
        "id": "email",
        "value": "john@example.com"
    }, {
        "id": "password",
        "value": "somePassword123"
    }, {
        id: "name",
        value: "John Doe"
    }, {
        id: "age",
        value: 27
    }, {
        id: "country",
        value: "USA"
    }]
}'
```

</Tab>

</Tabs>

</CustomUIInstructions>

<PrebuiltUIInstructions>

<Tabs exclude={["mobile"]}>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/signup-with-name-and-age.png" previewAlt="Prebuilt form UI with extra custom fields"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                // highlight-start
                signUpForm: {
                    formFields: [{
                        id: "name",
                        label: "Full name",
                        placeholder: "First name and last name"
                    }, {
                        id: "age",
                        label: "Your age",
                        placeholder: "How old are you?",
                    }, {
                        id: "country",
                        label: "Your country",
                        placeholder: "Where do you live?",
                        optional: true
                    }]
                }
                // highlight-end
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signup-with-name-and-age.png" previewAlt="Prebuilt form UI with extra custom fields"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                // highlight-start
                signUpForm: {
                    formFields: [{
                        id: "name",
                        label: "Full name",
                        placeholder: "First name and last name"
                    }, {
                        id: "age",
                        label: "Your age",
                        placeholder: "How old are you?",
                    }, {
                        id: "country",
                        label: "Your country",
                        placeholder: "Where do you live?",
                        optional: true
                    }]
                }
                // highlight-end
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

#### Create custom components

By default, the new fields use `input` elements.
To enable more complex fields you can create your own custom components.

:::important
You may need to disable the Shadow DOM if you're integrating with a different component library that requires you to import its own CSS. For instance, some component libraries, such as [react-international-phone](https://github.com/goveo/react-international-phone), might expect you to include their CSS alongside their components. For more information, refer to [Disable use of shadow DOM](/docs/references/frontend-sdks/prebuilt-ui/shadow-dom).
:::

Set the `inputComponent` property for each field that you want to customize.

<Tabs>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/signup-with-custom-components.png" previewAlt="Pre-built form UI with custom components"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                // highlight-start
                signUpForm: {
                    formFields: [{
                        id: "select-dropdown",
                        label: "Select Dropdown",
                        inputComponent: ({ value, name, onChange }) => (
                            <div data-supertokens="inputContainer">
                                <div data-supertokens="inputWrapper ">
                                    <select
                                        style={{
                                            border: "unset",
                                            borderRadius: "6px",
                                            height: "32px",
                                            backgroundColor: "#fafafa",
                                            color: "#757575",
                                            letterSpacing: "1.2px",
                                            fontSize: "14px",
                                            width: "100%",
                                            marginRight: "25px",
                                            padding: "1px 0 1px 10px"
                                        }}
                                        value={value}
                                        name={name}
                                        onChange={(e) => onChange(e.target.value)}>
                                        <option value="" disabled hidden>
                                            Select an option
                                        </option>
                                        <option value="option 1">Option 1</option>
                                        <option value="option 2">Option 2</option>
                                        <option value="option 3">Option 3</option>
                                    </select>
                                </div>
                            </div>
                        ),
                        optional: true,
                    },
                    {
                        id: "terms",
                        label: "",
                        optional: false,
                        nonOptionalErrorMsg: "You must accept the terms and conditions",
                        inputComponent: ({ name, onChange }) => (
                            <div
                                style={{
                                    display: "flex",
                                    alignItems: "center",
                                    justifyContent: "left",
                                    marginBottom: " -12px",
                                }}>
                                <input name={name} type="checkbox" onChange={(e) => onChange(e.target.checked.toString())}></input>
                                <span style={{ marginLeft: 5 }}>
                                    I agree to the{" "}
                                    <a href="https://supertokens.com/legal/terms-and-conditions" data-supertokens="link">
                                        Terms and Conditions
                                    </a>
                                </span>
                            </div>
                        ),
                    }]
                }
                // highlight-end
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

:::caution
This is not applicable for non React apps. You have to create your own custom UI instead.
:::

</Tab>
</Tabs>

</PrebuiltUIInstructions>

### 2. Include the extra fields in the backend configuration

Change the **Backend SDK** initialization call to ensure that the system processes the new fields when a new user registers.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "..."
  },
  supertokens: {
    connectionURI: "...",
  },
  recipeList: [
    EmailPassword.init({
      signUpFeature: {
        // highlight-start
        formFields: [{
          id: "name"
        }, {
          id: "age"
        }, {
          id: "country",
          optional: true
        }]
        // highlight-end
      }
    }),
    Session.init({ /* ... */ })
  ]
});
```

</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signUpPOST: async function (input) {

                            if (originalImplementation.signUpPOST === undefined) {
                                throw Error("Should never come here");
                            }

                            // First we call the original implementation of signUpPOST.
                            let response = await originalImplementation.signUpPOST(input);

                            // Post sign up response, we check if it was successful
                            if (response.status === "OK") {

                                // These are the input form fields values that the user used while signing up
                                let formFields = input.formFields;

                            }
                            return response;
                        }
                    }
                }
            }
        }),
        Session.init({ /* ... */ })
    ]
});
```
</Tab>
<Tab value="go">

```go

							}

							return resp, err
						}

						return originalImplementation
					},
				},
			}),
		},
	})
}
```
</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import emailpassword, session
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    SignUpPostOkResult,
)
from supertokens_python.recipe.emailpassword.types import FormField
from typing import List, Dict, Any, Union
from supertokens_python.recipe.session.interfaces import SessionContainer

# highlight-start
def override_email_password_apis(original_implementation: APIInterface):
    original_sign_up_post = original_implementation.sign_up_post

    async def sign_up_post(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        # First we call the original implementation of sign_up_post.
        response = await original_sign_up_post(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

        # Post sign up response, we check if it was successful
        if isinstance(response, SignUpPostOkResult):
            pass
            # TODO: use the input form fields values for custom logic

        return response

    original_implementation.sign_up_post = sign_up_post
    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            # highlight-start
            override=emailpassword.InputOverrideConfig(
                apis=override_email_password_apis
            )
            # highlight-end
        ),
        session.init(),
    ],
)
```

</Tab>
</Tabs>

---

## Customize each form field

<CustomUIInstructions>

:::caution Not applicable
This section is not relevant for custom UI, as you create your own UI and already have control over the form fields.
:::

</CustomUIInstructions>

<PrebuiltUIInstructions>

### Modify labels and placeholders

To change the labels and placeholders of the fields, update the `formFields` property, in the recipe configuration.

<Tabs exclude={["mobile"]}>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/custom-field-name-signup-ep.png" previewAlt="Prebuilt form UI with custom labels and placeholder"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    // highlight-start
                    formFields: [{
                        id: "email",
                        label: "customFieldName",
                        placeholder: "Custom value"
                    }]
                }
                // highlight-end
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/custom-field-name-signup-ep.png" previewAlt="Prebuilt form UI with custom labels and placeholder"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    // highlight-start
                    formFields: [{
                        id: "email",
                        label: "customFieldName",
                        placeholder: "Custom value"
                    }]
                }
                // highlight-end
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

### Set default values

Add a `getDefaultValue` option to the `formFields` configuration to set default values.
Keep in mind that the function needs to return a string.

<Tabs exclude={["mobile"]}>

<Tab value="reactjs">

```tsx preview="/img/emailpassword/signup-with-default-values.png" previewAlt="Prebuilt form UI with default values for fields"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        // highlight-start
                        getDefaultValue: () => "john.doe@gmail.com"
                        // highlight-end
                    }, {
                        id: "name",
                        label: "Full name",
                        // highlight-start
                        getDefaultValue: () => "John Doe",
                        // highlight-end
                    }]
                }
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signup-with-default-values.png" previewAlt="Prebuilt form UI with default values for fields"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        // highlight-start
                        getDefaultValue: () => "john.doe@gmail.com"
                        // highlight-end
                    }, {
                        id: "name",
                        label: "Full name",
                        // highlight-start
                        getDefaultValue: () => "John Doe",
                        // highlight-end
                    }]
                }
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>

</Tabs>

### Change the optional error message

When you try to submit the login form without filling in the required fields, the UI, by default, shows an error stating that the `Field is not optional`.
To customize this message set the `nonOptionalErrorMsg` property to a custom string.

<Tabs exclude={["mobile"]}>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/signup-with-custom-error-msg.png" previewAlt="Prebuilt form UI with custom error message"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        placeholder: "Email",
                        // highlight-start
                        nonOptionalErrorMsg: "Please add your email"
                        // highlight-end
                    }, {
                        id: "name",
                        label: "Full name",
                        placeholder: "Name",
                        // highlight-start
                        nonOptionalErrorMsg: "Full name is required",
                        // highlight-end
                    }]
                }
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signup-with-custom-error-msg.png" previewAlt="Prebuilt form UI with custom error message"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        id: "email",
                        label: "Your Email",
                        placeholder: "Email",
                        // highlight-start
                        nonOptionalErrorMsg: "Please add your email"
                        // highlight-end
                    }, {
                        id: "name",
                        label: "Full name",
                        placeholder: "Name",
                        // highlight-start
                        nonOptionalErrorMsg: "Full name is required",
                        // highlight-end
                    }]
                }
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

### Change the field order

To customize the order of fields in your sign up form, override the `EmailPasswordSignUpForm` component.
Use the next example as a reference.

<Tabs>
<Tab value="reactjs">

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">

<Answer title="Yes">

```tsx preview="/img/emailpassword/signup-with-custom-field-order.png" previewAlt="Pre-built form UI with custom fields order"

function App() {
    return (
        <SuperTokensWrapper>
            <EmailPasswordComponentsOverrideProvider
                components={{
                    // highlight-start
                    EmailPasswordSignUpForm_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <DefaultComponent
                                {...props}
                                formFields={[
                                    props.formFields.find(({ id }) => id === 'name')!,
                                    props.formFields.find(({ id }) => id === 'email')!,
                                    props.formFields.find(({ id }) => id === 'password')!,
                                ]}
                            />
                        );
                    },
                    // highlight-end
                }}>
                {/* Rest of the JSX */}
            </EmailPasswordComponentsOverrideProvider>
        </SuperTokensWrapper>
    );
}
export default App;
```
</Answer>

<Answer title="No">

```tsx preview="/img/emailpassword/signup-with-custom-field-order.png" previewAlt="Pre-built form UI with custom fields order"

function App() {
    if (canHandleRoute([EmailPasswordPreBuiltUI])) {
        return (
            <EmailPasswordComponentsOverrideProvider
                components={{
                    // highlight-start
                    EmailPasswordSignUpForm_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <DefaultComponent
                                {...props}
                                formFields={[
                                    props.formFields.find(({ id }) => id === 'name')!,
                                    props.formFields.find(({ id }) => id === 'email')!,
                                    props.formFields.find(({ id }) => id === 'password')!,
                                ]}
                            />
                        );
                    },
                    // highlight-end
                }}>
                {getRoutingComponent([EmailPasswordPreBuiltUI])}
            </EmailPasswordComponentsOverrideProvider>
        )
    }
    return (
        <SuperTokensWrapper>
            {/* Rest of the JSX */}
        </SuperTokensWrapper>
    );
}
export default App;
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::caution

This is not applicable for non React apps. You have to create your own custom UI instead.

:::

</Tab>

</Tabs>

</PrebuiltUIInstructions>

---

## Change field validators 

### 1. Update the frontend configuration

<CustomUIInstructions>

:::caution Not applicable
For your custom UI, you have to implement field validation checking yourself.
Note that you need to also update the backend validation to ensure a complete flow.
Check the next section for more details.
:::
</CustomUIInstructions>

<PrebuiltUIInstructions>

Add a `validate` method to any of your `formFields`.
The following example shows how to add age verification to the form:

<Tabs>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/signup-with-name-and-age-failure.png" previewAlt="Pre-built form UI with custom validation"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        id: "name",
                        label: "Full name",
                        placeholder: "First name and last name"
                    }, {
                        id: "age",
                        label: "Your age",
                        placeholder: "How old are you?",
                        optional: true,

                        /* Validation method to make sure that age is above 18 */
                        // highlight-start
                        validate: async (value) => {
                            if (parseInt(value) > 18) {
                                return undefined; // means that there is no error
                            }
                            return "You must be over 18 to register";
                        }
                        // highlight-end

                    }, {
                        id: "country",
                        label: "Your country",
                        placeholder: "Where do you live?",
                        optional: true
                    }]
                }
            }
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx preview="/img/emailpassword/signup-with-name-and-age-failure.png" previewAlt="Pre-built form UI with custom validation"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        id: "name",
                        label: "Full name",
                        placeholder: "First name and last name"
                    }, {
                        id: "age",
                        label: "Your age",
                        placeholder: "How old are you?",
                        optional: true,

                        /* Validation method to make sure that age is above 18 */
                        // highlight-start
                        validate: async (value) => {
                            if (parseInt(value) > 18) {
                                return undefined; // means that there is no error
                            }
                            return "You must be over 18 to register";
                        }
                        // highlight-end

                    }, {
                        id: "country",
                        label: "Your country",
                        placeholder: "Where do you live?",
                        optional: true
                    }]
                }
            }
        }),
        supertokensUISession.init()
    ]
});
```
</Tab>
</Tabs>

</PrebuiltUIInstructions>

### 2. Update the backend configuration

Add `validate` functions to each of the form fields, in the backend SDK initialization call. 

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            signUpFeature: {
                formFields: [{
                    id: "name"
                }, {
                    id: "age",
                    /* Validation method to make sure that age >= 18 */
                    // highlight-start
                    validate: async (value, tenantId) => {
                        if (parseInt(value) >= 18) {
                            return undefined; // means that there is no error
                        }
                        return "You must be over 18 to register";
                    }
                    // highlight-end
                }, {
                    id: "country",
                    optional: true
                }]
            }
        }),
        Session.init({
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        // highlight-start
                        id: "email",
                        label: "...",
                        validate: async (value) => {
                            // Your own validation returning a string or undefined if no errors.
                            return "...";
                        }
                    }, {
                        id: "password",
                        label: "...",
                        validate: async (value) => {
                            // Your own validation returning a string or undefined if no errors.
                            return "...";
                        }
                        // highlight-end
                    }]
                }
            }
        })
    ]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            signInAndUpFeature: {
                signUpForm: {
                    formFields: [{
                        // highlight-start
                        id: "email",
                        label: "...",
                        validate: async (value) => {
                            // Your own validation returning a string or undefined if no errors.
                            return "...";
                        }
                    }, {
                        id: "password",
                        label: "...",
                        validate: async (value) => {
                            // Your own validation returning a string or undefined if no errors.
                            return "...";
                        }
                        // highlight-end
                    }]
                }
            }
        })
    ]
});
```
</Tab>
</Tabs>
</PrebuiltUIInstructions>

##### 1. Update the backend configuration

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            signUpFeature: {
                formFields: [{
                    // highlight-start
                    id: "email",
                    validate: async (value, tenantId) => {
                        // Your own validation returning a string or undefined if no errors.
                        return "...";
                    }
                }, {
                    id: "password",
                    validate: async (value, tenantId) => {
                        // Your own validation returning a string or undefined if no errors.
                        return "...";
                    }
                    // highlight-end
                }]
            }
        }),
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    termsOfServiceLink: "https://example.com/terms-of-service",
    privacyPolicyLink: "https://example.com/privacy-policy",
    // highlight-end
    recipeList: [/* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    termsOfServiceLink: "https://example.com/terms-of-service",
    privacyPolicyLink: "https://example.com/privacy-policy",
    // highlight-end
    recipeList: [/* ... */]
});
```

</Tab>
</Tabs>

</PrebuiltUIInstructions>
<CustomUIInstructions>

:::caution
Not applicable since you do not use the pre-built UI.
:::

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/password-hashing" label="Password Hashing" />
  <ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/email-password/implement-username-login" label="Username login" />
  <ReferenceCard href="/docs/authentication/email-password/password-reset" label="Password reset" />
</ReferenceCard.Grid>

# Authentication - Email Password -  Hooks and overrides
Source: https://supertokens.com/docs/authentication/email-password/hooks-and-overrides

**SuperTokens** exposes a set of constructs that allow you to trigger different actions during the authentication lifecycle or to even fully customize the logic based on your use case. 
The following sections describe how you can modify adjust the `emailpassword` recipe to your needs.

Explore the [references pages](/docs/references) for a more in depth guide on hooks and overrides.

## Sign in 

### Frontend hook 



<PrebuiltUIInstructions>

This method gets fired, with the `SUCCESS` action, immediately after a successful sign in or sign up.
Follow the code snippet to determine if the user is signing up or signing in.

With this method you can fire events immediately after a successful sign in.
You can use it to send analytics events. 

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "SUCCESS") {
                    if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                        // TODO: Sign up
                    } else {
                        // TODO: Sign in
                    }
                }
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "SUCCESS") {
                    if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                        // TODO: Sign up
                    } else {
                        // TODO: Sign in
                    }
                }
            }
            // highlight-end
        }),
        supertokensUISession.init()
    ]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

:::caution Not applicable
This section is not applicable for custom UI since you are calling the sign in API yourself anyway. You can perform anything you want to do post sign in based on the result of the API call.
:::

</CustomUIInstructions>

### Backend override 

Overriding the `signIn` function allows you to introduce your own logic for the sign in process.
Use it to persist different types of data or trigger actions.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signIn: async function (input) {

                            // First we call the original implementation of signIn.
                            let response = await originalImplementation.signIn(input);

                            // Post sign up response, we check if it was successful
                            if (response.status === "OK") {
                                /**
                                * 
                                * response.user contains the following info:
                                * - emails
                                * - id
                                * - timeJoined
                                * - tenantIds
                                * - phone numbers
                                * - third party login info
                                * - all the login methods associated with this user.
                                * - information about if the user's email is verified or not.
                                * 
                                */

                                // TODO: post sign in logic
                            }
                            return response;
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "SUCCESS") {
                    if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                        // TODO: Sign up
                    } else {
                        // TODO: Sign in
                    }
                }
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "SUCCESS") {
                    if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                        // TODO: Sign up
                    } else {
                        // TODO: Sign in
                    }
                }
            }
            // highlight-end
        }),
        supertokensUISession.init()
    ]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

:::caution Not applicable
This section is not applicable for custom UI since you are calling the sign up API yourself anyway. You can perform anything you want to do post sign up based on the result of the API call.
:::

</CustomUIInstructions>

### Backend override 

Overriding the `signUp` function allows you to introduce your own logic for the sign in process.
Use it to persist different types of data, synchronize users between **SuperTokens** and your systems or to trigger other types of actions.

<Tabs>
<Tab value="nodejs">

```tsx

// backend
SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signUp: async function (input) {
                            // First we call the original implementation of signUp.
                            let response = await originalImplementation.signUp(input);

                            // Post sign up response, we check if it was successful
                            if (response.status === "OK" && response.user.loginMethods.length === 1 && input.session === undefined) {
                                /**
                                * 
                                * response.user contains the following info:
                                * - emails
                                * - id
                                * - timeJoined
                                * - tenantIds
                                * - phone numbers
                                * - third party login info
                                * - all the login methods associated with this user.
                                * - information about if the user's email is verified or not.
                                * 
                                */
                                // TODO: post sign up logic
                            }
                            return response;
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "PASSWORD_RESET_SUCCESSFUL") {
                    // Add you custom logic here
                } else if (context.action === "RESET_PASSWORD_EMAIL_SENT") {
                    // Add you custom logic here
                }
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "PASSWORD_RESET_SUCCESSFUL") {
                    // Add you custom logic here
                } else if (context.action === "RESET_PASSWORD_EMAIL_SENT") {
                    // Add you custom logic here
                }
            }
            // highlight-end
        }),
        supertokensUISession.init()
    ]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

:::caution Not applicable
This section is not applicable for custom UI since you are calling the sign in API yourself anyway. You can perform anything you want to do during the password reset flow based on the result of the API call.
:::

</CustomUIInstructions>

### Backend override

Overriding the `passwordResetPOST` function allows you to introduce your own logic for the password reset process.
Use it to introduce your own logic for the flow.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        passwordResetPOST: async function(input) {
                            
                            if (originalImplementation.passwordResetPOST === undefined) {
                                throw Error("Should never come here");
                            }

                            // First we call the original implementation
                            let response = await originalImplementation.passwordResetPOST(input);
                            
                            // Then we check if it was successfully completed
                            if (response.status === "OK") {
                                // TODO: post password reset logic
                            }
                            return response;
                        }
                    };
                },
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

# Authentication - Email Password -  Password hashing
Source: https://supertokens.com/docs/authentication/email-password/password-hashing

## Overview

**SuperTokens** supports two password hashing algorithms: `BCrypt` and `Argon2`.
Per current best practices, `Argon2` is the recommended algorithm. 
However, **SuperTokens** uses `BCrypt` by default since `Argon2` requires custom settings that are specific to the hardware in which the core is running on.

### Hashing time

The key metric to aim for when hashing passwords is the amount of time each hash would take.
By default, **SuperTokens** has configured these algorithms to take 300 milliseconds per hash on a machine with 1 GB of `RAM` and 2 virtual `CPU` cores.

## Change the hashing algorithm

You can switch algorithms whenever you want.
The change affects only the new users that sign up.
Previous passwords undergo decryption using the original algorithm.
For example, if you hash a password with `BCrypt`, it verifies using `BCrypt` even if the core configuration changes to `Argon2`.

Instructions:

<Tabs>

  <Tabs.ManagedContent>
      1. Go to the SuperTokens SaaS dashboard.
      2. Click "Edit Configuration" on the environment you want to change.
      3. Find the `password_hashing_alg` property and change it.
      4. Click "Save".
  </Tabs.ManagedContent>

  <Tabs.SelfHostedContent value="with-docker">

```bash
docker run \
    -p 3567:3567 \
    // highlight-start
    -e PASSWORD_HASHING_ALG=BCRYPT \
    -e BCRYPT_LOG_ROUNDS=11 \
    // highlight-end
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
  </Tabs.SelfHostedContent>

  <Tabs.SelfHostedContent value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

password_hashing_alg: BCRYPT
bcrypt_log_rounds: 11
```
  </Tabs.SelfHostedContent>

</Tabs>

## Hashing calibration

This information is relevant only for self hosted core instances.
The managed service instances have already calibrated the algorithms based on the hardware.

:::important
When you change the hashing settings make sure to run the calibration CLI command to find the right balance for your hardware.
:::

<Tabs values={ [{label: 'Argon2', value: 'argon2'}, {label: 'bcrypt', value: 'bcrypt'}] }>

<TabItem value="argon2">

#### Algorithm settings

| Name | Default | Description |
| --- | --- | --- |
| `password_hashing_alg` | - | This setting chooses which password hashing algorithm to use. For using Argon2, set this to `ARGON2`. |
| `argon2_iterations` | `1` | This controls how much `CPU` processing power the hashing process uses. The higher the value, the more processing power, and hence the more time each hash takes. |
| `argon2_memory_kb` | `87795` (85 MB) | The amount of memory (`RAM`) that each hash takes. The higher this is, the harder it becomes to crack hashes offline, and the longer the algorithm takes. |
| `argon2_parallelism` | `2` | This is the number of threads the algorithm uses during hashing. The higher this is, the harder it would be to crack passwords offline using multiple cores. Should be equal to the number of virtual cores (or twice the number of physical cores) available in the system. |
| `argon2_hashing_pool_size` | `1` | This is the maximum number of concurrent hashes that the core performs. A value of `1` means that the core does only one hash at one point in time, other requests for hashing queue up and wait for their turn. |

##### Example

If each hash takes 300 milliseconds, a value of `1` here would entail ~ a max of 3 hashes per second (1000 ms / 300 ms). A value of `2` here would entail a max of 6 hashes per second (1000 ms / 300 ms)*2.

Password hashing occurs during sign in, sign up, and password reset flows. Therefore, you can set this value according to the target time per hash and how many sign ups/in you expect per second.

#### Change the settings

<Tabs>
<Tab value="with-docker">

```bash
docker run \
    -p 3567:3567 \
    // highlight-start
    -e PASSWORD_HASHING_ALG=ARGON2 \
    -e ARGON2_ITERATIONS=1 \
    -e ARGON2_MEMORY_KB=87795 \
    -e ARGON2_PARALLELISM=2 \
    -e ARGON2_HASHING_POOL_SIZE=1 \
    // highlight-end
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

password_hashing_alg: ARGON2
argon2_iterations: 1
argon2_memory_kb: 87795
argon2_parallelism: 2
argon2_hashing_pool_size: 1
```

</Tab>
</Tabs>

#### Calibrate to your hardware

To find the optimal setting for your hardware, you can run the `hashingCalibrate` command via the CLI. This command takes a few parameters:
- `--with_alg`:
    - The value of this should be `argon2`
    - Compulsory parameter
- `--with_time_per_hash_ms`:
    - This requires the target time per hash (in milliseconds).
    - The default value is `300`.
- `--with_argon2_hashing_pool_size`:
    - This affects how much memory the hashing process uses per hash.
    - The default value is `1`
- `--with_argon2_max_memory_mb`:
    - This is the maximum amount of memory (`RAM`) that the core should use for password hashing. The amount of memory per password hash is `with_argon2_max_memory_mb / with_argon2_hashing_pool_size`.
    - The default value is `1024`.
- `--with_argon2_parallelism`:
    - This is the number of threads that argon2 should use. The higher this is, the harder it becomes to crack passwords offline.
    - The default value is `2*number of cores`

Running the algorithm takes minutes.

<Tabs>
<Tab value="with-docker">

```bash
docker run registry.supertokens.io/supertokens/supertokens-<db_name> supertokens hashingCalibrate --with_alg=argon2
```
</Tab>

<Tab value="without-docker">

```bash
supertokens hashingCalibrate --with_alg=argon2
```

</Tab>
</Tabs>

The above produces an output like:
```text
====Input Settings====

-> Target time per hash (--with_time_per_hash_ms): 300 MS
-> Number of max concurrent hashes (--with_argon2_hashing_pool_size): 1
-> Max amount of memory to consume across 1 concurrent hashes (--with_argon2_max_memory_mb): 1024 MB
-> Argon2 parallelism (--with_argon2_parallelism): 4

====Running algorithm====

Current argon2 settings
-> memory: 1024 MB
-> iterations: 1
Calculating average hashing time....
..................................................Took 574 MS per hash

Adjusting memory to reach target time.

Current argon2 settings
-> memory: 972 MB
-> iterations: 1
Calculating average hashing time....
..................................................Took 529 MS per hash

Adjusting memory to reach target time.

Current argon2 settings
-> memory: 924 MB
-> iterations: 1
Calculating average hashing time....
..................................................Took 494 MS per hash

<....Truncated....>

Adjusting memory to reach target time.

Current argon2 settings
-> memory: 367 MB
-> iterations: 2
Calculating average hashing time....
..................................................Took 319 MS per hash

Adjusting memory to reach target time.

Current argon2 settings
-> memory: 348 MB
-> iterations: 2
Calculating average hashing time....
..................................................Took 303 MS per hash

====Final values====
Average time per hash is: 303 MS

argon2_memory_kb: 357104 (348 MB)
argon2_iterations: 2
argon2_parallelism: 4
argon2_hashing_pool_size: 1

====================
You should use these as docker environment variables or put them in the config.yaml file in the SuperTokens installation directory.
```

The contents of the `====Final values====` gives you the values of the parameters to provide to the core.

The algorithm starts with the highest amount of memory per hash (= `with_argon2_max_memory_mb/with_argon2_hashing_pool_size`) and `1` iteration.
It calculates the current average hashing time by simulating hashes concurrently (based on the value of `with_argon2_hashing_pool_size`). If the hashing time is greater than the target time, it reduces the memory by 5%. If it's less than the target time, it increases the number of iterations. The algorithm stops if the current time is within 10 milliseconds (higher or lower) of the target time.

:::info debug
If you see an output like:
```bash
/usr/bin/supertokens: line 9: 15 Killed "${ST_INSTALL_LOC}"jre/bin/java -classpath "${ST_INSTALL_LOC}cli/*" io.supertokens.cli.Main false "${ST_INSTALL_LOC}" $@
```
it means that the system doesn't have enough memory. Try to run the algorithm again with a lower memory value by passing `--with_argon2_max_memory_mb`
:::

</TabItem>

<TabItem value="bcrypt">

#### Algorithm settings

| Name | Default | Description |
|------|--------------|-------------|
| `password_hashing_alg` | - | This setting chooses which password hashing algorithm to use. For using bcrypt, set this to `BCRYPT`. |
| `bcrypt_log_rounds` | `11` | The number of rounds to use for hashing is `2^bcrypt_log_rounds`. The higher this value, the more time hashing takes. |

#### Change settings

<Tabs>
<Tabs.Tab value="with-docker">

```bash
docker run \
    -p 3567:3567 \
    // highlight-start
    -e PASSWORD_HASHING_ALG=BCRYPT \
    -e BCRYPT_LOG_ROUNDS=11 \
    // highlight-end
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tabs.Tab>

<Tabs.Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

password_hashing_alg: BCRYPT
bcrypt_log_rounds: 11
```

</Tabs.Tab>
</Tabs>

#### Calibrate to your hardware

To find the optimal setting for your hardware, you can run the `hashingCalibrate` command via the CLI. This command takes a few parameters:
- `--with_alg`:
    - The value of this should be `bcrypt`.
    - Compulsory parameter
- `--with_time_per_hash_ms`:
    - This requires the target time per hash (in milliseconds).
    - The default value is `300`

<Tabs>
<Tabs.Tab value="with-docker">

```bash
docker run registry.supertokens.io/supertokens/supertokens-<db_name> supertokens hashingCalibrate --with_alg=bcrypt
```
</Tabs.Tab>

<Tabs.Tab value="without-docker">

```bash
supertokens hashingCalibrate --with_alg=bcrypt
```

</Tabs.Tab>
</Tabs>

The above produces an output like:
```text
====Input Settings====
-> Target time per hash (--with_time_per_hash_ms): 300 MS

====Running algorithm====

Current log rounds: 11
..........Took 158 MS per hash

Incrementing log rounds and trying again...

Current log rounds: 12
..........Took 310 MS per hash

====Final values====
Average time per hash is: 310 MS

bcrypt_log_rounds: 12

====================
You should use this as a docker environment variable or put this in the config.yaml file in the SuperTokens installation directory.
```

The contents of the `====Final values====` gives you the values of the parameters to provide to the core.

The algorithm starts with the minimum recommended value (`11`), and increments it until the average time per hash is greater than the target time. The final value is then equal to the value that yields the closest time per hash as the target one.

  </TabItem>

</Tabs>


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-in-form" label="Customize the sign in form" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-up-form" label="Customize the sign up form" />
  <ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/email-password/password-reset" label="Password reset" />
</ReferenceCard.Grid>

# Authentication - Email Password -  Implement username login
Source: https://supertokens.com/docs/authentication/email-password/implement-username-login

## Overview

This tutorial shows you how to customize the recipe to add username based login with an optional email field. 

A few variations exist on how username-based flows can work:

| Login Type | Description | Password Reset Flow |
|------------|-------------|-------------------|
| Username only | User signs up and signs in with username and password | Contact support required |
| Username with optional email | User signs up with username and password, email is optional. Can sign in with either username or email | Uses email if provided, otherwise contact support |
| Username and email required | User must provide username, email and password during sign up. Can sign in with either username or email | Uses email |

This guide implements the second flow: **Username and password login with optional email**.
If you are using one of the other options, you can still follow this guide and make tweaks on parts of it to achieve your desired flow.

The approach is to update the `email` form field.
This way it gets displayed and validated as a username.
Then the optional email value gets saved against the `userID` of the user and you use it during sign in and reset password flows. You need to handle the mapping of email to `userID` and store it in your own database. The code snippets below create placeholder functions for you to implement.

## Before you start

This guide assumes that you have already implemented the [EmailPassword recipe](/docs/authentication/email-password/introduction) and have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

## Steps

### 1. Modify the default email validator function

Update the backend validator function to check for your username format.
The function runs during **sign up**, **sign in**, and **reset password**.
Hence it needs to also match an email format since the user might enter it when signing in or resetting their password.

Inside **SuperTokens**, the field is still called `email`.
This ensures that the username is unique and that the authentication flows works.
Use the next code snippet as a reference. 

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            signUpFeature: {
                formFields: [{
                    id: "email",
                    validate: async (value) => {
                        if (typeof value !== "string") {
                            return "Please provide a string input."
                        }

                        // first we check for if it's an email
                        if (
                            value.match(
                                /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
                            ) !== null
                        ) {
                            return undefined;
                        }

                        // since it's not an email, we check for if it's a correct username
                        if (value.length < 3) {
                            return "Usernames must be at least 3 characters long."
                        }
                        if (!value.match(/^[a-z0-9_-]+$/)) {
                            return "Username must contain only alphanumeric, underscore or hyphen characters."
                        }
                    }
                }]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go
								if err != nil {
									msg := "Email is invalid"
									return &msg
								}
								if emailCheck {
									return nil
								}

								// since it's not an email, we check for if it's a correct username
								if len(value.(string)) < 3 {
									msg := "Usernames must be at least 3 characters long."
									return &msg
								}
								userNameCheck, err := regexp.Match(`^[a-z0-9_-]+$`, []byte(value.(string)))
								if err != nil || !userNameCheck {
									msg := "Username must contain only alphanumeric, underscore or hyphen characters."
									return &msg
								}
								return nil
							},
						},
					},
				},
			}),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from re import fullmatch

from supertokens_python import InputAppInfo, init
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.types import InputFormField
from supertokens_python.recipe.emailpassword.utils import InputSignUpFeature

async def validate(value: str, tenant_id: str):
    # first we check for if it's an email
    if fullmatch(
        r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
        value
    ) is not None:
        return None

    # since it's not an email, we check for if it's a correct username
    if len(value) < 3:
        return "Usernames must be at least 3 characters long."

    if fullmatch(r'^[a-z0-9_-]+$', value) is None:
        return "Username must contain only alphanumeric, underscore or hyphen characters."

    return None

init(
    app_info=InputAppInfo(
        api_domain="...", app_name="...", website_domain="..."),
    framework='...',  # type: ignore
    recipe_list=[
        emailpassword.init(
            sign_up_feature=InputSignUpFeature(form_fields=[
                InputFormField(id="email", validate=validate)
            ])
        )
    ]
)
```

</Tab>
</Tabs>

### 2. Save the user email

#### 2.1 Update the sign up form validation

The sign up `API` takes in the username, password, and an optional email.
Add a new form field for the email, along with a `validate` function that checks the uniqueness and syntax of the input email.

:::warning Custom Implementation
To check if the email is unique you need to persist values in your own database and then check against them.
:::

<Tabs>
<Tab value="nodejs">

```tsx

let emailUserMap: {[key: string]: string} = {}

async function getUserUsingEmail(email: string): Promise<string | undefined> {
    // TODO: Check your database for if the email is associated with a user
    // and return that user ID if it is.

    // this is just a placeholder implementation
    return emailUserMap[email];
}

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            signUpFeature: {
                formFields: [{
                    id: "email",
                    validate: async (value) => {
                        // ...from previous code snippet...
                        return undefined
                    }
                }, {
                    // highlight-start
                    id: "actualEmail",
                    validate: async (value) => {
                        if (value === "") {
                            // this means that the user did not provide an email
                            return undefined;
                        }
                        if (
                            value.match(
                                /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
                            ) === null
                        ) {
                            return "Email is invalid";
                        }

                        if ((await getUserUsingEmail(value)) !== undefined) {
                            return "Email already in use. Please sign in, or use another email"
                        }
                    },
					optional: true
                    // highlight-end
                }]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go
								return nil
							},
						},
						// highlight-start
						{
							ID: "actualEmail",
							Validate: func(value interface{}, tenantId string) *string {

                                if value.(string) == "" {
									// user did not provide an email
									return nil
								}

								// first we check if the input is an email
								emailCheck, err := regexp.Match(`^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$`, []byte(value.(string)))
								if err != nil || !emailCheck {
									msg := "Email is invalid"
									return &msg
								}

								user, err := getUserUsingEmail(value.(string))
								if err != nil || user != nil {
									msg := "Email already in use. Please sign in, or use another email"
									return &msg
								}

								return nil
							},
							Optional: &actualEmailOptional,
						},
						// highlight-end
					},
				},
			}),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from re import fullmatch
from typing import Dict

from supertokens_python import InputAppInfo, init
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.types import InputFormField
from supertokens_python.recipe.emailpassword.utils import InputSignUpFeature

email_user_map: Dict[str, str] = {}

# highlight-start
async def get_user_using_email(email: str):
    # TODO: Check your database for if the email is associated with a user
    # and return that user ID if it is.

    # this is just a placeholder implementation
    if email in email_user_map:
        return email_user_map[email]
    return None
# highlight-end

async def validate(value: str, tenant_id: str):
    # from previous code snippet..
    return None

async def validate_actual_email(value: str, tenant_id: str):
    if fullmatch(
        r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
        value
    ) is None:
        return "Email is invalid"

    if (await get_user_using_email(value)) is not None:
        return "Email already in use. Please sign in, or use another email"

init(
    app_info=InputAppInfo(
        api_domain="...", app_name="...", website_domain="..."),
    framework='...',  # type: ignore
    recipe_list=[
        emailpassword.init(
            sign_up_feature=InputSignUpFeature(form_fields=[
                InputFormField(id="email", validate=validate),
				# highlight-start
                InputFormField(id="actualEmail",
                               validate=validate_actual_email, optional=True)
				# highlight-end
            ])
        )
    ]
)
```

</Tab>
</Tabs>

#### 2.2 Save the email field value

Override the sign up API to save the custom email form field.
Use a mapping of `userID` to `email` to keep track of the association.
Save the email value in your own database.

<Tabs>
<Tab value="nodejs">

```tsx

let emailUserMap: {[key: string]: string} = {}

async function getUserUsingEmail(email: string): Promise<string | undefined> {
    // TODO: Check your database for if the email is associated with a user
    // and return that user ID if it is.
    
    // this is just a placeholder implementation
    return emailUserMap[email];
}

async function saveEmailForUser(email: string, userId: string) {
    // TODO: Save email and userId mapping

    // this is just a placeholder implementation
    emailUserMap[email] = userId
}

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                apis: (original) => {
                    return {
                        ...original,
                        signUpPOST: async function (input) {
                            let response = await original.signUpPOST!(input);
                            if (response.status === "OK") {
                                // sign up successful
                                let actualEmail = input.formFields.find(i => i.id === "actualEmail")!.value as string;
                                if (actualEmail === "") {
                                    // User did not provide an email.
                                    // This is possible since we set optional: true
                                    // in the formField config 
                                } else {
                                    await saveEmailForUser(actualEmail, response.user.id)
                                }
                            }
                            return response
                        }
                    }
                }
            },
            // highlight-end
            signUpFeature: {
                formFields: [ /* ... from previous code snippet ... */]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go
				},
                // highlight-start
				Override: &epmodels.OverrideStruct{
					APIs: func(originalImplementation epmodels.APIInterface) epmodels.APIInterface {
						ogSignUpPOST := *originalImplementation.SignUpPOST
						(*originalImplementation.SignUpPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.SignUpPOSTResponse, error) {
							resp, err := ogSignUpPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.SignUpPOSTResponse{}, err
							}
							if resp.OK != nil {
								// sign up successful
								actualEmail := ""
								for _, field := range formFields {
									if field.ID == "email" {
										valueAsString, asStrOk := field.Value.(string)
										if !asStrOk {
											return epmodels.SignUpPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
										}
										actualEmail = valueAsString
									}
								}
								if actualEmail == "" {
									// User did not provide an email.
									// This is possible since we set optional: true
									// in the formField config
								} else {
									err := saveEmailForUser(actualEmail, resp.OK.User.ID)
									if err != nil {
										return epmodels.SignUpPOSTResponse{}, err
									}
								}
							}
							return resp, nil
						}
						return originalImplementation
					},
				},
                // highlight-end
			}),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from typing import Any, Dict, List, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    SignUpPostOkResult,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.emailpassword.utils import (
    InputOverrideConfig,
    InputSignUpFeature,
)
from supertokens_python.recipe.session.interfaces import SessionContainer

email_user_map: Dict[str, str] = {}

async def get_user_using_email(email: str):
    # TODO: Check your database for if the email is associated with a user
    # and return that user ID if it is.

    # this is just a placeholder implementation
    if email in email_user_map:
        return email_user_map[email]
    return None

# highlight-start
async def save_email_for_user(email: str, user_id: str):
    # TODO: Save email and userId mapping

    # this is just a placeholder implementation
    email_user_map[email] = user_id

def apis_override(original: APIInterface):
    og_sign_up_post = original.sign_up_post

    async def sign_up_post(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        response = await og_sign_up_post(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )
        if isinstance(response, SignUpPostOkResult):
            # sign up successful
            actual_email = ""
            for field in form_fields:
                if field.id == "email":
                    actual_email = field.value
            if actual_email == "":
                # User did not provide an email.
                # This is possible since we set optional: true
                # in the form field config
                pass
            else:
                await save_email_for_user(actual_email, response.user.id)
        return response

    original.sign_up_post = sign_up_post
    return original

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            sign_up_feature=InputSignUpFeature(
                form_fields=[
                    # from previous code snippets...
                ]
            ),
            override=InputOverrideConfig(apis=apis_override),
        )
    ],
)
```

</Tab>
</Tabs>

### 3. Allow username or email during sign in

The user should be able to sign in using their email or username along with their password.
In the new logic, if a user enters their email, you need to fetch the username associated with that email and then perform the authentication flow.
Override the sign in recipe function to allow this.

Use the next code snippet as a reference. The example use the `email` to `userId` mapping, mentioned earlier, to figure out which username to use.

<Tabs>
<Tab value="nodejs">

```tsx

let emailUserMap: { [key: string]: string } = {}

async function getUserUsingEmail(email: string): Promise<string | undefined> {
    // TODO: Check your database for if the email is associated with a user
    // and return that user ID if it is.

    // this is just a placeholder implementation
    return emailUserMap[email];
}

async function saveEmailForUser(email: string, userId: string) {
    // TODO: Save email and userId mapping

    // this is just a placeholder implementation
    emailUserMap[email] = userId
}

// highlight-start
function isInputEmail(input: string): boolean {
    return input.match(
        /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
    ) !== null;
}
// highlight-end

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            override: {
                // highlight-start
                functions: (original) => {
                    return {
                        ...original,
                        signIn: async function (input) {
                            if (isInputEmail(input.email)) {
                                let userId = await getUserUsingEmail(input.email);
                                if (userId !== undefined) {
                                    let superTokensUser = await SuperTokens.getUser(userId);
                                    if (superTokensUser !== undefined) {
                                        // we find the right login method for this user
                                        // based on the user ID.
                                        let loginMethod = superTokensUser.loginMethods.find(lM => lM.recipeUserId.getAsString() === userId && lM.recipeId === "emailpassword");

                                        if (loginMethod !== undefined) {
                                            input.email = loginMethod.email!
                                        }
                                    }
                                }
                            }
                            return original.signIn(input);
                        }
                    }
                },
                // highlight-end
                apis: (original) => {
                    return {
                        ...original,
                        // override from previous code snippet
                    }
                }
            },
            signUpFeature: {
                formFields: [ /* ... from previous code snippet ... */]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go
	if err != nil || !emailCheck {
		return false
	}
	return true
}
// highlight-end

func main() {

	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			emailpassword.Init(&epmodels.TypeInput{
				SignUpFeature: &epmodels.TypeInputSignUp{
					FormFields: []epmodels.TypeInputFormField{ /*...from previous code snippet...*/},
				},
				Override: &epmodels.OverrideStruct{
					APIs: func(originalImplementation epmodels.APIInterface) epmodels.APIInterface {
						// ...from previous code snippet...
						return originalImplementation
					},
                    // highlight-start
					Functions: func(originalImplementation epmodels.RecipeInterface) epmodels.RecipeInterface {
						ogSignIn := *originalImplementation.SignIn
						(*originalImplementation.SignIn) = func(email, password, tenantId string, userContext supertokens.UserContext) (epmodels.SignInResponse, error) {
							if isInputEmail(email) {
								userId, err := getUserUsingEmail(email)
								if err != nil {
									return epmodels.SignInResponse{}, err
								}
								if userId != nil {
									supertokensUser, err := emailpassword.GetUserByID(*userId)
									if err != nil {
										return epmodels.SignInResponse{}, err
									}
									if supertokensUser != nil {
										email = supertokensUser.Email
									}
								}
							}
							return ogSignIn(email, password, tenantId, userContext)
						}
						return originalImplementation
					},
                    // highlight-end
				},
			}),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from re import fullmatch
from typing import Any, Dict, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import get_user
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import RecipeInterface
from supertokens_python.recipe.emailpassword.utils import (
    InputOverrideConfig,
    InputSignUpFeature,
)
from supertokens_python.recipe.session.interfaces import SessionContainer

email_user_map: Dict[str, str] = {}

async def get_user_using_email(email: str):
    # TODO: Check your database for if the email is associated with a user
    # and return that user ID if it is.

    # this is just a placeholder implementation
    if email in email_user_map:
        return email_user_map[email]
    return None

async def save_email_for_user(email: str, user_id: str):
    # TODO: Save email and userId mapping

    # this is just a placeholder implementation
    email_user_map[email] = user_id

# highlight-start

def is_input_email(email: str):
    return (
        fullmatch(
            r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
            email,
        )
        is not None
    )

def recipe_override(original: RecipeInterface):
    og_sign_in = original.sign_in

    async def sign_in(
        email: str,
        password: str,
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        user_context: Dict[str, Any],
    ):
        if is_input_email(email):
            user_id = await get_user_using_email(email)
            if user_id is not None:
                supertokens_user = await get_user(user_id)
                if supertokens_user is not None:
                    login_method = next(
                        (
                            lm
                            for lm in supertokens_user.login_methods
                            if lm.recipe_user_id.get_as_string() == user_id
                            and lm.recipe_id == "emailpassword"
                        ),
                        None,
                    )
                    if login_method is not None:
                        assert login_method.email is not None
                        email = login_method.email
        return await og_sign_in(
            email,
            password,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            user_context,
        )

    original.sign_in = sign_in
    return original

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            sign_up_feature=InputSignUpFeature(
                form_fields=[
                    # from previous code snippets...
                ]
            ),
            override=InputOverrideConfig(
                # apis=..., from previous code snippet
                functions=recipe_override
            ),
        )
    ],
)
```

</Tab>
</Tabs>

### 4. Allow username or email during password reset

The password reset flow requires the user to have added an email during sign up.
If there is no email associated with the user, return an appropriate message. 

To update the functionality you have to first change how the password reset token gets generated and then update the email sending logic.
This way both methods take into account the new fields.

#### 4.1 Override the token generation API

The user should enter either their username or their email when starting the password reset flow.
Like the sign in customization, you must check if the input is an email and, if it is, retrieve the username associated with the email.
If you can't find a username from an email you have to return an appropriate message to the frontend.

<Tabs>
<Tab value="nodejs">

```tsx

let emailUserMap: { [key: string]: string } = {}

async function getUserUsingEmail(email: string): Promise<string | undefined> {
    // TODO: Check your database for if the email is associated with a user
    // and return that user ID if it is.

    // this is just a placeholder implementation
    return emailUserMap[email];
}

async function saveEmailForUser(email: string, userId: string) {
    // TODO: Save email and userId mapping

    // this is just a placeholder implementation
    emailUserMap[email] = userId
}

function isInputEmail(input: string): boolean {
    return input.match(
        /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
    ) !== null;
}

// highlight-start
async function getEmailUsingUserId(userId: string) {
    // TODO: check your database mapping..

    // this is just a placeholder implementation
    let emails = Object.keys(emailUserMap)
    for (let i = 0; i < emails.length; i++) {
        if (emailUserMap[emails[i]] === userId) {
            return emails[i]
        }
    }
    return undefined;
}
// highlight-end

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            override: {
                functions: (original) => {
                    return {
                        ...original,
                        // ...override from previous code snippet...
                    }
                },
                apis: (original) => {
                    return {
                        ...original,
                        // ...override from previous code snippet...
                        // highlight-start
                        generatePasswordResetTokenPOST: async function (input) {
                            let emailOrUsername = input.formFields.find(i => i.id === "email")!.value as string;
                            if (isInputEmail(emailOrUsername)) {
                                let userId = await getUserUsingEmail(emailOrUsername);
                                if (userId !== undefined) {
                                    let superTokensUser = await SuperTokens.getUser(userId);
                                    if (superTokensUser !== undefined) {
                                        // we find the right login method for this user
                                        // based on the user ID.
                                        let loginMethod = superTokensUser.loginMethods.find(lM => lM.recipeUserId.getAsString() === userId && lM.recipeId === "emailpassword");
                                        if (loginMethod !== undefined) {
                                            // we replace the input form field's array item
                                            // to contain the username instead of the email.
                                            input.formFields = input.formFields.filter(i => i.id !== "email")
                                            input.formFields = [...input.formFields, {
                                                id: "email",
                                                value: loginMethod.email!
                                            }]
                                        }
                                    }
                                }
                            }

                            let username = input.formFields.find(i => i.id === "email")!.value as string;
                            let superTokensUsers: supertokensTypes.User[] = await SuperTokens.listUsersByAccountInfo(input.tenantId, {
                                email: username
                            });
                            // from the list of users that have this email, we now find the one
                            // that has this email with the email password login method.
                            let targetUser = superTokensUsers.find(u => u.loginMethods.find(lM => lM.hasSameEmailAs(username) && lM.recipeId === "emailpassword") !== undefined);

                            if (targetUser !== undefined) {
                                if ((await getEmailUsingUserId(targetUser.id)) === undefined) {
                                    return {
                                        status: "GENERAL_ERROR",
                                        message: "You need to add an email to your account for resetting your password. Please contact support."
                                    }
                                }
                            }
                            return original.generatePasswordResetTokenPOST!(input);
                        },
                        // highlight-end
                    }
                }
            },
            signUpFeature: {
                formFields: [ /* ... from previous code snippet ... */]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go
	if err != nil || !emailCheck {
		return false
	}
	return true
}

// highlight-start
func getEmailUsingUserId(userId string) (*string, error) {
	for email, mappedUserId := range emailUserMap {
		if mappedUserId == userId {
			return &email, nil
		}
	}
	return nil, nil
}
// highlight-end

func main() {

	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			emailpassword.Init(&epmodels.TypeInput{
				SignUpFeature: &epmodels.TypeInputSignUp{
					FormFields: []epmodels.TypeInputFormField{ /*...from previous code snippet...*/ },
				},
				Override: &epmodels.OverrideStruct{
					APIs: func(originalImplementation epmodels.APIInterface) epmodels.APIInterface {
						// ...override sign up API from previous code snippet...

						// highlight-start
						ogGeneratePasswordResetTokenPOST := *originalImplementation.GeneratePasswordResetTokenPOST

						(*originalImplementation.GeneratePasswordResetTokenPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.GeneratePasswordResetTokenPOSTResponse, error) {
							emailOrUsername := ""
							for _, field := range formFields {
								if field.ID == "email" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									emailOrUsername = valueAsString
								}
							}
							if isInputEmail(emailOrUsername) {
								userId, err := getUserUsingEmail(emailOrUsername)
								if err != nil {
									return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
								}
								if userId != nil {
									supertokensUser, err := emailpassword.GetUserByID(*userId)
									if err != nil {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
									}
									if supertokensUser != nil {
										// we replace the input form field's array item
										// to contain the username instead of the email.
										newFormFields := []epmodels.TypeFormField{}
										for _, field := range formFields {
											if field.ID == "email" {
												newFormFields = append(newFormFields, epmodels.TypeFormField{
													ID:    "email",
													Value: supertokensUser.Email,
												})
											} else {
												newFormFields = append(newFormFields, field)
											}
										}
										formFields = newFormFields
									}
								}
							}

							username := ""
							for _, field := range formFields {
								if field.ID == "email" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									username = valueAsString
								}
							}
							supertokensUser, err := emailpassword.GetUserByEmail(tenantId, username)
							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}
							if supertokensUser != nil {
								email, err := getEmailUsingUserId(supertokensUser.ID)
								if err != nil {
									return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
								}
								if email == nil {
									return epmodels.GeneratePasswordResetTokenPOSTResponse{
										GeneralError: &supertokens.GeneralErrorResponse{
											Message: "You need to add an email to your account for resetting your password. Please contact support.",
										},
									}, nil
								}
							}

							return ogGeneratePasswordResetTokenPOST(formFields, tenantId, options, userContext)
						}
						// highlight-end

						return originalImplementation
					},
					Functions: func(originalImplementation epmodels.RecipeInterface) epmodels.RecipeInterface {
						// ...override from previous code snippet...
						return originalImplementation
					},
				},
			}),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from re import fullmatch
from typing import Any, Dict, List

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import get_user, list_users_by_account_info
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.emailpassword.utils import (
    InputOverrideConfig,
    InputSignUpFeature,
)
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.types.base import AccountInfoInput

email_user_map: Dict[str, str] = {}

async def get_user_using_email(email: str):
    # TODO: Check your database for if the email is associated with a user
    # and return that user ID if it is.

    # this is just a placeholder implementation
    if email in email_user_map:
        return email_user_map[email]
    return None

async def save_email_for_user(email: str, user_id: str):
    # TODO: Save email and userId mapping

    # this is just a placeholder implementation
    email_user_map[email] = user_id

def is_input_email(email: str):
    return (
        fullmatch(
            r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
            email,
        )
        is not None
    )

# highlight-start
async def get_email_using_user_id(user_id: str):
    for email in email_user_map:
        if email_user_map[email] == user_id:
            return email
    return None

def apis_override(original: APIInterface):
    og_generate_password_reset_token_post = original.generate_password_reset_token_post

    async def generate_password_reset_token_post(
        form_fields: List[FormField],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        email_or_username = ""
        for field in form_fields:
            if field.id == "email":
                email_or_username = field.value
        if is_input_email(email_or_username):
            user_id = await get_user_using_email(email_or_username)
            if user_id is not None:
                supertokens_user = await get_user(user_id)
                if supertokens_user is not None:
                    # we find the right login method for this user
                    # based on the user ID.
                    login_method = next(
                        (
                            lm
                            for lm in supertokens_user.login_methods
                            if lm.recipe_user_id == user_id
                            and lm.recipe_id == "emailpassword"
                        ),
                        None,
                    )
                    if login_method is not None:
                        # we replace the input form field's array item
                        # to contain the username instead of the email.
                        form_fields = [
                            field for field in form_fields if field.id != "email"
                        ]
                        form_fields.append(
                            FormField(id="email", value=login_method.email)
                        )

        username = ""
        for field in form_fields:
            if field.id == "email":
                username = field.value
        supertokens_user = await list_users_by_account_info(
            tenant_id, AccountInfoInput(email=username)
        )
        target_user = next(
            (
                u
                for u in supertokens_user
                if any(
                    lm.email == username and lm.recipe_id == "emailpassword"
                    for lm in u.login_methods
                )
            ),
            None,
        )
        if target_user is not None:
            if (await get_email_using_user_id(target_user.id)) is None:
                return GeneralErrorResponse(
                    "You need to add an email to your account for resetting your password. Please contact support."
                )

        return await og_generate_password_reset_token_post(
            form_fields, tenant_id, api_options, user_context
        )

    original.generate_password_reset_token_post = generate_password_reset_token_post
    return original

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            sign_up_feature=InputSignUpFeature(
                form_fields=[
                    # from previous code snippets...
                ]
            ),
            override=InputOverrideConfig(
                # functions=..., from previous code snippet
                apis=apis_override
            ),
        )
    ],
)
```

</Tab>
</Tabs>

#### 4.2 Override the email sending API

Update the email sending API to retrieve the user email if the user used a username in the password reset flow.

<Tabs>
<Tab value="nodejs">

```tsx

let emailUserMap: {[key: string]: string} = {}

async function getUserUsingEmail(email: string): Promise<string | undefined> {
    // TODO: Check your database for if the email is associated with a user
    // and return that user ID if it is.
    
    // this is just a placeholder implementation
    return emailUserMap[email];
}

async function saveEmailForUser(email: string, userId: string) {
    // TODO: Save email and userId mapping

    // this is just a placeholder implementation
    emailUserMap[email] = userId
}

function isInputEmail(input: string): boolean {
    return input.match(
        /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
    ) !== null;
}

async function getEmailUsingUserId(userId: string) {
    // TODO: check your database mapping..

    // this is just a placeholder implementation
    let emails = Object.keys(emailUserMap)
    for (let i = 0; i < emails.length; i++) {
        if (emailUserMap[emails[i]] === userId) {
            return emails[i]
        }
    }
    return undefined;
}

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            override: {
                /* ...from previous code snippets...  */
            },
            signUpFeature: {
                formFields: [ /* ... from previous code snippet ... */]
            },
            // highlight-start
            emailDelivery: {
                override: (original) => {
                    return {
                        ...original,
                        sendEmail: async function (input) {
                            input.user.email = (await getEmailUsingUserId(input.user.id))!;
                            return original.sendEmail(input)
                        }
                    }
                }
            },
            // highlight-end
        })
    ]
});
```

</Tab>
<Tab value="go">

```go
	if err != nil || !emailCheck {
		return false
	}
	return true
}

func getEmailUsingUserId(userId string) (*string, error) {
	for email, mappedUserId := range emailUserMap {
		if mappedUserId == userId {
			return &email, nil
		}
	}
	return nil, nil
}

func main() {

	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			emailpassword.Init(&epmodels.TypeInput{
				SignUpFeature: &epmodels.TypeInputSignUp{
					FormFields: []epmodels.TypeInputFormField{ /*...from previous code snippet...*/ },
				},
				Override: &epmodels.OverrideStruct{
					APIs: func(originalImplementation epmodels.APIInterface) epmodels.APIInterface {
						// ...override from previous code snippet...
						return originalImplementation
					},
					Functions: func(originalImplementation epmodels.RecipeInterface) epmodels.RecipeInterface {
						// ...override from previous code snippet...
						return originalImplementation
					},
				},
				// highlight-start
				EmailDelivery: &emaildelivery.TypeInput{
					Override: func(originalImplementation emaildelivery.EmailDeliveryInterface) emaildelivery.EmailDeliveryInterface {
						ogSendEmail := *originalImplementation.SendEmail
						(*originalImplementation.SendEmail) = func(input emaildelivery.EmailType, userContext supertokens.UserContext) error {
							email, err := getEmailUsingUserId(input.PasswordReset.User.ID)
							if err != nil {
								return err
							}
							input.PasswordReset.User.Email = *email
							return ogSendEmail(input, userContext)
						}
						return originalImplementation
					},
				},
				// highlight-end
			}),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from re import fullmatch
from typing import Any, Dict

from supertokens_python import InputAppInfo, init
from supertokens_python.ingredients.emaildelivery.types import EmailDeliveryConfig
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.types import (
    EmailDeliveryOverrideInput,
    EmailTemplateVars,
)
from supertokens_python.recipe.emailpassword.utils import (
    InputOverrideConfig,
    InputSignUpFeature,
)

email_user_map: Dict[str, str] = {}

async def get_user_using_email(email: str):
    # TODO: Check your database for if the email is associated with a user
    # and return that user ID if it is.

    # this is just a placeholder implementation
    if email in email_user_map:
        return email_user_map[email]
    return None

async def save_email_for_user(email: str, user_id: str):
    # TODO: Save email and userId mapping

    # this is just a placeholder implementation
    email_user_map[email] = user_id

def is_input_email(email: str):
    return fullmatch(
        r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
        email
    ) is not None

async def get_email_using_user_id(user_id: str):
    for email in email_user_map:
        if email_user_map[email] == user_id:
            return email
    return None

# highlight-start
def custom_email_deliver(original_implementation: EmailDeliveryOverrideInput) -> EmailDeliveryOverrideInput:
    original_send_email = original_implementation.send_email

    async def send_email(template_vars: EmailTemplateVars, user_context: Dict[str, Any]) -> None:
        actual_email = await get_email_using_user_id(template_vars.user.id)
        if actual_email is None:
            raise Exception("Should never come here")
        template_vars.user.email = actual_email
        return await original_send_email(template_vars, user_context)

    original_implementation.send_email = send_email
    return original_implementation
# highlight-end

init(
    app_info=InputAppInfo(
        api_domain="...", app_name="...", website_domain="..."),
    framework='...',  # type: ignore
    recipe_list=[
        emailpassword.init(
            sign_up_feature=InputSignUpFeature(form_fields=[
                # from previous code snippets...
            ]),
            override=InputOverrideConfig(
                # functions=..., from previous code snippet
                # apis=..., from previous code snippet
            ),
            # highlight-next-line
            email_delivery=EmailDeliveryConfig(override=custom_email_deliver)
        )
    ]
)
```

</Tab>
</Tabs>

### 5. Show the new fields in the user interface

:::info
The following instructions are only relevant if you are using the pre-built UI.
If you created your own custom UI on the frontend, please make sure to pass the new email `formField` when you call the sign up function.
Even if the user has not given an email, you must add it with an empty string.
:::

Update the pre-built UI to reflect the new flow:
- Skip frontend validation for the `email` field since username or email is permissible. The backend performs those checks.
- Change the "Email" label in the sign up form to say "Username".
- Add an extra field in the sign up form where the user can enter their email.
- Change the "Email" label in the sign in form to say "Username or email".
- Change the "Email" label in the password reset form to say "Username or email".
- Update translations for the email field if necessary.

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-start
    languageTranslations: {
        translations: {
            "en": {
                EMAIL_PASSWORD_EMAIL_LABEL: "Username or email"
            }
        }
    },
    // highlight-end
    recipeList: [
        EmailPassword.init({
            signInAndUpFeature: {
                // highlight-start
                signInForm: {
                    formFields: [{
                        id: "email",
                        label: "Username or email",
                        placeholder: "Username or email"
                    }]
                },
                signUpForm: {
                    formFields: [{
                        id: "email",
                        label: "Username",
                        placeholder: "Username",
                        validate: async (input) => {
                            // the backend validates this anyway. So nothing required here
                            return undefined;
                        }
                    }, {
                        id: "actualEmail",
                        validate: async (input) => {
                            // the backend validates this anyway. So nothing required here
                            return undefined
                        },
                        label: "Email",
                        optional: true
                    }]
                }
                // highlight-end
            }
        }),
        // other recipes initialisation.. 
    ],
});
```


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-in-form" label="Customize the sign in form" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-up-form" label="Customize the sign up form" />
  <ReferenceCard href="/docs/authentication/email-password/password-hashing" label="Password Hashing" />
  <ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/email-password/password-reset" label="Password reset" />
</ReferenceCard.Grid>

# Authentication - Email Password -  Password reset
Source: https://supertokens.com/docs/authentication/email-password/password-reset

## Overview

The password reset feature consists of two actions: one in which a user requests a reset password link over email and another where the user sets the new password.

### The password reset forms



<PrebuiltUIInstructions>

The following images show how the password reset forms render when you are using the pre-built UI.

<Tabs values={[{ label: "Reset Password Form", value: "reset-password" }, { label: "Change Password Form", value: "change-password" }]}>

<TabItem value="reset-password">

You see this if you navigate to `<WEBSITE_BASE_PATH>/reset-password`.
 
<Flex direction="column" align="center">
<img alt="UI to send password reset email" width="500px" src="/img/emailpassword/reset-password-enter-email.png" />
  </Flex>

</TabItem>

<TabItem value="change-password">
You see this if you navigate to `/auth/reset-password?token=TOKEN`.
 
<Flex direction="column" align="center">
<img alt="UI to change password" width="500px" src="/img/emailpassword/reset-password-submit-new-password.png" />
</Flex>
</TabItem>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

To implement your own interface create two different forms:
- One where the user requests a password reset link.
- Another one where the user changes their password.

Use the pre-built UI components as a reference.

</CustomUIInstructions>

### The password reset email 

This is how the email that gets delivered to the learner looks like:

<img alt="Email UI for password reset email" width="450px" src="/img/emailpassword/pass-reset-email.png" />

You can find the [source code of this template on GitHub](https://github.com/supertokens/email-sms-templates/blob/master/email-html/password-reset.html).
To customize the template check the [email delivery](/docs/platform-configuration/email-delivery) section for more information.

---

## Embed the reset form in a page

To embed the reset form in a page you can use the next steps.

<PrebuiltUIInstructions>

### 1. Disable the default implementation 

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            resetPasswordUsingTokenFeature: {
                disableDefaultUI: true
            },
            // highlight-end
        }),
    ]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            // highlight-start
            resetPasswordUsingTokenFeature: {
                disableDefaultUI: true
            },
            // highlight-end
        }),
    ]
});
```

</Tab>
</Tabs>

If you navigate to `/auth/reset-password`, you should not see the widget anymore.

### 2. Render the component yourself 

Add the `ResetPasswordUsingToken` component in your app:

<Tabs>
<Tab value="reactjs">

```tsx

class ResetPasswordPage extends React.Component {
    render() {
        return (
            <div>
                // highlight-next-line
                <ResetPasswordUsingToken/> 
            </div>
        )
    }
}
```
</Tab>

<Tab value="angular">

:::caution
You have to build your own UI for this.
:::

</Tab>
</Tabs>

</PrebuiltUIInstructions>
<CustomUIInstructions>

:::caution
Not applicable since you do not use pre-built UI.
:::

</CustomUIInstructions>

### 3. Change the website path for reset password UI 

This step is optional.
The default path for this is component is `<WEBSITE_BASE_PATH>/reset-password`.

If you are displaying this at some custom path, then you need to add additional configuration on the backend and frontend:

#### 3.1 On the backend

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: { 
        connectionURI: "...",
     },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail: async function (input) {
                            if (input.type === "PASSWORD_RESET") {
                                return originalImplementation.sendEmail({
                                    ...input,
                                    passwordResetLink: input.passwordResetLink.replace(
                                        // This is: `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/reset-password`
                                        "http://localhost:3000/auth/reset-password",
                                        "http://localhost:3000/your/path"
                                        )
                                })
                            }
                            return originalImplementation.sendEmail(input);
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        EmailPassword.init({
            //highlight-start

            // The user will be taken to the custom path when they click on forgot password.
            getRedirectionURL: async (context) => {
                if (context.action === "RESET_PASSWORD") {
                    return "/custom-reset-password-path";
                };
            }
            //highlight-end
        })
    ]
})
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            //highlight-start

            // The user will be taken to the custom path when they click on forgot password.
            getRedirectionURL: async (context) => {
                if (context.action === "RESET_PASSWORD") {
                    return "/custom-reset-password-path";
                };
            }
            //highlight-end
        })
    ]
})
```

</Tab>
</Tabs>

</PrebuiltUIInstructions>
<CustomUIInstructions>

:::caution
Not applicable since you do not use pre-built UI.
:::

</CustomUIInstructions>

## Generate a reset link manually

You can use the backend SDK to generate the reset password link as shown below:

<Tabs>
<Tab value="nodejs">

```tsx

async function createResetPasswordLink(userId: string, email: string) {
    const linkResponse = await EmailPassword.createResetPasswordLink("public", userId, email);

    if (linkResponse.status === "OK") {
        console.log(linkResponse.link);
    } else {
        // user does not exist or is not an email password user
    }
}
```

</Tab>
<Tab value="go">

```go

:::

---

## Change the reset's link lifetime

By default, the password reset link's lifetime is 1 hour. You can change this via a core's configuration (time in milliseconds):

<Tabs>
<Tab value="with-docker">

```bash
# Here we set the lifetime to 2 hours.

docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e EMAIL_VERIFICATION_TOKEN_LIFETIME=7200000 \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

email_verification_token_lifetime: 7200000
```

</Tab>
</Tabs>

:::info
- For managed service, you can update these values by visiting the dashboard.
- This requires that your SuperTokens core version >= `3.6.0`
:::

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/password-hashing" label="Password hashing" />
  <ReferenceCard href="/docs/authentication/email-password/password-managers" label="Password managers" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-in-form" label="Customize the sign in form" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-up-form" label="Customize the sign up form" />
  <ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Email Password -  Disable the Sign Up Flow
Source: https://supertokens.com/docs/authentication/email-password/disable-signup

<DescriptionText>
  Learn how to disable the sign up flow for the `EmailPassword` recipe.
</DescriptionText>

<Separator />

## Overview

In order to prevent users from signing up directly through the frontend, you can disable the sign up flow.
This can be done in two steps:
- Update the **UI** to get rid of any sign up information
- Change the **Backend SDK** to prevent sign up attempts

## Before you start

This guide assumes that you already have configured your application to use **SuperTokens** for authentication.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

## Remove the sign up UI



<PrebuiltUIInstructions>

<Tabs exclude={["mobile"]}>

<Tab value="reactjs">

Remove the sign up UI by overriding the `AuthPageComponentList` component and setting the `showSuperTokensAuth` prop to `false`.

```tsx

function App() {
    return (
        <SuperTokensWrapper>
            <AuthRecipeComponentsOverrideContextProvider
                components={{
                    AuthPageComponentList_Override: ({ DefaultComponent, ...props }) => {
                        return <DefaultComponent {...props} hasSeparateSignUpView={false} />;
                    },
                }}>
            </AuthRecipeComponentsOverrideContextProvider>
        </SuperTokensWrapper>
    );
}

export default App;
```

</Tab>

<Tab value="angular">

Remove the sign up UI by customizing the `CSS` of the authentication page. 

```tsx
// this goes in the auth route config of your frontend app (once the pre built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    style: `
        [data-supertokens~=authPage] [data-supertokens~=headerSubtitle] {
            display: none;
        }
    `,
    recipeList: [ /* ... */]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

If you have a custom UI, this step will depend on your implementation.
Just make sure that the user will not be able to view any sign up elements on the authentication page.

</CustomUIInstructions>

## Disable the Backend SDK sign up endpoints

Override the **Backend SDK** API functions to prevent sign up attempts.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // highlight-next-line
                        signUpPOST: undefined,
                    }
                }
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go

# Authentication - Email Password -  Password managers
Source: https://supertokens.com/docs/authentication/email-password/password-managers

## Overview 

Styling encapsulation relies on the ["shadow DOM" browser feature](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM).
Password managers such as Dashlane, LastPass, or OnePassword do not detect authentication forms fields inside shadow DOMs.
Therefore, if you would like to make sure that your end users can use their password managers, you have to disable shadow DOM. 

:::info no-title
These instructions are only relevant if you are using the pre-built UI components.
:::

<Tabs exclude={["mobile"]}>
<Tab value="reactjs">

```tsx preview="/img/emailpassword/password-manager.png" previewAlt="Demo of a password manager working with prebuilt UI when shadow DOM is not active"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    useShadowDom: false,
    recipeList: [ /* ... */]
});
```

</Tab>
<Tab value="angular">

```tsx preview="/img/emailpassword/password-manager.png" previewAlt="Demo of a password manager working with prebuilt UI when shadow DOM is not active"
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    useShadowDom: false,
    recipeList: [ /* ... */]
});
```

</Tab>
</Tabs>

:::caution
- SuperTokens uses a special attribute to define its styling. Disabling shadow DOM should not impact the rest of your application's styles. Verify that your CSS does not impact how SuperTokens UI appears when disabling Shadow DOM.
- Shadow DOM is always disabled with Internet Explorer since it does not support it. Similarly, if you intend to support Internet Explorer for your application make sure to verify how SuperTokens UI appears.
:::


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/email-password/password-hashing" label="Password hashing" />
  <ReferenceCard href="/docs/authentication/email-password/password-reset" label="Password reset" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-in-form" label="Customize the sign in form" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-up-form" label="Customize the sign up form" />
  <ReferenceCard href="/docs/authentication/email-password/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Passwordless -  Initial setup
Source: https://supertokens.com/docs/authentication/passwordless/initial-setup

## Overview

This page shows you how to add the **Passwordless** `recipe` to your project.
The tutorial creates a login flow, rendered by either the **Prebuilt UI** components or by your own **Custom UI**.

## Before you start

:::important

These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page please follow the tutorial and return here once you're done.

:::

### Terminology

Before going into the actual steps lets first talk about two terms that influence how you configure the **Passwordless** recipe.
- **Contact Method**: This defines how the user receives the credentials from your app. You can choose between `email`, `phone number` or both (the user has to choose one during the login flow).
- **Flow Type**: This is the actual credential type used for authentication. You can choose between **Magic Link**, **OTP** (One-Time Password), or both (the user has to choose one during the login flow).

## Steps



<PrebuiltUIInstructions>

### 1. Initialize the frontend SDK

<Tabs showMobileTab>
  <Tab value="reactjs">

#### 1.1 Add the `Passwordless` recipe in your main configuration file.
  <PasswordlessConfigCard>

```tsx

// highlight-start
// highlight-end

SuperTokens.init({
    appInfo: { 
        // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
// highlight-start
        Passwordless.init({
            contactMethod: "^{recipes.passwordless.contactMethod}"
        }),
// highlight-end
        Session.init()
    ]
});
```

</PasswordlessConfigCard>

#### 1.2 Include the pre-built UI components in your application.

To render the **Pre-Built UI** inside your application, you need to specify which routes show the authentication components.
The **React SDK** uses [**React Router**](https://reactrouter.com/en/main) under the hood to achieve this.
Based on whether you already use this package or not in your project, there are two different ways of configuring the routes.

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">
  <Answer title="Yes">
```tsx

// highlight-next-line

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        {/*This renders the login UI on the <WEBSITE_BASE_PATH> route*/}
                        // highlight-next-line
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [PasswordlessPreBuiltUI])}
                        {/*Your app routes*/}
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```

        :::important
If you are using `useRoutes`, `createBrowserRouter` or have routes defined in a different file, you need to adjust the code sample.
Please see [this issue](https://github.com/supertokens/supertokens-auth-react/issues/581#issuecomment-1246998493) for further details.
```tsx

function AppRoutes() {
  const authRoutes = getSuperTokensRoutesForReactRouterDom(
    reactRouterDom,
    [/* Add your UI recipes here e.g. EmailPasswordPrebuiltUI, PasswordlessPrebuiltUI, ThirdPartyPrebuiltUI */]
  );

  const routes = useRoutes([
    ...authRoutes.map(route => route.props),
    // Include the rest of your app routes 
  ]);

  return routes;
}

function App() {
  return (
    <SuperTokensWrapper>
      <BrowserRouter>
          <AppRoutes />
      </BrowserRouter>
    </SuperTokensWrapper>
  );
}
```
:::

  </Answer>
  <Answer title="No">

```tsx

class App extends React.Component {
    render() {
        // highlight-start
        if (canHandleRoute([PasswordlessPreBuiltUI])) {
            // This renders the login UI on the <WEBSITE_BASE_PATH> route
            return getRoutingComponent([PasswordlessPreBuiltUI])
        }
        // highlight-end

        return (
            <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
        );
    }

}
```
  </Answer>
</Question>

  </Tab>
  <Tab value="angular">

  <PasswordlessConfigCard>
      <PasswordlessConfigCard.Section>
Add the `Passwordless` recipe in your `AuthComponent`.
        </PasswordlessConfigCard.Section>

    ```tsx title="/app/auth/auth.component.ts"

    @Component({
        selector: "app-auth",
        template: '<div id="supertokensui"></div>',
    })
    export class AuthComponent implements OnDestroy, AfterViewInit {

        constructor(
            private renderer: Renderer2,
            @Inject(DOCUMENT) private document: Document
        ) { }

        ngAfterViewInit() {
            this.loadScript('^{prebuiltUIVersion}');
        }

        ngOnDestroy() {
            // Remove the script when the component is destroyed
            const script = this.document.getElementById('supertokens-script');
            if (script) {
                script.remove();
            }
        }

        private loadScript(src: string) {
            const script = this.renderer.createElement('script');
            script.type = 'text/javascript';
            script.src = src;
            script.id = 'supertokens-script';
            script.onload = () => {
                supertokensUIInit({
                    appInfo: {
                        // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration
                        appName: "<APP_NAME>",
                        apiDomain: "<API_DOMAIN>",
                        websiteDomain: "<WEBSITE_DOMAIN>",
                        apiBasePath: "<API_BASE_PATH>",
                        websiteBasePath: "<WEBSITE_BASE_PATH>",
                    },
                    recipeList: [
// highlight-start
                        supertokensUIPasswordless.init({
                            contactMethod: "^{recipes.passwordless.contactMethod}"
                        }),
// highlight-end
                        supertokensUISession.init(),
                    ],
                });
            }
            this.renderer.appendChild(this.document.body, script);
        }
    }
    ```

  </PasswordlessConfigCard>

  </Tab>
  <Tab value="vue">

  <PasswordlessConfigCard>

      <PasswordlessConfigCard.Section>
Add the `Passwordless` recipe in your `AuthView` file.
      </PasswordlessConfigCard.Section>

    ```tsx
    <script lang="ts">
        export default defineComponent({
            setup() {
                const loadScript = (src: string) => {
                    const script = document.createElement('script');
                    script.type = 'text/javascript';
                    script.src = src;
                    script.id = 'supertokens-script';
                    script.onload = () => {
                        supertokensUIInit({
                            appInfo: {
                                // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration
                                appName: "<APP_NAME>",
                                apiDomain: "<API_DOMAIN>",
                                websiteDomain: "<WEBSITE_DOMAIN>",
                                apiBasePath: "<API_BASE_PATH>",
                                websiteBasePath: "<WEBSITE_BASE_PATH>",
                            },
                            recipeList: [
// highlight-start
                                supertokensUIPasswordless.init({
                                    contactMethod: "^{recipes.passwordless.contactMethod}"
                                }),
// highlight-end
                                supertokensUISession.init(),
                            ],
                        });
                    };
                    document.body.appendChild(script);
                };

                onMounted(() => {
                    loadScript('^{prebuiltUIVersion}');
                });

                onUnmounted(() => {
                    const script = document.getElementById('supertokens-script');
                    if (script) {
                        script.remove();
                    }
                });
            },
        });
    </script>

    <template>
        <div id="supertokensui" />
    </template>
    ```

  </PasswordlessConfigCard>

  </Tab>

</Tabs>

### 2. Initialize the backend SDK

You need to initialize the **Backend SDK** alongside the code that starts your server.
The init call includes [configuration details](/docs/references/backend-sdks/reference#sdk-configuration) for your app. It specifies how the backend connects to the **SuperTokens Core**, as well as the **Recipes** used in your setup.

For the **Passwordless** recipe, you also need to specify the `flowType` and `contactMethod`.
Click one of the options from the next form and the code snippet updates.

<Tabs>

<Tab value="nodejs">

<PasswordlessConfigCard showFlowType>

```tsx title="Backend SDK Init" showAppTypeSelect
// highlight-next-line

supertokens.init({
    // Replace this with the framework you are using
    framework: "express",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "^{recipes.passwordless.flowType}",
            contactMethod: "^{recipes.passwordless.contactMethod}"
        }),
        // highlight-end
        Session.init() 
    ]
});
```

</PasswordlessConfigCard>

</Tab>

<Tab value="python">

<PasswordlessConfigCard showFlowType>

```python title="Backend SDK Init" showAppTypeSelect
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import passwordless, session
# highlight-next-line
^{derived.pythonContactMethodImport}

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='fastapi',
    recipe_list=[
        session.init(), # initializes session features
        passwordless.init(
            flow_type="^{recipes.passwordless.flowType}",
            contact_config=^{derived.pythonContactMethodMethod}()
        )
    ],
    mode='asgi' # use wsgi if you are running using gunicorn
)
```

</PasswordlessConfigCard>

</Tab>

<Tab value="go">

<PasswordlessConfigCard showFlowType>

```go title="Backend SDK Init" showAppTypeSelect

</PrebuiltUIInstructions>

<CustomUIInstructions>

### 1. Initialize the frontend SDK

Call the SDK init function at the start of your application.
The invocation includes the [main configuration details](/docs/references/frontend-sdks/reference#sdk-configuration), as well as the **recipes** that you use in your setup.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        Passwordless.init(),
    ],
});
```

</Tab>

<Tab value="scripts">

<Tabs.Section>

First, you need to add the recipe script tag.

```html
<script src="^{webJsVersions.passwordless}"></script>
```

You can initialize the SDK

</Tabs.Section>

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init(),
        supertokensPasswordless.init(),
    ],
});
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

SuperTokens.init({
    apiDomain: "<API_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
});
```

</Tab>

<Tab value="android">

Add the `SuperTokens.init` function call at the start of your application.

```kotlin

void main() {
    SuperTokens.init(
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
    );
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

### 2. Add the login UI

<Tabs
  defaultValue="magic-link"
  values={[
    { label: "Magic Link", value: "magic-link"},
    { label: "OTP", value: "otp"}
  ]}
  lazy={true}
>
  
<TabItem  value="magic-link" >

The following section shows you what aspects you need to cover to implement the UI for a `Magic Link` flow.
The same flow applies during either sign up or sign in.
This guide shows you how to determine if the system creates a new user in the next steps.

#### 2.1 Sending the Magic link

You need to add a form that asks the user for their email address or phone number.
When the user submits the form, you need to call the following API to create and send them a **Magic Link**.

:::info

You configure the contact method on the next page, where you discuss the process of adding the `SDK` to your backend app.

:::

<Tabs>

<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function sendMagicLink(email: string) {
    try {
        let response = await createCode({
            email
        });
        /**
         * For phone number, use this:
            
            let response = await createCode({
                phoneNumber: "+1234567890"
            });
         
        */

        if (response.status === "SIGN_IN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else {
            // Magic link sent successfully.
            window.alert("Please check your email for the magic link");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you,
            // or if the input email / phone number is not valid.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function sendMagicLink(email: string) {
    try {
        let response = await supertokensPasswordless.createCode({
            email
        });
        /**
         * For phone number, use this:
            
            let response = await supertokens^{recipeNameCapitalLetters}.createCode({
                phoneNumber: "+1234567890"
            });
         
        */

        if (response.status === "SIGN_IN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else {
            // Magic link sent successfully.
            window.alert("Please check your email for the magic link");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you,
            // or if the input email / phone number is not valid.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

For email based login

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "email": "johndoe@gmail.com"
}'
```

For phone number based login
```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "phoneNumber": "+1234567890"
}'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: This means that the magic link was successfully sent.
- `status: "GENERAL_ERROR"`: This is possible if you have overridden the backend API to send back a custom error message which should display on the frontend, or if the input email or password failed the backend validation logic.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during multi-factor authentication (MFA). The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

The response from the API call is the following object (in case of `status: "OK"`):
```json
{
    status: "OK";
    deviceId: string;
    preAuthSessionId: string;
    flowType: "USER_INPUT_CODE" | "MAGIC_LINK" | "USER_INPUT_CODE_AND_MAGIC_LINK";
    fetchResponse: Response; // raw fetch response from the API call
}
```

You want to save the `deviceId` and `preAuthSessionId` on the frontend storage. These are useful to:
- Resend a new magic link.
- Detect if the user has already sent a magic link before or if this is an entirely new login attempt. This distinction can be important if you have different UI for these two states. For example, if this info already exists, you do not want to show the user an input box to enter their email / phone, and instead want to show them the resend link button.

</Tab>

</Tabs>

#### 2.2 Resending a magic link

After sending the initial magic link to the user, you may want to display a resend button to them.
When the user clicks on this button, you should call the following API

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function resendMagicLink() {
    try {
        let response = await resendCode();

        if (response.status === "RESTART_FLOW_ERROR") {
            // this can happen if the user has already successfully logged in into
            // another device whilst also trying to login to this one.

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        } else {
            // Magic link resent successfully.
            window.alert("Please check your email for the magic link");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function resendMagicLink() {
    try {
        let response = await supertokensPasswordless.resendCode();

        if (response.status === "RESTART_FLOW_ERROR") {
            // this can happen if the user has already successfully logged in into
            // another device whilst also trying to login to this one.

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await supertokensPasswordless.clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        } else {
            // Magic link resent successfully.
            window.alert("Please check your email for the magic link");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code/resend' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "deviceId": "...",
  "preAuthSessionId": "...."
}'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: This means that the magic link was successfully sent.
- `status: "RESTART_FLOW_ERROR"`: This can happen if the user has already successfully logged in into another device whilst also trying to login to this one. You want to take the user back to the login screen where they can enter their email / phone number again. Be sure to remove the stored `deviceId` and `preAuthSessionId` from the frontend storage.
- `status: "GENERAL_ERROR"`: This is possible if you have overridden the backend API to send back a custom error message which should display on the frontend.

</Tab>

</Tabs>

#### How to detect if the user is on step 2.1 or step 2.2?

If you are building the UI for both of the previous steps on the same page you might run into an issue when the user refreshes the page.
To prevent this you need a way to know which UI to show.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function hasInitialMagicLinkBeenSent() {
    return await getLoginAttemptInfo() !== undefined;
}
```

</Tab>
<Tab value="scripts">

```tsx
async function hasInitialMagicLinkBeenSent() {
    return await supertokensPasswordless.getLoginAttemptInfo() !== undefined;
}
```

</Tab>
</Tabs>

If `hasInitialMagicLinkBeenSent` returns `true`, it means that the user has already sent the initial magic link to themselves, and you can show the resend link UI. Else show a form asking them to enter their email / phone number.

</Tab>

<Tab value="mobile">

Since you save the `preAuthSessionId` and `deviceId` after sending the initial magic link, you can know if the user is on either **step 3.1** or **step 3.2**. Check if these tokens are on the device.

If they aren't, you should follow **step 3.1**, else follow **step 3.2**.

:::important
You need to clear these tokens if:
- the user navigates away from the **step 3.2** page
- you get a `RESTART_FLOW_ERROR` at any point in time from an API call
- the user has successfully logged in.
:::

</Tab>

</Tabs>

#### 2.3 Consuming the magic link

When a user clicks on a magic link, you first need to know if the action came from the same browser/device as the one that started the flow.
To do this you ca use this code sample.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function isThisSameBrowserAndDevice() {
    return await getLoginAttemptInfo() !== undefined;
}
```

</Tab>
<Tab value="scripts">

```tsx
async function isThisSameBrowserAndDevice() {
    return await supertokensPasswordless.getLoginAttemptInfo() !== undefined;
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

Since you save the `preAuthSessionId` and `deviceId`, you can check if they exist on the app. If they do, then it's the same device that the user has opened the link on, else it's a different device.

</Tab>

</Tabs>

:::important

Add a intermediate step if the user came from a different device.

:::

If the user clicked on a link from a different device, you need to show some kind of an intermediate UI.
This is to protect against email clients opening the magic link on their servers and consuming the link.

The page should require additional user interaction before consuming the magic link.
For example, you could show a button with the following text: `Click here to login into this device`.
On click, you can consume the magic link to log the user into that device.

With this understanding of how to avoid potential errors, proceed with the actual instructions on how to authenticate with the magic link.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function handleMagicLinkClicked() {
    try {
        let response = await consumeCode();

        if (response.status === "OK") {
            // we clear the login attempt info that was added when the createCode function 
            // was called since the login was successful.
            await clearLoginAttemptInfo();
            if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                // user sign up success
            } else {
                // user sign in success
            }
            window.location.assign("/home")
        } else {
            // this can happen if the magic link has expired or is invalid
            // or if it was denied due to security reasons in case of automatic account linking

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function handleMagicLinkClicked() {
    try {
        let response = await supertokensPasswordless.consumeCode();

        if (response.status === "OK") {
            // we clear the login attempt info that was added when the createCode function 
            // was called since the login was successful.
            await supertokensPasswordless.clearLoginAttemptInfo();
            if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                // user sign up success
            } else {
                // user sign in success
            }
            window.location.assign("/home")
        } else {
            // this can happen if the magic link has expired or is invalid
            // or if it was denied due to security reasons in case of automatic account linking

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await supertokensPasswordless.clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

You need to remove the `linkCode` and `preAuthSessionId` from the Magic link. For example, if the Magic link is 

```text
https://example.com/auth/verify?preAuthSessionId=PyIwyA6VjdjNF5ggMV960rs3QXupRP2PEg2KcN5oi8s=#s4hxpBPnRC3xwBsCkFU228lh_CWe5HUBMRPowajsrgs=
```

Then the `preAuthSessionId` is the value of the query parameter `preAuthSessionId` (`PyIwyA6VjdjNF5ggMV960rs3QXupRP2PEg2KcN5oi8s=` in the example), and the `linkCode` is the part after the `#` (`s4hxpBPnRC3xwBsCkFU228lh_CWe5HUBMRPowajsrgs=` in the example).

We can then use these to call the consume API

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code/consume' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "linkCode": "s4hxpBPnRC3xwBsCkFU228lh_CWe5HUBMRPowajsrgs=",
  "preAuthSessionId": "PyIwyA6VjdjNF5ggMV960rs3QXupRP2PEg2KcN5oi8s="
}'
```

:::info Multi Tenancy
For a multi-tenancy setup, the `<TENANT_ID>` value can fetch from the `tenantId` query parameter from the magic link. If it's not there in the link, you can use the value `"public"` (which is the default tenant).
:::

The response body from the API call has a `status` property in it:
- `status: "OK"`: User sign in / up was successful. The response also contains more information about the user, for example their user ID, and if it was a new user or existing user. 
- `status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" | "RESTART_FLOW_ERROR"`: These responses indicate that the Magic link was invalid or expired.
- `status: "GENERAL_ERROR"`: This is possible if you have overridden the backend API to send back a custom error message which should display on the frontend.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during multi-factor authentication (MFA). The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

</Tab>

</Tabs>

</TabItem>

<TabItem  value="otp">

The following section shows you what aspects you need to cover to implement the UI for a `OTP`, One-Time Password, flow.
The same flow applies during either sign up or sign in.
This guide shows you how to determine if you create a new user in the next steps.

#### 2.1 Creating and sending the OTP

You have to add a form that asks the user for their email address or phone number.
When the users submit the form you have to call the following API to create and send them an OTP.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function sendOTP(email: string) {
    try {
        let response = await createCode({
            email
        });
        /**
         * For phone number, use this:
            
            let response = await createPasswordlessCode({
                phoneNumber: "+1234567890"
            });
         
        */

        if (response.status === "SIGN_IN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else {
            // OTP sent successfully.
            window.alert("Please check your email for an OTP");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you,
            // or if the input email / phone number is not valid.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function sendOTP(email: string) {
    try {
        let response = await supertokensPasswordless.createCode({
            email
        });
        /**
         * For phone number, use this:
            
            let response = await supertokens^{recipeNameCapitalLetters}.createCode({
                phoneNumber: "+1234567890"
            });
         
        */

        if (response.status === "SIGN_IN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else {
            // OTP sent successfully.
            window.alert("Please check your email for an OTP");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you,
            // or if the input email / phone number is not valid.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

For email based login

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "email": "johndoe@gmail.com"
}'
```

For phone number based login
```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "phoneNumber": "+1234567890"
}'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: This means that the OTP was successfully sent.
- `status: "GENERAL_ERROR"`: This is possible if you have overridden the backend API to send back a custom error message which should display on the frontend, or if the input email or password failed the backend validation logic.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during `MFA`. The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

The response from the API call is the following object (in case of `status: "OK"`):
```json
{
    status: "OK";
    deviceId: string;
    preAuthSessionId: string;
    flowType: "USER_INPUT_CODE" | "MAGIC_LINK" | "USER_INPUT_CODE_AND_MAGIC_LINK";
    fetchResponse: Response; // raw fetch response from the API call
}
```

You want to save the `deviceId` and `preAuthSessionId` on the frontend storage. These are useful to:
- Resend a new OTP.
- Detect if the user has already sent an OTP before or if this is an entirely new login attempt. This distinction can be important if you have different UI for these two states. For example, if this info already exists, you do not want to show the user an input box to enter their email / phone, and instead want to show them the enter OTP form with a resend button.
- Verify the user's input OTP.

</Tab>

</Tabs>

#### 2.2 Resending a OTP

After you send the OTP to the user, you may want to display a resend button to them.
When the user clicks on this button, you should call the following API

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function resendOTP() {
    try {
        let response = await resendCode();

        if (response.status === "RESTART_FLOW_ERROR") {
            // this can happen if the user has already successfully logged in into
            // another device whilst also trying to login to this one.

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        } else {
            // OTP resent successfully.
            window.alert("Please check your email for the OTP");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function resendOTP() {
    try {
        let response = await supertokensPasswordless.resendCode();

        if (response.status === "RESTART_FLOW_ERROR") {
            // this can happen if the user has already successfully logged in into
            // another device whilst also trying to login to this one.

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await supertokensPasswordless.clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        } else {
            // OTP resent successfully.
            window.alert("Please check your email for the OTP");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code/resend' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "deviceId": "...",
  "preAuthSessionId": "...."
}'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: This means that the OTP was successfully sent.
- `status: "RESTART_FLOW_ERROR"`: This can happen if the user has already successfully logged in into another device whilst also trying to login to this one. You want to take the user back to the login screen where they can enter their email / phone number again. Be sure to remove the stored `deviceId` and `preAuthSessionId` from the frontend storage.
- `status: "GENERAL_ERROR"`: This is possible if you have overridden the backend API to send back a custom error message which should display on the frontend.

</Tab>

</Tabs>

#### How to detect if the user is on step 3.1 or step 3.2?

If you are building the UI for both of the previous steps on the same page you might run into an issue when the user refreshes the page.
To prevent this you need a way to know which UI to show.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function hasInitialOTPBeenSent() {
    return await getLoginAttemptInfo() !== undefined;
}
```

</Tab>
<Tab value="scripts">

```tsx
async function hasInitialOTPBeenSent() {
    return await supertokensPasswordless.getLoginAttemptInfo() !== undefined;
}
```

</Tab>
</Tabs>

If `hasInitialOTPBeenSent` returns `true`, it means that the user has already sent the initial OTP to themselves, and you can show the enter OTP form + resend OTP button 3.2. Else show a form asking them to enter their email / phone number 3.1.

</Tab>

<Tab value="mobile">

Since you save the `preAuthSessionId` and `deviceId` after you send the initial OTP, you can determine if the user is in step 3.1 or 3.2.
Check if you stored these tokens on the device.

If they aren't, you should follow 3.1, else follow 3.2.

:::important
You need to clear these tokens if:
- the user navigates away from the 3.2 page
- you get a `RESTART_FLOW_ERROR` at any point in time from an API call
- the user has successfully logged in.
:::

</Tab>

</Tabs>

#### 2.3 Verifying the OTP

When the user enters an OTP you have to call the following API to verify it

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function handleOTPInput(otp: string) {
    try {
        let response = await consumeCode({
            userInputCode: otp
        });

        if (response.status === "OK") {
            // we clear the login attempt info that was added when the createCode function 
            // was called since the login was successful.
            await clearLoginAttemptInfo();
            if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                // user sign up success
            } else {
                // user sign in success
            }
            window.location.assign("/home")
        } else if (response.status === "INCORRECT_USER_INPUT_CODE_ERROR") {
            // the user entered an invalid OTP
            window.alert("Wrong OTP! Please try again. Number of attempts left: " + (response.maximumCodeInputAttempts - response.failedCodeInputAttemptCount));
        } else if (response.status === "EXPIRED_USER_INPUT_CODE_ERROR") {
            // it can come here if the entered OTP was correct, but has expired because
            // it was generated too long ago.
            window.alert("Old OTP entered. Please regenerate a new one and try again");
        } else {
            // this can happen if the user tried an incorrect OTP too many times.
            // or if it was denied due to security reasons in case of automatic account linking

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function handleOTPInput(otp: string) {
    try {
        let response = await supertokensPasswordless.consumeCode({
            userInputCode: otp
        });

        if (response.status === "OK") {
            // we clear the login attempt info that was added when the createCode function 
            // was called since the login was successful.
            await supertokensPasswordless.clearLoginAttemptInfo();
            if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                // user sign up success
            } else {
                // user sign in success
            }
            window.location.assign("/home")
        } else if (response.status === "INCORRECT_USER_INPUT_CODE_ERROR") {
            // the user entered an invalid OTP
            window.alert("Wrong OTP! Please try again. Number of attempts left: " + (response.maximumCodeInputAttempts - response.failedCodeInputAttemptCount));
        } else if (response.status === "EXPIRED_USER_INPUT_CODE_ERROR") {
            // it can come here if the entered OTP was correct, but has expired because
            // it was generated too long ago.
            window.alert("Old OTP entered. Please regenerate a new one and try again");
        } else {
            // this can happen if the user tried an incorrect OTP too many times.
            // or if it was denied due to security reasons in case of automatic account linking

            // we clear the login attempt info that was added when the createCode function 
            // was called - so that if the user does a page reload, they will now see the 
            // enter email / phone UI again.
            await supertokensPasswordless.clearLoginAttemptInfo();
            window.alert("Login failed. Please try again");
            window.location.assign("/auth")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup/code/consume' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "deviceId": "...",
  "preAuthSessionId": "...",
  "userInputCode": "<Entered OTP>"
}'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: User sign in / up was successful. The response also contains more information about the user, for example their user ID, and if it was a new user or existing user. 
- `status: "INCORRECT_USER_INPUT_CODE_ERROR"`: The entered OTP is invalid. The response contains information about the maximum number of retries and the number of failed attempts.
- `status: "EXPIRED_USER_INPUT_CODE_ERROR"`: The entered OTP is too old. You should ask the user to resend a new OTP and try again.
- `status: "RESTART_FLOW_ERROR"`: These responses that the user tried invalid OTPs too many times.
- `status: "GENERAL_ERROR"`: This is possible if you have overridden the backend API to send back a custom error message which should display on the frontend.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during `MFA`. The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

</Tab>

</Tabs>

</TabItem>

</Tabs>

On success, the backend sends back session tokens as part of the response headers, which are automatically handled by the frontend SDK for you.

### 3. Initialize the backend SDK

You need to initialize the **Backend SDK** alongside the code that starts your server.
The init call includes [configuration details](/docs/references/backend-sdks/reference#sdk-configuration) for your app. It specifies how the backend connects to the **SuperTokens Core**, as well as the **Recipes** used in your setup.

For the **Passwordless** recipe, you also need to specify the `flowType` and `contactMethod`.
Click one of the options from the next form and the code snippet updates.

<Tabs>

<Tab value="nodejs">

<PasswordlessConfigCard showFlowType>

```tsx title="Backend SDK Init" showAppTypeSelect
// highlight-next-line

supertokens.init({
    // Replace this with the framework you are using
    framework: "express",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "^{recipes.passwordless.flowType}",
            contactMethod: "^{recipes.passwordless.contactMethod}"
        }),
        // highlight-end
        Session.init() 
    ]
});
```

</PasswordlessConfigCard>

</Tab>

<Tab value="python">

<PasswordlessConfigCard showFlowType>

```python title="Backend SDK Init" showAppTypeSelect
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import passwordless, session
# highlight-next-line
^{derived.pythonContactMethodImport}

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='fastapi',
    recipe_list=[
        session.init(), # initializes session features
        passwordless.init(
            flow_type="^{recipes.passwordless.flowType}",
            contact_config=^{derived.pythonContactMethodMethod}()
        )
    ],
    mode='asgi' # use wsgi if you are running using gunicorn
)
```

</PasswordlessConfigCard>

</Tab>

<Tab value="go">

<PasswordlessConfigCard showFlowType>

```go title="Backend SDK Init" showAppTypeSelect

</CustomUIInstructions>


Having completed the main setup, you can explore more advanced topics related to the **Passwordless** recipe.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-magic-link">
    <ReferenceCard.Title>
      Customize the Magic Link
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Change how Magic Links get created.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-otp">
    <ReferenceCard.Title>
      OTP Customization 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Change the format of the generated One-Time Password.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/passwordless/hooks-and-overrides">
    <ReferenceCard.Title>
      Hooks and overrides
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Add custom logic after the logs in or signs up.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/platform-configuration/email-delivery">
    <ReferenceCard.Title>
      Email Delivery 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Customize how emails get delivered to your users.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/platform-configuration/sms-delivery">
    <ReferenceCard.Title>
      SMS Delivery 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Customize how SMS messages get delivered to your users.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Authentication - Passwordless -  Customize the magic link
Source: https://supertokens.com/docs/authentication/passwordless/customize-the-magic-link

## Change the magic link URL

### Override the email delivery backend function

You can change the URL of Magic Links by providing overriding the email delivery configuration on the backend.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            contactMethod: "EMAIL", // This example will work with any contactMethod
            // This example works with the "USER_INPUT_CODE_AND_MAGIC_LINK" and "MAGIC_LINK" flows.
            flowType: "USER_INPUT_CODE_AND_MAGIC_LINK", 

            // highlight-start
            emailDelivery: {
                // highlight-start
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail: async function (input) {
                            return originalImplementation.sendEmail({
                                ...input,
                                urlWithLinkCode: input.urlWithLinkCode?.replace(
                                    // This is: `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/verify`
                                    "http://localhost:3000/auth/verify",
                                    "http://your.domain.com/your/path"
                                )
                            })
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```
</Tab>
<Tab value="go">

```go

Passwordless.init({
    contactMethod: "EMAIL", // This example will work with any contactMethod
    linkClickedScreenFeature: {
        disableDefaultUI: true
    },
});
```

#### 2. Render the link clicked screen on your custom route:
```tsx
function CustomLinkClickedScreen () {
    return <LinkClicked />
}
```

</Tab>

<Tab value="angular">

When the user clicks the magic link, you need to build your own UI on that page to handle the link clicked. You also need to disable the pre-built UI provided by the SDK for the link clicked screen as shown below:

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIPasswordless.init({
    contactMethod: "EMAIL", // This example will work with any contactMethod
    linkClickedScreenFeature: {
        disableDefaultUI: true
    },
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>
<CustomUIInstructions>

:::info Caution
Not applicable since you do not use the pre-built UI
:::

</CustomUIInstructions>

---

## Generate the link manually

You can use the backend SDK to generate magic links as shown below:

<Tabs>
<Tab value="nodejs">

```tsx

async function createMagicLink(email: string) {
    const magicLink = await Passwordless.createMagicLink({email, tenantId: "public"});

    console.log(magicLink);
}
```

</Tab>
<Tab value="go">

```go

:::

---

## Change the link lifetime

You can change how long a user can use an OTP or a Magic Link to log in by changing the `passwordless_code_lifetime` core configuration value. You configure this value in milliseconds and it defaults to `900000` (15 minutes).

:::caution

Each new OTP / magic link generated, either by opening a new browser or by clicking on the "Resend" button, has a lifetime according to the `passwordless_code_lifetime` setting.

:::

<Tabs
defaultValue="with-docker"
values={[
{label: 'With Docker', value: 'with-docker'},
{label: 'Without Docker', value: 'without-docker'},
{label: 'Managed Service', value: 'with-saas'}
]}>
<TabItem value="with-docker">

```bash
docker run \
  -p 3567:3567 \
  // highlight-start
  -e PASSWORDLESS_CODE_LIFETIME=60000 \
  // highlight-end
  -d registry.supertokens.io/supertokens/supertokens-<db name>
```

</TabItem>

<TabItem value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

passwordless_code_lifetime: 60000

```
</TabItem>

<TabItem value="with-saas">

- Navigate to your SuperTokens managed service dashboard, and click on the Edit Configuration button.
- In there, change the values of the following fields, and click on save.

```yaml
passwordless_code_lifetime: 60000
```
</TabItem>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-otp" label="Customize the OTP" />
  <ReferenceCard href="/docs/authentication/passwordless/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/passwordless/configure-email-and-sms-behavior" label="Email and SMS behavior" />
  <ReferenceCard href="/docs/authentication/passwordless/invite-link-flow" label="Invite link sign up" />
  <ReferenceCard href="/docs/authentication/passwordless/allow-list-flow" label="Allow list sign up" />
  <ReferenceCard href="/docs/platform-configuration/email-delivery" label="Email Delivery" />
  <ReferenceCard href="/docs/platform-configuration/sms-delivery" label="SMS Delivery" />
</ReferenceCard.Grid>

# Authentication - Passwordless -  Customize the one-time password
Source: https://supertokens.com/docs/authentication/passwordless/customize-the-otp

## Change the OTP format

By default, the generated OTP is 6 digits long and is numbers only. You can change this to be any length you like and have any character set by providing the `getCustomUserInputCode` function.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            contactMethod: "EMAIL", // This example will work with any contactMethod
            // This example works with the "USER_INPUT_CODE_AND_MAGIC_LINK" and "USER_INPUT_CODE" flows.
            flowType: "USER_INPUT_CODE_AND_MAGIC_LINK", 

            // highlight-start
            getCustomUserInputCode: async (userCtx) => {
                // TODO:
                return "123abcd";
            },
            // highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

# Authentication - Passwordless -  Hooks and overrides
Source: https://supertokens.com/docs/authentication/passwordless/hooks-and-overrides

**SuperTokens** exposes a set of constructs that allow you to trigger different actions during the authentication lifecycle or to even fully customize the logic based on your use case. 
The following sections describe how you can adjust the `passwordless` recipe to your needs.

Explore the [references pages](/docs/references) for a more in depth guide on hooks and overrides.

## Frontend hook 



<PrebuiltUIInstructions>

This method gets fired, after certain events in the `passwordles` authentication flow. 
Use it to fire different types of events immediately and introduce custom logic based on your use case.

<Tabs>

<Tabs.Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            contactMethod: "EMAIL_OR_PHONE",

            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "PASSWORDLESS_RESTART_FLOW") {
                    // TODO:
                } else if (context.action === "PASSWORDLESS_CODE_SENT") {
                    // TODO:
                } else {
                    let {id, emails, phoneNumbers} = context.user;
                    if (context.action === "SUCCESS") {
                        if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                            // TODO: Sign up
                        } else {
                            // TODO: Sign in
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```

</Tabs.Tab>

<Tabs.Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIPasswordless.init({
            contactMethod: "EMAIL_OR_PHONE",

            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "PASSWORDLESS_RESTART_FLOW") {
                    // TODO:
                } else if (context.action === "PASSWORDLESS_CODE_SENT") {
                    // TODO:
                } else {
                    let {id, emails, phoneNumbers} = context.user;
                    if (context.action === "SUCCESS") {
                        if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                            // TODO: Sign up
                        } else {
                            // TODO: Sign in
                        }
                    }
                }
            }
            // highlight-end
        }),
        supertokensUISession.init()
    ]
});
```

</Tabs.Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

:::caution Not applicable
This section is not applicable for custom UI since you are calling the consume code API yourself anyway. You can perform any actions post sign in / up based on the result of the API call.
:::

</CustomUIInstructions>

## Backend override

Overriding the `consumeCode` function allows you to introduce your own logic for the authentication process.
Use it to persist different types of data or trigger actions.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            contactMethod: "EMAIL", // This example will work with any contactMethod
            flowType: "USER_INPUT_CODE_AND_MAGIC_LINK", // This example will work with any flowType

            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        consumeCode: async (input) => {
                            
                            // First we call the original implementation of consumeCode.
                            let response = await originalImplementation.consumeCode(input);

                            // Post sign up response, we check if it was successful
                            if (response.status === "OK") {
                                let { id, emails, phoneNumbers } = response.user;

                                if (input.session === undefined) {
                                    if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                                        // TODO: post sign up logic
                                    } else {
                                        // TODO: post sign in logic
                                    }
                                }
                            }
                            return response;
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```
</Tab>
<Tab value="go">

```go

# Authentication - Passwordless -  Configure email and SMS behavior
Source: https://supertokens.com/docs/authentication/passwordless/configure-email-and-sms-behavior

## Changing email / SMS resend time interval

:::caution no-title
These instructions are only applicable if you are using the pre-built UI.
:::

You can set `resendEmailOrSMSGapInSeconds` to establish a minimum delay before the frontend allows the user to click the "Resend" button.
This limit is only enforced on the client-side. For API rate-limiting please check out the [deployment section](/docs/deployment/rate-limits).

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            contactMethod: "EMAIL_OR_PHONE", // This example will work with any contactMethod.
            // highlight-start
            signInUpFeature: {
                // The default value is 15 seconds
                resendEmailOrSMSGapInSeconds: 60,
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIPasswordless.init({
            contactMethod: "EMAIL_OR_PHONE", // This example will work with any contactMethod.
            // highlight-start
            signInUpFeature: {
                // The default value is 15 seconds
                resendEmailOrSMSGapInSeconds: 60,
            }
            // highlight-end
        }),
        supertokensUISession.init({ /* ... */ })
    ]
});
```

</Tab>

</Tabs>

---

## Setting default country for phone inputs

:::caution no-title
These instructions are only applicable if you are using the pre-built UI.
:::



<ContextCondition condition={{
    "recipes.passwordless.contactMethod": "EMAIL"
}}>

Since your delivery method is email, this section is not relevant. If you would still like to see the content, you can resubmit your desired configuration by clicking on the button above.

</ContextCondition>

<ContextCondition condition={{
    "recipes.passwordless.contactMethod": "PHONE"
}}>

By default, there is no default country selected. This means that users have to select / type in their phone number international code when signing in / signing up.

If you would like to set a default country (for all users), then you should use the `defaultCountry` configuration:

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
      contactMethod: "PHONE",
            // highlight-start
            signInUpFeature: {
               /*
               * Must be a two-letter ISO country code (e.g.: "US")
               */
                defaultCountry: "HU",
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIPasswordless.init({
      contactMethod: "PHONE",
            // highlight-start
            signInUpFeature: {
               /*
               * Must be a two-letter ISO country code (e.g.: "US")
               */
                defaultCountry: "HU",
            }
            // highlight-end
        }),
        supertokensUISession.init({ /* ... */ })
    ]
});
```

</Tab>
</Tabs>

</ContextCondition>
<ContextCondition condition={{
    "recipes.passwordless.contactMethod": "EMAIL_OR_PHONE"
}}>

By default, there is no default country selected. This means that users have to select / type in their phone number international code when signing in / signing up.

If you would like to set a default country (for all users), then you should use the `defaultCountry` configuration:

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
      contactMethod: "EMAIL_OR_PHONE",
            // highlight-start
            signInUpFeature: {
               /*
               * Must be a two-letter ISO country code (e.g.: "US")
               */
                defaultCountry: "HU",
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIPasswordless.init({
             contactMethod: "EMAIL_OR_PHONE",
            // highlight-start
            signInUpFeature: {
               /*
               * Must be a two-letter ISO country code (e.g.: "US")
               */
                defaultCountry: "HU",
            }
            // highlight-end
        }),
        supertokensUISession.init({ /* ... */ })
    ]
});
```

</Tab>
</Tabs>

</ContextCondition>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/platform-configuration/email-delivery" label="Email Delivery" />
  <ReferenceCard href="/docs/platform-configuration/sms-delivery" label="SMS Delivery" />
  <ReferenceCard href="/docs/deployment/rate-limits" label="Rate Limiting" />
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-magic-link" label="Customize the magic link" />
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-otp" label="Customize the OTP" />
  <ReferenceCard href="/docs/authentication/passwordless/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Passwordless -  Passwordless login via invite link
Source: https://supertokens.com/docs/authentication/passwordless/invite-link-flow

## Overview

In this flow, the admin of the app calls an API to sign up a user and send them an invite link.
Once the user clicks on that, they log in and can access the app.
If a user has not received an invitation before, their sign in attempt fails.

## Before you start

This guide assumes that you have already implemented the [EmailPassword recipe](/docs/authentication/email-password/introduction) and have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

## Steps

### 1. Add the ability to invite new users

Add a new endpoint that allows you to invite users to your app.
You need to first create the new user and then use the `passwordless` API to send the magic link to them.
Additionally, protect the endpoint with a role requirement.

The `passwordless` API uses the default magic link path, `/auth/verify`, for the invite link.
If you are using the pre-built UI, the frontend SDK automatically logs the user in.
For custom UI implementations, use the [`consumeCode` function provided by the frontend SDK](/docs/authentication/passwordless/initial-setup) to call the `passwordless` API that verifies the code in the URL and creates the user.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post("/create-user", verifySession({
    overrideGlobalClaimValidators: async function (globalClaimValidators) {
        return [...globalClaimValidators,
        UserRoles.UserRoleClaim.validators.includes("admin")]
    }
}), async (req: SessionRequest, res) => {
	let email = req.body.email;

    // this will create the user in supertokens if they don't already exist.
    await Passwordless.signInUp({
        tenantId: "public",
        email
    })

    let inviteLink = await Passwordless.createMagicLink({
        tenantId: "public",
        email
    });

    // TODO: send inviteLink to user's email
    res.send("Success");
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/create-user",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    overrideGlobalClaimValidators: async function (globalClaimValidators) {
                        return [...globalClaimValidators,
                        UserRoles.UserRoleClaim.validators.includes("admin")]
                    }
                })
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let email = (req.payload.valueOf() as any).email;

        // this will create the user in supertokens if they don't already exist.
        await Passwordless.signInUp({
            tenantId: "public",
            email
        })

        let inviteLink = await Passwordless.createMagicLink({
        	tenantId: "public",
            email
    	});

    	// TODO: send inviteLink to user's email
        res.response("Success").code(200);
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/create-user", {
    preHandler: verifySession({
        overrideGlobalClaimValidators: async function (globalClaimValidators) {
            return [...globalClaimValidators,
            UserRoles.UserRoleClaim.validators.includes("admin")]
        }
    }),
}, async (req, res) => {
    let email = req.body.email;

    // this will create the user in supertokens if they don't already exist.
    await Passwordless.signInUp({
        tenantId: "public",
        email
    })

    let inviteLink = await Passwordless.createMagicLink({
        tenantId: "public",
        email
    });

    // TODO: send inviteLink to user's email
    res.code(200).send("Success");
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function createUser(awsEvent: SessionEventV2) {
    let email = JSON.parse(awsEvent.body!).email;

    // this will create the user in supertokens if they don't already exist.
    await Passwordless.signInUp({
        tenantId: "public",
        email
    })

    let inviteLink = await Passwordless.createMagicLink({
        tenantId: "public",
        email
    });

    // TODO: send inviteLink to user's email
    return {
        statusCode: '200',
        body: "Success"
    }
};

exports.handler = verifySession(createUser, {
    overrideGlobalClaimValidators: async function (globalClaimValidators) {
        return [...globalClaimValidators,
        UserRoles.UserRoleClaim.validators.includes("admin")]
    }
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/create-user", verifySession({
    overrideGlobalClaimValidators: async function (globalClaimValidators) {
        return [...globalClaimValidators,
        UserRoles.UserRoleClaim.validators.includes("admin")]
    }
}), async (ctx: SessionContext, next) => {
    let email = (ctx.body as any).email;

    // this will create the user in supertokens if they don't already exist.
    await Passwordless.signInUp({
        tenantId: "public",
        email
    })

    let inviteLink = await Passwordless.createMagicLink({
        tenantId: "public",
        email
    });

    // TODO: send inviteLink to user's email
    ctx.status = 200;
    ctx.body = "Success";
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/create-user")
    @intercept(verifySession({
        overrideGlobalClaimValidators: async function (globalClaimValidators) {
            return [...globalClaimValidators,
            UserRoles.UserRoleClaim.validators.includes("admin")]
        }
    }))
    async handler() {
        let email = "" // TODO: get from request body

        // this will create the user in supertokens if they don't already exist.
        await Passwordless.signInUp({
            tenantId: "public",
            email
        })

        let inviteLink = await Passwordless.createMagicLink({
        	tenantId: "public",
            email
    	});

    	// TODO: send inviteLink to user's email
        // TODO: send 200 response to the client
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function createUser(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                overrideGlobalClaimValidators: async function (globalClaimValidators) {
                    return [...globalClaimValidators,
                    UserRoles.UserRoleClaim.validators.includes("admin")]
                }
            })(req, res, next);
        },
        req,
        res
    )

    let email = req.body.email;

    // this will create the user in supertokens if they don't already exist.
    await Passwordless.signInUp({
        tenantId: "public",
        email
    })

    let inviteLink = await Passwordless.createMagicLink({
        tenantId: "public",
        email
    });

    // TODO: send inviteLink to user's email
    res.status(200).json({ message: 'Success' })
}
```

</ConditionalContent>

<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        const body = await request.json();
        let email = body.email;

        // this will create the user in supertokens if they don't already exist.
        await Passwordless.signInUp({
            tenantId: "public",
            email
        })

        let inviteLink = await Passwordless.createMagicLink({
            tenantId: "public",
            email
        });

        // TODO: send inviteLink to user's email
        return NextResponse.json({ message: 'Success' });
    },
    {
        overrideGlobalClaimValidators: async function (globalClaimValidators) {
            return [...globalClaimValidators, UserRoles.UserRoleClaim.validators.includes("admin")]
        }
    });
}
```
</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class CreateUserController {
  @Post('create-user')
  @UseGuards(new AuthGuard({
    overrideGlobalClaimValidators: async function (globalClaimValidators: any) {
      return [...globalClaimValidators,
      UserRoles.UserRoleClaim.validators.includes("admin")]
    }
  })) // For more information about this guard please read our NestJS guide.
  async postAPI(@Session() session: SessionContainer): Promise<void> {
    let email = "" // TODO: get from request body

    // this will create the user in supertokens if they don't already exist.
    await Passwordless.signInUp({
        tenantId: "public",
        email
    })

    let inviteLink = await Passwordless.createMagicLink({
        tenantId: "public",
        email
    });

    // TODO: send inviteLink to user's email
    // TODO: send 200 response to the client
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go

    // This will create the user in supertokens if they don't already exist.
    tenantId := "public"
    passwordless.SignInUpByEmail(tenantId, email)

	inviteLink, err := passwordless.CreateMagicLinkByEmail(tenantId, email)
	if err != nil {
		// TODO: send 500 to the client
		return
	}
	fmt.Println(inviteLink)
	// TODO: send invite link
	// TODO: send 200 to the client
}
```

</Tab>
<Tab value="gin">

```go

    // This will create the user in supertokens if they don't already exist.
    tenantId := "public"
    passwordless.SignInUpByEmail(tenantId, email)

	inviteLink, err := passwordless.CreateMagicLinkByEmail(tenantId, email)
	if err != nil {
		// TODO: send 500 to the client
		return
	}
	fmt.Println(inviteLink)
	// TODO: send invite link
	// TODO: send 200 to the client
}
```

</Tab>
<Tab value="chi">

```go

    // This will create the user in supertokens if they don't already exist.
    tenantId := "public"
    passwordless.SignInUpByEmail(tenantId, email)

	inviteLink, err := passwordless.CreateMagicLinkByEmail(tenantId, email)
	if err != nil {
		// TODO: send 500 to the client
		return
	}
	fmt.Println(inviteLink)
	// TODO: send invite link
	// TODO: send 200 to the client
}
```

</Tab>
<Tab value="mux">

```go

    // This will create the user in supertokens if they don't already exist.
    tenantId := "public"
    passwordless.SignInUpByEmail(tenantId, email)

	inviteLink, err := passwordless.CreateMagicLinkByEmail(tenantId, email)
	if err != nil {
		// TODO: send 500 to the client
		return
	}
	fmt.Println(inviteLink)
	// TODO: send invite link
	// TODO: send 200 to the client
}
```

</Tab>
</Tabs>
</Tab>
<Tab value="python">

<Tabs>
<Tab value="fastapi">

```python
from fastapi import Depends

from supertokens_python.recipe.passwordless.asyncio import create_magic_link, signinup
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.framework.fastapi import verify_session
from supertokens_python.recipe.userroles import UserRoleClaim

@app.post('/create-user')  # type: ignore
async def create_user(session: SessionContainer = Depends(verify_session(
    override_global_claim_validators=lambda global_validators, session, user_context: global_validators +
    [UserRoleClaim.validators.includes("admin")]
))):
    email = ""  # TODO: read from request body.

    # this will creat the user in supertokens if they don't already exist
    await signinup("public", email, None)

    invite_link = await create_magic_link("public", email, None)

    print(invite_link)
    # TODO: send invite_link to email
    # TODO: send 200 responspe to client
```

</Tab>
<Tab value="flask">

```python
from supertokens_python.recipe.passwordless.syncio import create_magic_link, signinup
from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.recipe.userroles import UserRoleClaim

@app.route('/create_user', methods=['POST'])  # type: ignore
@verify_session(
    override_global_claim_validators=lambda global_validators, session, user_context: global_validators +
    [UserRoleClaim.validators.includes("admin")]
)
def create_user():
    email = ""  # TODO: read from request body.

    # this will creat the user in supertokens if they don't already exist
    signinup("public", email, None)

    invite_link = create_magic_link("public", email, None)

    print(invite_link)
    # TODO: send invite_link to email
    # TODO: send 200 responspe to client
```

</Tab>
<Tab value="django">

```python
from django.http import HttpRequest

from supertokens_python.recipe.passwordless.asyncio import create_magic_link, signinup
from supertokens_python.recipe.session.framework.django.asyncio import verify_session
from supertokens_python.recipe.userroles import UserRoleClaim

@verify_session(
    override_global_claim_validators=lambda global_validators, session, user_context: global_validators +
    [UserRoleClaim.validators.includes("admin")]
)
async def create_user(request: HttpRequest):
    email = ""  # TODO: read from request body.

    # this will creat the user in supertokens if they don't already exist
    await signinup("public", email, None)

    invite_link = await create_magic_link("public", email, None)

    print(invite_link)
    # TODO: send invite_link to email
    # TODO: send 200 responspe to client
```

</Tab>
</Tabs>

</Tab>
</Tabs>

:::info Multi Tenancy
In the above code snippets, the `"public"` `tenantId` passes when calling the functions - this is the default `tenantId`. If you are using the multi-tenancy feature, you can pass in a different `tenantId` and this ensures that the user with that email adds only to that tenant.

You also need to pass in the `tenantId` to the createMagicLink function which adds the `tenantId` to the generated magic link. The resulting link uses the `websiteDomain` configured in the `appInfo` object in `SuperTokens.init`, but you can change the link's domain to match that of the tenant before sending it.
:::

### 2. Check if a user was invited 

Update the backend SDK API function to only allow sign up requests from invited users.
To do this you need to check if a user exists in **SuperTokens**.

<Tabs>
<Tab value="nodejs">

```tsx

Passwordless.init({
    contactMethod: "EMAIL", flowType: "USER_INPUT_CODE_AND_MAGIC_LINK", // typecheck-only, removed from output
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                createCodePOST: async function (input) {
                    if ("email" in input) {
                        let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                            email: input.email
                        });
                        let existingPasswordlessUser = existingUsers.find(user => user.loginMethods.find(lM => lM.hasSameEmailAs(input.email) && lM.recipeId === "passwordless") !== undefined);
                        if (existingPasswordlessUser === undefined) {
                            // this is sign up attempt
                            return {
                                status: "GENERAL_ERROR",
                                message: "Sign up disabled. Please contact the admin."
                            }
                        }
                    } else {
                        let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                            phoneNumber: input.phoneNumber
                        });
                        let existingPasswordlessUser = existingUsers.find(user => user.loginMethods.find(lM => lM.hasSamePhoneNumberAs(input.phoneNumber) && lM.recipeId === "passwordless") !== undefined);
                        if (existingPasswordlessUser === undefined) {
                            // this is sign up attempt
                            return {
                                status: "GENERAL_ERROR",
                                message: "Sign up disabled. Please contact the admin."
                            }
                        }
                    }
                    return await originalImplementation.createCodePOST!(input);
                }
            }
        }
    }
})
```

</Tab>
<Tab value="go">

```go
            flow_type="USER_INPUT_CODE",
            override=passwordless.InputOverrideConfig(
                apis=override_passwordless_apis,
            ),
        )
    ],
)
```

</Tab>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-magic-link" label="Customize the magic link" />
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-otp" label="Customize the OTP" />
  <ReferenceCard href="/docs/authentication/passwordless/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/passwordless/configure-email-and-sms-behavior" label="Email and SMS behavior" />
  <ReferenceCard href="/docs/authentication/passwordless/allow-list-flow" label="Allow list sign up" />
  <ReferenceCard href="/docs/platform-configuration/email-delivery" label="Email Delivery" />
  <ReferenceCard href="/docs/platform-configuration/sms-delivery" label="SMS Delivery" />
</ReferenceCard.Grid>

# Authentication - Passwordless -  Passwordless login via allow list
Source: https://supertokens.com/docs/authentication/passwordless/allow-list-flow

## Overview

In this flow, you create a list of emails or phone numbers that are allowed to sign up.
Based on that users can go through the passwordless flow.

## Before you start

This guide assumes that you already have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

### Prerequisites

This guide uses the `UserMetadata` recipe to store the allow list.
You need to [enable it](/docs/post-authentication/user-management/user-metadata) in the SDK initialization step.

## Steps

### 1. Add a way to keep track of allowed emails or phone numbers

Start by maintaining an allow list of emails.
You can either store this list in your own database, or use the metadata feature provided by SuperTokens to store this.
This may seem like a strange use case of the user metadata recipe provided, but it works.

The following code samples show you how to save the allow list in the user metadata.

<Tabs>
<Tab value="nodejs">

```tsx

async function addEmailToAllowlist(email: string) {
    let existingData = await UserMetadata.getUserMetadata("emailAllowList");
    let allowList: string[] = existingData.metadata.allowList || [];
    allowList = [...allowList, email];
    await UserMetadata.updateUserMetadata("emailAllowList", {
        allowList
    });
}

async function isEmailAllowed(email: string) {
    let existingData = await UserMetadata.getUserMetadata("emailAllowList");
    let allowList: string[] = existingData.metadata.allowList || [];
    return allowList.includes(email);
}

async function addPhoneNumberToAllowlist(phoneNumber: string) {
    let existingData = await UserMetadata.getUserMetadata("phoneNumberAllowList");
    let allowList: string[] = existingData.metadata.allowList || [];
    allowList = [...allowList, phoneNumber];
    await UserMetadata.updateUserMetadata("phoneNumberAllowList", {
        allowList
    });
}

async function isPhoneNumberAllowed(phoneNumber: string) {
    let existingData = await UserMetadata.getUserMetadata("phoneNumberAllowList");
    let allowList: string[] = existingData.metadata.allowList || [];
    return allowList.includes(phoneNumber);
}
```

</Tab>
<Tab value="go">

```go
:::

### 2. Check if the user is on the allow list

Update the backend SDK API function to only allow sign up requests from users that are on the allow list.
To do this you need to use the check functions from the previous code snippet.

<Tabs>
<Tab value="nodejs">

```tsx
declare let isEmailAllowed: (email: string) => Promise<boolean> // typecheck-only, removed from output
declare let isPhoneNumberAllowed: (email: string) => Promise<boolean> // typecheck-only, removed from output

Passwordless.init({
    contactMethod: "EMAIL", flowType: "USER_INPUT_CODE_AND_MAGIC_LINK", // typecheck-only, removed from output
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                createCodePOST: async function (input) {
                    if ("email" in input) {
                        let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                            email: input.email,
                        });
                        let userWithPasswordles = existingUsers.find(u => u.loginMethods.find(lM => lM.hasSameEmailAs(input.email) && lM.recipeId === "passwordless") !== undefined);
                        if (userWithPasswordles === undefined) {
                            // this is sign up attempt
                            if (!(await isEmailAllowed(input.email))) {
                                return {
                                    status: "GENERAL_ERROR",
                                    message: "Sign up disabled. Please contact the admin."
                                }
                            }
                        }
                    } else {
                        let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                            phoneNumber: input.phoneNumber,
                        });
                        let userWithPasswordles = existingUsers.find(u => u.loginMethods.find(lM => lM.hasSamePhoneNumberAs(input.phoneNumber) && lM.recipeId === "passwordless") !== undefined);
                        if (userWithPasswordles === undefined) {
                            // this is sign up attempt
                            if (!(await isPhoneNumberAllowed(input.phoneNumber))) {
                                return {
                                    status: "GENERAL_ERROR",
                                    message: "Sign up disabled. Please contact the admin."
                                }
                            }
                        }
                    }
                    return await originalImplementation.createCodePOST!(input);
                }
            }
        }
    }
})
```

</Tab>
<Tab value="go">

```go
	return false, nil
}

func isPhoneNumberAllowed(phoneNumber string) (bool, error) {
	// ... from previous code snippet
	return false, nil
}

func main() {
	passwordless.Init(plessmodels.TypeInput{
		Override: &plessmodels.OverrideStruct{
			APIs: func(originalImplementation plessmodels.APIInterface) plessmodels.APIInterface {
				originalCreateCodePOST := *originalImplementation.CreateCodePOST

				(*originalImplementation.CreateCodePOST) = func(email, phoneNumber *string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.CreateCodePOSTResponse, error) {

					if email != nil {
						existingUser, err := passwordless.GetUserByEmail(tenantId, *email)
						if err != nil {
							return plessmodels.CreateCodePOSTResponse{}, err
						}
						if existingUser == nil {
							// sign up attempt
							emailAllowed, err := isEmailAllowed(*email)
							if err != nil {
								return plessmodels.CreateCodePOSTResponse{}, err
							}
							if !emailAllowed {
								return plessmodels.CreateCodePOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "Sign ups are disabled. Please contact the admin.",
									},
								}, nil
							}
						}
					} else {
						existingUser, err := passwordless.GetUserByPhoneNumber(tenantId, *phoneNumber)
						if err != nil {
							return plessmodels.CreateCodePOSTResponse{}, err
						}
						if existingUser == nil {
							// sign up attempt
							phoneNumberAllowed, err := isPhoneNumberAllowed(*phoneNumber)
							if err != nil {
								return plessmodels.CreateCodePOSTResponse{}, err
							}
							if !phoneNumberAllowed {
								return plessmodels.CreateCodePOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "Sign ups are disabled. Please contact the admin.",
									},
								}, nil
							}
						}
					}
					return originalCreateCodePOST(email, phoneNumber, tenantId, options, userContext)
				}

				return originalImplementation
			},
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from typing import Any, Dict, Optional, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import list_users_by_account_info
from supertokens_python.recipe import passwordless
from supertokens_python.recipe.passwordless.interfaces import (
    APIInterface,
    APIOptions,
)
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.types.base import AccountInfoInput

async def is_email_allowed(email: str):
    # from previous code snippet..
    return False

async def is_phone_number_allowed(phone_number: str):
    # from previous code snippet..
    return False

def override_passwordless_apis(original_implementation: APIInterface):
    original_create_code_post = original_implementation.create_code_post

    async def create_code_post(
        email: Union[str, None],
        phone_number: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        if email is not None:
            existing_user = await list_users_by_account_info(
                tenant_id, AccountInfoInput(email=email)
            )
            user_with_passwordless = next(
                (
                    user
                    for user in existing_user
                    if any(
                        login_method.recipe_id == "passwordless"
                        and login_method.has_same_email_as(email)
                        for login_method in user.login_methods
                    )
                ),
                None,
            )

            if user_with_passwordless is None:
                # sign up attempt
                if not (await is_email_allowed(email)):
                    return GeneralErrorResponse(
                        "Sign ups disabled. Please contact admin."
                    )
        else:
            assert phone_number is not None
            existing_user = await list_users_by_account_info(
                tenant_id, AccountInfoInput(phone_number=phone_number)
            )
            user_with_passwordless = next(
                (
                    user
                    for user in existing_user
                    if any(
                        login_method.recipe_id == "passwordless"
                        and login_method.has_same_phone_number_as(phone_number)
                        for login_method in user.login_methods
                    )
                ),
                None,
            )

            if user_with_passwordless is None:
                # sign up attempt
                if not (await is_phone_number_allowed(phone_number)):
                    return GeneralErrorResponse(
                        "Sign ups disabled. Please contact admin."
                    )

        return await original_create_code_post(
            email,
            phone_number,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

    original_implementation.create_code_post = create_code_post
    return original_implementation

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            contact_config="",  # type: ignore # typecheck-only, removed from output
            flow_type="USER_INPUT_CODE",
            override=passwordless.InputOverrideConfig(
                apis=override_passwordless_apis,
            ),
        )
    ],
)
```

</Tab>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-magic-link" label="Customize the magic link" />
  <ReferenceCard href="/docs/authentication/passwordless/customize-the-otp" label="Customize the OTP" />
  <ReferenceCard href="/docs/authentication/passwordless/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/authentication/passwordless/configure-email-and-sms-behavior" label="Email and SMS behavior" />
  <ReferenceCard href="/docs/authentication/passwordless/invite-link-flow" label="Invite link sign up" />
</ReferenceCard.Grid>

# Authentication - Social Login -  Initial setup
Source: https://supertokens.com/docs/authentication/social/initial-setup

## Overview

This page shows you how to authenticate, using **ThirdParty Providers**, with **SuperTokens**.
The tutorial creates a login flow, rendered by either the **Prebuilt UI** components or by your own **Custom UI**.

## Before you start

:::important

These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page please follow the tutorial and return here once you're done.

:::

## Steps



<PrebuiltUIInstructions>

### 1. Initialize the frontend SDK

<Tabs showMobileTab>
  <Tab value="reactjs">

#### 1.1 Add the `ThirdParty` recipe in your main configuration file.

```tsx

// highlight-next-line

SuperTokens.init({
    appInfo: { 
        // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
// highlight-start
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    Github.init(),
                    Google.init(),
                    Facebook.init(),
                    Apple.init(),
                ]
            }
        }),
    // highlight-end
        Session.init()
    ]
});
```

#### 1.2 Include the pre-built UI components in your application.

In order for the **pre-built UI** to render inside your application, you have to specify which routes show the authentication components.
The **React SDK** uses [**React Router**](https://reactrouter.com/en/main) under the hood to achieve this.
Based on whether you already use this package or not in your project, there are two different ways of configuring the routes.

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">
  <Answer title="Yes">
```tsx

// highlight-next-line

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        {/*This renders the login UI on the <WEBSITE_BASE_PATH> route*/}
                        // highlight-next-line
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [ThirdPartyPreBuiltUI])}
                        {/*Your app routes*/}
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```

        :::important
If you are using `useRoutes`, `createBrowserRouter` or have routes defined in a different file, you need to adjust the code sample.
Please see [this issue](https://github.com/supertokens/supertokens-auth-react/issues/581#issuecomment-1246998493) for further details.
```tsx

function AppRoutes() {
  const authRoutes = getSuperTokensRoutesForReactRouterDom(
    reactRouterDom,
    [/* Add your UI recipes here e.g. EmailPasswordPrebuiltUI, PasswordlessPrebuiltUI, ThirdPartyPrebuiltUI */]
  );

  const routes = useRoutes([
    ...authRoutes.map(route => route.props),
    // Include the rest of your app routes 
  ]);

  return routes;
}

function App() {
  return (
    <SuperTokensWrapper>
      <BrowserRouter>
          <AppRoutes />
      </BrowserRouter>
    </SuperTokensWrapper>
  );
}
```
:::
  </Answer>
  <Answer title="No">

```tsx
// highlight-next-line

class App extends React.Component {
    render() {
        // highlight-start
        if (canHandleRoute([ThirdPartyPreBuiltUI])) {
            // This renders the login UI on the <WEBSITE_BASE_PATH> route
            return getRoutingComponent([ThirdPartyPreBuiltUI])
        }
        // highlight-end

        return (
            <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
        );
    }

}
```
  </Answer>
</Question>

  </Tab>
  <Tab value="angular">

Add the `ThirdParty` recipe in your `AuthComponent`.

    ```tsx title="/app/auth/auth.component.ts"

    @Component({
        selector: "app-auth",
        template: '<div id="supertokensui"></div>',
    })
    export class AuthComponent implements OnDestroy, AfterViewInit {

        constructor(
            private renderer: Renderer2,
            @Inject(DOCUMENT) private document: Document
        ) { }

        ngAfterViewInit() {
            this.loadScript('^{prebuiltUIVersion}');
        }

        ngOnDestroy() {
            // Remove the script when the component is destroyed
            const script = this.document.getElementById('supertokens-script');
            if (script) {
                script.remove();
            }
        }

        private loadScript(src: string) {
            const script = this.renderer.createElement('script');
            script.type = 'text/javascript';
            script.src = src;
            script.id = 'supertokens-script';
            script.onload = () => {
                supertokensUIInit({
                    appInfo: {
                        // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration
                        appName: "<APP_NAME>",
                        apiDomain: "<API_DOMAIN>",
                        websiteDomain: "<WEBSITE_DOMAIN>",
                        apiBasePath: "<API_BASE_PATH>",
                        websiteBasePath: "<WEBSITE_BASE_PATH>",
                    },
                    recipeList: [
// highlight-start
                        supertokensUIThirdParty.init({
                            signInAndUpFeature: {
                                providers: [
                                    supertokensUIThirdParty.Github.init(),
                                    supertokensUIThirdParty.Google.init(),
                                    supertokensUIThirdParty.Facebook.init(),
                                    supertokensUIThirdParty.Apple.init(),
                                ]
                            }
                        }),
// highlight-end
                        supertokensUISession.init(),
                    ],
                });
            }
            this.renderer.appendChild(this.document.body, script);
        }
    }
    ```

  </Tab>
  <Tab value="vue">

Add the `ThirdParty` recipe in your `AuthView` file.

    ```tsx
    <script lang="ts">
        export default defineComponent({
            setup() {
                const loadScript = (src: string) => {
                    const script = document.createElement('script');
                    script.type = 'text/javascript';
                    script.src = src;
                    script.id = 'supertokens-script';
                    script.onload = () => {
                        supertokensUIInit({
                            appInfo: {
                                // learn more about this on https://supertokens.com/docs/references/frontend-sdks/reference#sdk-configuration 
                                appName: "<APP_NAME>",
                                apiDomain: "<API_DOMAIN>",
                                websiteDomain: "<WEBSITE_DOMAIN>",
                                apiBasePath: "<API_BASE_PATH>",
                                websiteBasePath: "<WEBSITE_BASE_PATH>",
                            },
                            recipeList: [
// highlight-start
                                supertokensUIThirdParty.init({
                                    signInAndUpFeature: {
                                        providers: [
                                            supertokensUIThirdParty.Github.init(),
                                            supertokensUIThirdParty.Google.init(),
                                            supertokensUIThirdParty.Facebook.init(),
                                            supertokensUIThirdParty.Apple.init(),
                                        ]
                                    }
                                }),
// highlight-end
                                supertokensUISession.init(),
                            ],
                        });
                    };
                    document.body.appendChild(script);
                };

                onMounted(() => {
                    loadScript('^{prebuiltUIVersion}');
                });

                onUnmounted(() => {
                    const script = document.getElementById('supertokens-script');
                    if (script) {
                        script.remove();
                    }
                });
            },
        });
    </script>

    <template>
        <div id="supertokensui" />
    </template>
    ```

  </Tab>

</Tabs>

#### Change the button style 

On the frontend, you can provide a button component to the in-built providers defining your own UI. The component you add is clickable by default.

<Tabs>
<Tab value="reactjs">

```tsx
SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                // highlight-start
                providers: [
                    Github.init({
                        buttonComponent: (props: {name: string}) => <div></div>
                    }),
                    Google.init({
                        buttonComponent: (props: {name: string}) => <div></div>
                    }),
                    Facebook.init({
                        buttonComponent: (props: {name: string}) => <div></div>
                    }),
                    Apple.init({
                        buttonComponent: (props: {name: string}) => <div></div>
                    }),
                ], 
                // highlight-end
                // ...
            },
            // ...
        }),
        // ...
    ]
});
```
</Tab>

<Tab value="angular">

:::caution
This is impossible for non-react apps at the moment. Please use custom UI instead for the sign-in form.
:::

</Tab>
</Tabs>

### 2. Initialize the backend SDK

You have to initialize the **Backend Software Development Kit (SDK)** alongside the code that starts your server.
The init call includes [configuration details](/docs/references/backend-sdks/reference#sdk-configuration) for your app. It specifies how the backend connects to the **SuperTokens Core**, as well as the **Recipes** used in your setup.

<Tabs>

<Tab value="nodejs">

```tsx title="Backend SDK Init" showAppTypeSelect
// highlight-next-line

supertokens.init({
    // Replace this with the framework you are using
    framework: "express",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        // highlight-start
        ThirdParty.init({/*TODO: See next step*/}),
        // highlight-end
        Session.init() 
    ]
});
```

</Tab>

<Tab value="python">

```python title="Backend SDK Init" showAppTypeSelect
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import thirdparty, session
# highlight-next-line

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='fastapi',
    recipe_list=[
        session.init(), # initializes session features
        thirdparty.init(
           # TODO: See next step
        ) # type: ignore
    ],
    mode='asgi' # use wsgi if you are running using gunicorn
)
```

</Tab>

<Tab value="go">

```go title="Backend SDK Init" showAppTypeSelect

### 3. Add the authentication providers

Populate the `providers` array with the third party authentication providers that you want.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        ThirdParty.init({
            //highlight-start
            signInAndUpFeature: {
                // We have provided you with development keys which you can use for testing.
                // IMPORTANT: Please replace them with your own OAuth keys for production use.
                providers: [{
                    config: {
                        thirdPartyId: "google",
                        clients: [{
                            clientId: "1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com",
                            clientSecret: "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"
                        }]
                    }
                }, {
                    config: {
                        thirdPartyId: "github",
                        clients: [{
                            clientId: "467101b197249757c71f",
                            clientSecret: "e97051221f4b6426e8fe8d51486396703012f5bd"
                        }]
                    }
                }, {
                    config: {
                        thirdPartyId: "apple",
                        clients: [{
                            clientId: "4398792-io.supertokens.example.service",
                            additionalConfig: {
                                keyId: "7M48Y4RYDL",
                                privateKey:
                                    "-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgu8gXs+XYkqXD6Ala9Sf/iJXzhbwcoG5dMh1OonpdJUmgCgYIKoZIzj0DAQehRANCAASfrvlFbFCYqn3I2zeknYXLwtH30JuOKestDbSfZYxZNMqhF/OzdZFTV0zc5u5s3eN+oCWbnvl0hM+9IW0UlkdA\n-----END PRIVATE KEY-----",
                                teamId: "YWQCXGJRJL",
                            }
                        }]
                    }
                }],
            }
            //highlight-end
        }),
        // ...
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "google",
                            clients: [{
                                clientId: "TODO: GOOGLE_CLIENT_ID",
                                clientSecret: "TODO: GOOGLE_CLIENT_SECRET",
                                scope: ["scope1", "scope2"]
                            }]
                        }
                    }
                ]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go

</PrebuiltUIInstructions>

<CustomUIInstructions>

### 1. Initialize the frontend SDK

Call the SDK init function at the start of your application.
The invocation includes the [main configuration details](/docs/references/frontend-sdks/reference#sdk-configuration), as well as the **recipes** that you are using in your setup.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        // highlight-next-line
        ThirdParty.init(),
        Session.init(),
    ],
});
```

</Tab>

<Tab value="scripts">

<Tabs.Section>

First, you need to add the recipe script tag.

```html
<script src="^{webJsVersions.thirdparty}"></script>
```

You can initialize the SDK.

</Tabs.Section>

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init(),
        // highlight-next-line
        supertokensThirdParty.init(),
    ],
});
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

SuperTokens.init({
    apiDomain: "<API_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
});
```

</Tab>

<Tab value="android">

Add the `SuperTokens.init` function call at the start of your application.

```kotlin

void main() {
    SuperTokens.init(
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
    );
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

### 2. Add the login UI

The **ThirdParty** flow involves creating a UI element that allows the user to initiate the login process.
This occurs through a separate button for each provider that you have configured. You can have a look at the [UI implementation](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/thirdparty-auth--sign-in-up) to get a better idea.

After the user clicks one of those buttons the actions that you need to take differ based on which type of authentication scenario you are using:

- **Authorization Code** 

This option can either involve a **Client Secret** configured on the backend or rely on **Proof Key for Code Exchange (PKCE)** exchange.
The difference between the two is that the first option uses a private secret, on the backend, to get the access token.
Whereas the second one makes use of the **Proof Key for Code Exchange (PKCE)** flow to perform the token exchange.
Regardless of which authentication type you are using, in the end, the access token fetches the user info and logs them in.

- **OAuth/Access Tokens**

This option only applies to mobile/desktop apps.
The frontend obtains the Access Token and then sends it to the backend.
SuperTokens then fetches user info using the access token and logs them in.

<Tabs
  defaultValue="authorization-code"
  values={[
    { label: "Authorization Code", value: "authorization-code"},
    { label: "OAuth/Access Token", value: "token"}
  ]}
  lazy={true}
>
  <TabItem value="authorization-code">
    <Tabs>
      <Tab value="web">
        #### Redirecting to a social/single sign-on provider

The first step is to fetch the URL on which the user authenticates. You can do this by querying the backend API exposed by SuperTokens (as shown below). The backend SDK automatically appends the right query params to the URL (like scope, client ID etc). 

After getting the URL, redirect the user there. In the code below, an example of login with Google appears:

<Tabs>
<Tab value="npm">

```tsx

async function googleSignInClicked() {
    try {
        const authUrl = await getAuthorisationURLWithQueryParamsAndSetState({
            thirdPartyId: "google",

            // This is where Google should redirect the user back after login or error.
            // This URL goes on the Google's dashboard as well.
            frontendRedirectURI: "http://<YOUR_WEBSITE_DOMAIN>/auth/callback/google",
        });

        /*
        Example value of authUrl: https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email&access_type=offline&include_granted_scopes=true&response_type=code&client_id=1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com&state=5a489996a28cafc83ddff&redirect_uri=https%3A%2F%2Fsupertokens.io%2Fdev%2Foauth%2Fredirect-to-app&flowName=GeneralOAuthFlow
        */

        // we redirect the user to google for auth.
        window.location.assign(authUrl);
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function googleSignInClicked() {
    try {
        const authUrl = await supertokensThirdParty.getAuthorisationURLWithQueryParamsAndSetState({
            thirdPartyId: "google",

            // This is where Google should redirect the user back after login or error.
            // This URL goes on the Google's dashboard as well.
            frontendRedirectURI: "http://<YOUR_WEBSITE_DOMAIN>/auth/callback/google",
        });

        /*
        Example value of authUrl: https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email&access_type=offline&include_granted_scopes=true&response_type=code&client_id=1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com&state=5a489996a28cafc83ddff&redirect_uri=https%3A%2F%2Fsupertokens.io%2Fdev%2Foauth%2Fredirect-to-app&flowName=GeneralOAuthFlow
        */

        // we redirect the user to google for auth.
        window.location.assign(authUrl);
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

#### Handling the auth callback on your frontend

Once the third party provider redirects your user back to your app, you need to consume the information to sign in the user. This requires you to:
- Setup a route in your app that handles this callback. It's recommended to use something like `http://<YOUR_WEBSITE_DOMAIN>/auth/callback/google` (for Google). Regardless of what you make this path, remember to use that same path when calling the `getAuthorisationURLWithQueryParamsAndSetState` function in the first step.

- On that route, call the following function on page load

<Tabs>
<Tab value="npm">

```tsx

async function handleGoogleCallback() {
    try {
        const response = await signInAndUp();

        if (response.status === "OK") {
            console.log(response.user)
            if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                // sign up successful
            } else {
                // sign in successful
            }
            window.location.assign("/home");
        } else if (response.status === "SIGN_IN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else {
            // SuperTokens requires that the third party provider
            // gives an email for the user. If that's not the case, sign up / in
            // will fail.

            // As a hack to solve this, you can override the backend functions to create a fake email for the user.

            window.alert("No email provided by social login. Please use another form of login");
            window.location.assign("/auth"); // redirect back to login page
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function handleGoogleCallback() {
    try {
        const response = await supertokensThirdParty.signInAndUp();

        if (response.status === "OK") {
            console.log(response.user)
            if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                // sign up successful
            } else {
                // sign in successful
            }
            window.location.assign("/home");
        } else if (response.status === "SIGN_IN_UP_NOT_ALLOWED") {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else {
            // SuperTokens requires that the third party provider
            // gives an email for the user. If that's not the case, sign up / in
            // will fail.

            // As a hack to solve this, you can override the backend functions to create a fake email for the user.

            window.alert("No email provided by social login. Please use another form of login");
            window.location.assign("/auth"); // redirect back to login page
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>    

:::note
On success, the backend sends back session tokens as part of the response headers which are automatically handled by the frontend SDK.
:::

#### Special case for login with Apple



Unlike other providers, Apple does not redirect your user back to your frontend app. Instead, it redirects the user to your backend with a `FORM POST` request. This means that the URL you configure on Apple's dashboard should point to your backend API layer. Here, **middleware** handles the request and redirects the user to your frontend app. Your frontend app should then call the `signInAndUp` API on that page as shown previously.

To tell SuperTokens which frontend route to redirect the user back to, set the `frontendRedirectURI` to the frontend route. Also, set the `redirectURIOnProviderDashboard` to point to your backend API route, to which Apple sends a `POST` request.

<Tabs>
<Tab value="npm">

```tsx

async function appleSignInClicked() {
    try {
        const authUrl = await getAuthorisationURLWithQueryParamsAndSetState({
            thirdPartyId: "apple",

            frontendRedirectURI: "http://localhost:3000/auth/callback/apple", // This is an example callback URL on your frontend. You can use another path as well.
            // highlight-start
            redirectURIOnProviderDashboard: "<API_DOMAIN><API_BASE_PATH>/callback/apple", // This URL goes on the Apple's dashboard
            // highlight-end
        });

        // we redirect the user to apple for auth.
        window.location.assign(authUrl);
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>

<Tab value="scripts">

```tsx
async function appleSignInClicked() {
    try {
        const authUrl = await supertokensThirdParty.getAuthorisationURLWithQueryParamsAndSetState({
            thirdPartyId: "apple",

            frontendRedirectURI: "http://localhost:3000/auth/callback/apple", // This is an example callback URL on your frontend. You can use another path as well.
            // highlight-start
            redirectURIOnProviderDashboard: "<API_DOMAIN><API_BASE_PATH>/callback/apple", // This URL goes on the Apple's dashboard
            // highlight-end
        });

        /*
        Example value of authUrl: https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email&access_type=offline&include_granted_scopes=true&response_type=code&client_id=1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com&state=5a489996a28cafc83ddff&redirect_uri=https%3A%2F%2Fsupertokens.io%2Fdev%2Foauth%2Fredirect-to-app&flowName=GeneralOAuthFlow
        */

        // we redirect the user to google for auth.
        window.location.assign(authUrl);
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

:::info

If you are using the **Authorization Code Grant** flow with **PKCE** you do **not** need to provide a client secret during backend init.
This only works for providers which support the [PKCE flow](https://oauth.net/2/pkce/).

:::
      </Tab>
      <Tab value="mobile">
        ### Sign in with Apple example

<Tabs>

<Tab value="reactnative">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

For react native apps, this involves setting up the [react-native-apple-authentication library](https://github.com/invertase/react-native-apple-authentication) in your app. Check out their `README` for steps on how to integrate their `SDK` into your application. The minimum scope required by SuperTokens is the one that gives the user's email. In the case of Apple, that could be the user's actual email or the proxy email provided by Apple - it doesn't matter.

Once the integration is complete, you should call the `appleAuth.performRequest` function for iOS and the `appleAuthAndroid.signIn` function for Android. Either way, the result of the function is a one-time use auth code which you should send to your backend as shown in the next step.

A full example of this is available in [the example app](https://github.com/supertokens/supertokens-react-native/blob/master/examples/with-thirdparty/apple.ts).

In case you are using Expo, you can use the [expo-apple-authentication](https://docs.expo.dev/versions/latest/sdk/apple-authentication/) library instead (not that this library only works on iOS).

</Tabs.Section>

</Tab>

<Tab value="android">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

:::info
At the moment this flow is not supported on Android.
:::

</Tabs.Section>

</Tab>

<Tab value="ios">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

For iOS you use the normal sign in with apple flow and then use the authorization code to login with SuperTokens. You can see a full example of this in the `onAppleClicked` function in [the example app](https://github.com/supertokens/supertokens-ios/blob/master/examples/with-thirdparty/with-thirdparty/LoginScreen/LoginScreenViewController.swift).

```swift

void loginWithApple() async {
  try {
    var credential = await SignInWithApple.getAppleIDCredential(
        scopes: [
            AppleIDAuthorizationScopes.email,
            AppleIDAuthorizationScopes.fullName,
        ],
        // Required for Android only
        webAuthenticationOptions: WebAuthenticationOptions(
            clientId: "<CLIENT_ID>",
            redirectUri: Uri.parse(
            "<API_DOMAIN>/<API_BASE_PATH>/callback/apple",
            ),
        ),
    );

    String authorizationCode = credential.authorizationCode;
    String? idToken = credential.identityToken;
    String? email = credential.email;
    String? firstname = credential.givenName;
    String? lastName = credential.familyName;

    // Send the user information and auth code to the backend. Refer to the next step.
  } catch (e) {
    // Sign in aborted or failed
  }
}
```

In the snippet above for Android, you need an additional `webAuthenticationOptions` property when signing in with Apple.
This is because on Android the library uses the web login flow and requires the client id and redirection URI.
The `redirectUri` property here is the URL to which Apple makes a `POST` request after the user has logged in.
The SuperTokens backend SDKs provide an API for this at `<API_DOMAIN>/<API_BASE_PATH>/callback/apple`.

#### Additional steps for Android 

For android, a way for the web login flow to redirect back to the app is also needed. By default, the API provided by the backend `SDKs` redirects to the website domain you provide when initializing the `SDK`. The API can be overridden to redirect to the app instead. For example, if using the Node.js `SDK`:

<Tabs>

<Tab value="nodejs">

```tsx

ThirdParty.init({
    // highlight-start
    override: {
        apis: (original) => {
            return {
                ...original,
                appleRedirectHandlerPOST: async (input) => {
                    if (original.appleRedirectHandlerPOST === undefined) {
                        throw Error("Should never come here");
                    }

                    // inut.formPostInfoFromProvider contains all the query params attached by Apple
                    const stateInBase64 = input.formPostInfoFromProvider.state;

                    // The web SDKs add a default state
                    if (stateInBase64 === undefined) {
                        // Redirect to android app
                        // We create a dummy URL to create the query string
                        const dummyUrl = new URL("http://localhost:8080");
                        for (const [key, value] of Object.entries(input.formPostInfoFromProvider)) {
                            dummyUrl.searchParams.set(key, `${value}`);
                        }

                        const queryString = dummyUrl.searchParams.toString();
                        // Refer to the README of sign_in_with_apple to understand what this url is
                        const redirectUrl = `intent://callback?${queryString}#Intent;package=YOUR.PACKAGE.IDENTIFIER;scheme=signinwithapple;end`;

                        input.options.res.setHeader("Location", redirectUrl, false);
                        input.options.res.setStatusCode(303);
                        input.options.res.sendHTMLResponse("");
                    } else {
                        // For the web flow we can use the original implementation
                        original.appleRedirectHandlerPOST(input);
                    }
                },
            };
        },
    },
    // highlight-end
})
```

</Tab>

<Tab value="go">

```go

						options.Res.Header().Set("Location", redirectUri)
						options.Res.WriteHeader(http.StatusSeeOther)
						return nil
					} else {
						return originalAppleRedirectPost(formPostInfoFromProvider, options, userContext)
					}
				}

				return originalImplementation
			},
		},
		// highlight-end
	})
}
```

</Tab>

<Tab value="python">

```python
from supertokens_python.recipe import thirdparty
from supertokens_python.recipe.thirdparty.interfaces import APIInterface, APIOptions
from typing import Dict, Any

# highlight-start
def override_thirdparty_apis(original_implementation: APIInterface):
    original_apple_redirect_post = original_implementation.apple_redirect_handler_post

    async def apple_redirect_handler_post(
        form_post_info: Dict[str, Any],
        api_options: APIOptions,
        user_context: Dict[str, Any]
    ):
        # form_post_info contains all the query params attached by Apple
        state = form_post_info["state"]

        # The web SDKs add a default state
        if state is None:
            query_items = [
                f"{key}={value}" for key, value in form_post_info.items()
            ]

            query_string = "&".join(query_items)

            # Refer to the README of sign_in_with_apple to understand what this url is
            redirect_url = "intent://callback?" + query_string + "#Intent;package=YOUR.PACKAGE.IDENTIFIER;scheme=signinwithapple;end"

            api_options.response.set_header("Location", redirect_url)
            api_options.response.set_status_code(303)
            api_options.response.set_html_content("")
        else:
            return await original_apple_redirect_post(form_post_info, api_options, user_context)

    original_implementation.apple_redirect_handler_post = apple_redirect_handler_post
    return original_implementation
# highlight-end

thirdparty.init(
    # highlight-start
    override=thirdparty.InputOverrideConfig(
        apis=override_thirdparty_apis
    ),
    # highlight-end
)
```

</Tab>

</Tabs>

In the code above, the `appleRedirectHandlerPOST` API is overridden to check if the request came from the Android app. You can skip checking the state if you only have a mobile app and no website. `sign_in_with_apple` requires parsing the query params sent by Apple and including them in the redirect URL in a specific way. Then, redirect to the deep link URL. Refer to the README for `sign_in_with_apple` to read about the deep link setup required in Android.

</Tabs.Section>

</Tab>

</Tabs>

#### Calling the `signinup` API to consume the authorisation token



Once you have the authorization code from the auth provider, you need to call the `/signinup` API exposed by the backend `SDK` as shown below:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "thirdPartyId": "apple",
    "clientType": "...",
    "redirectURIInfo": {
        "redirectURIOnProviderDashboard": "<API_DOMAIN><API_BASE_PATH>/callback/apple",
        "redirectURIQueryParams": {
            "code": "...",
            "user": {
                "name":{
                    "firstName":"...",
                    "lastName":"..."
                },
                "email":"..."
            }
        }
    }
}'
```

:::important
- On iOS, the client id set in the backend should be the same as the bundle identifier for your app.
- The `clientType` input is optional and required only if you initialize more than one client in the provider on the backend (See the "Social / `SSO` login for both, web and mobile apps" section below).
- On iOS, `redirectURIOnProviderDashboard` doesn't matter and its value can be a universal link configured for your app.
- On Android, the `redirectURIOnProviderDashboard` should match the one configured on the Apple developer dashboard.
- The `user` object contains information provided by Apple.
:::

The response body from the API call has a `status` property in it:
- `status: "OK"`: User sign in / up was successful. The response also contains more information about the user, for example their user ID, and if it was a new user or existing user.
- `status: "NO_EMAIL_GIVEN_BY_PROVIDER"`: This status occurs if the social / `SSO` provider did not provide an email for the user. In this case, you want to ask the user to pick another method of sign in. Or, you can also override the backend functions to create a fake email for the user for this provider.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during `MFA`. The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

:::note
On success, the backend sends back session tokens as part of the response headers which are automatically handled by the frontend `SDK` for you.
:::

### Sign in with Google example

<Tabs>

<Tab value="reactnative">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

This involves setting up the [@react-native-google-signin/google-signin](https://github.com/react-native-google-signin/google-signin) in your app. Checkout their `README` for steps on how to integrate their `SDK` into your application. The minimum scope required by SuperTokens is the one that gives the user's email.

Once you configure the library, use `GoogleSignin.configure` and `GoogleSignin.signIn` to trigger the login flow and sign the user in with Google. Refer to [the example app](https://github.com/supertokens/supertokens-react-native/blob/master/examples/with-thirdparty/google.ts) to see the full code for this.

```tsx

export const performGoogleSignIn = async (): Promise<boolean> => {
  GoogleSignin.configure({
    webClientId: "GOOGLE_WEB_CLIENT_ID",
    iosClientId: "GOOGLE_IOS_CLIENT_ID",
  });

  try {
    const response = await GoogleSignin.signIn({});
    const authCode = response.data?.serverAuthCode;

    // Refer to step 2

    return true;
  } catch (e) {
    console.log("Google sign in failed with error", e);
  }

  return false;
};
```

</Tabs.Section>

</Tab>

<Tab value="android">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

Follow the [official Google Sign In guide](https://developers.google.com/identity/sign-in/android/start-integrating) to set up their library and sign the user in with Google. Fetch the authorization code from the Google sign-in result. For a full example, refer to the `signInWithGoogle` function in [the example app](https://github.com/supertokens/supertokens-android/blob/master/examples/with-thirdparty/app/src/main/java/com/supertokens/supertokensexample/LoginActivity.kt).

```kotlin

Future<void> loginWithGoogle() async {
    GoogleSignIn googleSignIn;

    if (Platform.isAndroid) {
      googleSignIn = GoogleSignIn(
        serverClientId: "GOOGLE_WEB_CLIENT_ID",
        scopes: [
          'email',
        ],
      );
    } else {
      googleSignIn = GoogleSignIn(
        clientId: "GOOGLE_IOS_CLIENT_ID",
        serverClientId: "GOOGLE_WEB_CLIENT_ID",
        scopes: [
          'email',
        ],
      );
    }

    GoogleSignInAccount? account = await googleSignIn.signIn();

    if (account == null) {
        print("Google sign in was aborted");
        return;
    }

    String? authCode = account.serverAuthCode;

    if (authCode == null) {
        print("Google sign in did not return a server auth code");
        return;
    }

    // Refer to step 2
  }
```

</Tabs.Section>

</Tab>

</Tabs>

<h4>Step 2) Calling the `signinup` API to consume the authorisation token</h4>



Once you have the authorization code from the auth provider, you need to call the `signinup` API exposed by the backend `SDK` as shown below:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "thirdPartyId": "google",
    "clientType": "...",
    "redirectURIInfo": {
        "redirectURIOnProviderDashboard": "",
        "redirectURIQueryParams": {
            "code": "...",
        }
    }
}'
```

:::important
When calling the API exposed by the SuperTokens backend `SDK`, pass an empty string for `redirectURIOnProviderDashboard`.
The native login flow using the authorization code does not involve any redirection on the frontend.
:::

The response body from the API call has a `status` property in it:
- `status: "OK"`: User sign in / up was successful. The response also contains more information about the user, for example their user ID, and if it was a new user or existing user.
- `status: "NO_EMAIL_GIVEN_BY_PROVIDER"`: This status occurs if the social / `SSO` provider did not provide an email for the user. In this case, you want to ask the user to pick another method of sign in. Or, you can also override the backend functions to create a fake email for the user for this provider.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during `MFA`. The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

:::note
On success, the backend sends back session tokens as part of the response headers which are automatically handled by the frontend `SDK` for you.
:::

### Authorization code grant flow with `PKCE`

This is similar to the first one, except that you do **not** need to provide a client secret during backend init.
This flow only works for providers which support the [`PKCE` flow](https://oauth.net/2/pkce/).

<Tabs>

<Tab value="reactnative">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

You can use the [react native auth library](https://github.com/FormidableLabs/react-native-app-auth) to also return the `PKCE` code verifier along with the authorization code. Achieve this by setting the `usePKCE` boolean to `true` and also by setting the `skipCodeExchange` to `true` when configuring the react native auth library.

</Tabs.Section>

</Tab>

<Tab value="android">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

You can use the [AppAuth-Android](https://github.com/openid/AppAuth-Android) library to use the `PKCE` flow by using the `setCodeVerifier` method when creating a `AuthorizationRequest`.

</Tabs.Section>

</Tab>

<Tab value="ios">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

You can use the [AppAuth-iOS](https://github.com/openid/AppAuth-iOS) library to use the `PKCE` flow.

</Tabs.Section>

</Tab>

<Tab value="flutter">

<Tabs.Section>

#### Fetching the authorisation token on the frontend

You can use [`flutter_appauth`](https://pub.dev/packages/flutter_appauth) to use the `PKCE` flow by providing a `codeVerifier` when you call the `appAuth.token` function.

</Tabs.Section>

</Tab>

</Tabs>

#### Calling the `signinup` API to consume the authorisation token



Once you have the authorization code and `PKCE` verifier from the auth provider, you need to call the `/signinup` API exposed by the backend `SDK` as shown below:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thirdPartyId": "THIRD_PARTY_ID",
    "clientType": "...",
    "redirectURIInfo": {
        "redirectURIOnProviderDashboard": "REDIRECT_URI",
        "redirectURIQueryParams": {
            "code": "...",
        },
        "pkceCodeVerifier": "..."
    }
}'
```

:::important
- Replace `THIRD_PARTY_ID` with the provider id. The provider id must match the one you configure in the backend when initialising SuperTokens.
- `REDIRECT_URI` must exactly match the value you configure on the providers dashboard.
:::

The response body from the API call has a `status` property in it:
- `status: "OK"`: User sign in / up was successful. The response also contains more information about the user, for example their user ID, and if it was a new user or existing user.
- `status: "NO_EMAIL_GIVEN_BY_PROVIDER"`: This status occurs if the social / `SSO` provider did not provide an email for the user. In this case, you want to ask the user to pick another method of sign in. Or, you can also override the backend functions to create a fake email for the user for this provider.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during `MFA`. The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

:::note
On success, the backend sends back session tokens as part of the response headers which are automatically handled by the frontend `SDK` for you.
:::
      </Tab>
    </Tabs>
  </TabItem>
  <TabItem value="token">
    <Tabs>
      <Tab value="web">
    :::info

    This flow is not applicable for web apps.

    :::
      </Tab>
      <Tab value="mobile">
        ### Fetching the OAuth/Access tokens on the frontend

1. Sign in with the social provider. The minimum required scope is the one that provides access to the user's email. You can use any library to sign in with the social provider.
2. Get the access token on the frontend if it is available.
3. Get the id token from the sign in result if it is available.

:::important
You need to provide either the access token or the id token, or both in step 2, depending on what is available.
:::

### Calling the `signinup` API to use the OAuth tokens

Once you have the `access_token` or the `id_token` from the auth provider, you need to call the `/signinup` API exposed by the backend `SDK` as shown below:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "thirdPartyId": "google",
    "clientType": "...",
    "oAuthTokens": {
        "access_token": "...",
        "id_token": "..."
    },
}'
```

:::important
- The `clientType` input is optional, and you need it only if you have initialised more than one client in the provide on the backend (See the "Social / Single Sign-On login for both, web and mobile apps" section below).
- If you have the `id_token`, you can send that along with the `access_token`.
:::

The response body from the API call has a `status` property in it:
- `status: "OK"`: User sign in / up was successful. The response also contains more information about the user, for example their user ID, and if it was a new user or existing user.
- `status: "NO_EMAIL_GIVEN_BY_PROVIDER"`: This occurs if the social / Single Sign-On provider did not provide an email for the user. In this case, you want to ask the user to pick another method of sign in. Or, you can also override the backend functions to create a fake email for the user for this provider.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.
- `status: "SIGN_IN_UP_NOT_ALLOWED"`: This can happen during automatic account linking or during `MFA`. The `reason` prop that's in the response body contains a support code using which you can see why the sign in / up was not allowed.

:::note
On success, the backend sends back session tokens as part of the response headers which are automatically handled by the frontend `SDK` for you.
:::
      </Tab>
  </Tabs>
</TabItem>

</Tabs>

### 3. Initialize the backend SDK

You have to initialize the **Backend Software Development Kit (SDK)** alongside the code that starts your server.
The init call includes [configuration details](/docs/references/backend-sdks/reference#sdk-configuration) for your app. It specifies how the backend connects to the **SuperTokens Core**, as well as the **Recipes** used in your setup.

<Tabs>

<Tab value="nodejs">

```tsx title="Backend SDK Init" showAppTypeSelect
// highlight-next-line

supertokens.init({
    // Replace this with the framework you are using
    framework: "express",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io^{derived.appIdPathname}",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/references/backend-sdks/reference#sdk-configuration
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>",
    },
    recipeList: [
        // highlight-start
        ThirdParty.init({/*TODO: See next step*/}),
        // highlight-end
        Session.init() 
    ]
});
```

</Tab>

<Tab value="python">

```python title="Backend SDK Init" showAppTypeSelect
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import thirdparty, session
# highlight-next-line

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io^{derived.appIdPathname}",
        # api_key: <YOUR_API_KEY>
    ),
    framework='fastapi',
    recipe_list=[
        session.init(), # initializes session features
        thirdparty.init(
           # TODO: See next step
        ) # type: ignore
    ],
    mode='asgi' # use wsgi if you are running using gunicorn
)
```

</Tab>

<Tab value="go">

```go title="Backend SDK Init" showAppTypeSelect

### 4. Add the authentication providers

Populate the `providers` array with the third party authentication providers that you want.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        ThirdParty.init({
            //highlight-start
            signInAndUpFeature: {
                // We have provided you with development keys which you can use for testing.
                // IMPORTANT: Please replace them with your own OAuth keys for production use.
                providers: [{
                    config: {
                        thirdPartyId: "google",
                        clients: [{
                            clientId: "1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com",
                            clientSecret: "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"
                        }]
                    }
                }, {
                    config: {
                        thirdPartyId: "github",
                        clients: [{
                            clientId: "467101b197249757c71f",
                            clientSecret: "e97051221f4b6426e8fe8d51486396703012f5bd"
                        }]
                    }
                }, {
                    config: {
                        thirdPartyId: "apple",
                        clients: [{
                            clientId: "4398792-io.supertokens.example.service",
                            additionalConfig: {
                                keyId: "7M48Y4RYDL",
                                privateKey:
                                    "-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgu8gXs+XYkqXD6Ala9Sf/iJXzhbwcoG5dMh1OonpdJUmgCgYIKoZIzj0DAQehRANCAASfrvlFbFCYqn3I2zeknYXLwtH30JuOKestDbSfZYxZNMqhF/OzdZFTV0zc5u5s3eN+oCWbnvl0hM+9IW0UlkdA\n-----END PRIVATE KEY-----",
                                teamId: "YWQCXGJRJL",
                            }
                        }]
                    }
                }],
            }
            //highlight-end
        }),
        // ...
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "google",
                            clients: [{
                                clientId: "TODO: GOOGLE_CLIENT_ID",
                                clientSecret: "TODO: GOOGLE_CLIENT_SECRET",
                                scope: ["scope1", "scope2"]
                            }]
                        }
                    }
                ]
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go

</CustomUIInstructions>


Having completed the main setup, you can explore more advanced topics related to the **ThirdParty** recipe.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/social/built-in-providers-config">
    <ReferenceCard.Title>
      Built-in Providers
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Read more about the common providers exposed by the recipe.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/social/custom-providers">
    <ReferenceCard.Title>
      Custom Providers
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      See how you can create your own custom provider.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/social/custom-invite-flow">
    <ReferenceCard.Title>
      Custom Invite Flow
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Disable public sign ups and use your own invite flow.
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/authentication/social/hooks-and-overrides">
    <ReferenceCard.Title>
      Hooks and Overrides
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Add custom logic after the logs in or signs up.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Authentication - Social Login -  Built-in providers
Source: https://supertokens.com/docs/authentication/social/built-in-providers

This page shows a full list of all the built-in providers exposed by **SuperTokens**.

<TenantType.Switch />

<TenantType.SingleTenantContent>

## Google

To generate your client ID and secret follow the [official documentation](https://support.google.com/cloud/answer/6158849?hl=en).
Set the authorisation callback URL to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/callback/google`

<Tabs>

<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "google",
                            clients: [{
                                clientId: "1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps.googleusercontent.com",
                                clientSecret: "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",
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Google workspaces

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "google-workspaces",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO",
                                additionalConfig: {
                                    "hd": "example.com"
                                }
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Apple

To generate your client ID and secret follow [this article](https://medium.com/identity-beyond-borders/how-to-configure-sign-in-with-apple-77c61e336003).
Set the authorisation callback URL to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/callback/apple`.
Note that Apple doesn't allow `localhost` in the URL.
If you are in `dev` mode, you can use the `dev` keys provided above.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "apple",
                            clients: [{
                                clientId: "4398792-io.supertokens.example.service",
                                additionalConfig: {
                                    "keyId":      "7M48Y4RYDL",
                                    "privateKey": "-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgu8gXs+XYkqXD6Ala9Sf/iJXzhbwcoG5dMh1OonpdJUmgCgYIKoZIzj0DAQehRANCAASfrvlFbFCYqn3I2zeknYXLwtH30JuOKestDbSfZYxZNMqhF/OzdZFTV0zc5u5s3eN+oCWbnvl0hM+9IW0UlkdA\n-----END PRIVATE KEY-----",
                                    "teamId":     "YWQCXGJRJL",
                                },
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Discord

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "discord",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Facebook

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "facebook",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## GitHub

To generate your client ID and secret follow the [official documentation](https://docs.github.com/en/developers/apps/creating-an-oauth-app).
Set the authorisation callback URL to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/callback/github`

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "github",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## GitLab

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "gitlab",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }],
                            oidcDiscoveryEndpoint: "https://gitlab.example.com/.well-known/openid-configuration",
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Twitter

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "twitter",
                            clients: [{
                                clientId: "4398792-WXpqVXRiazdRMGNJdEZIa3RVQXc6MTpjaQ",
                                clientSecret: "BivMbtwmcygbRLNQ0zk45yxvW246tnYnTFFq-LH39NwZMxFpdC"
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## LinkedIn

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "linkedin",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }]
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Okta

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "okta",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }],
                            oidcDiscoveryEndpoint: "https://dev-<id>.okta.com/.well-known/openid-configuration",
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## SAML

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "boxy-saml",
                            name: "<provider-name>", // Replace with the correct provider name
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO",
                                additionalConfig: {
                                    "boxyURL": "<TODO: Example: http://domain.example.com:5225/>"
                                }
                            }],
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

## Active Directory

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [
                    {
                        config: {
                            thirdPartyId: "active-directory",
                            clients: [{
                                clientId: "TODO",
                                clientSecret: "TODO"
                            }],
                            oidcDiscoveryEndpoint: "https://login.microsoftonline.com/<directoryId>/v2.0/.well-known/openid-configuration",
                        }
                    }
                ]
            }
        }), // initializes signin / sign up features 
    ]
});
```

</Tab>
<Tab value="go">

```go

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

Call the following function / API to add the third party provider to a specific tenant.

## Google

To generate your client ID and secret follow the [official documentation](https://support.google.com/cloud/answer/6158849?hl=en)

<Tabs additionalValues={[{ value: "dashboard", label: "Dashboard" }, { value: "curl", label: "cURL" }]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "google",
        name: "Google",
        clients: [{
            clientId: "...",
            clientSecret: "..."
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Google workspaces

<Tabs additionalValues={[{ value: "dashboard", label: "Dashboard" }, { value: "curl", label: "cURL" }]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "google-workspaces",
        name: "Google Workspaces",
        clients: [{
            clientId: "...",
            clientSecret: "...",
            additionalConfig: {
                "hd": "example.com",
            }
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Apple

To generate your client ID and secret follow [this article](https://medium.com/identity-beyond-borders/how-to-configure-sign-in-with-apple-77c61e336003)
Note that Apple doesn't allow `localhost` in the URL.
If you are in `dev` mode, you can use the `dev` keys provided above.

Call the following function / API to add the third party provider to a specific tenant.

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "apple",
        name: "Apple",
        clients: [{
            clientId: "...",
            additionalConfig: {
                "keyId":      "...",
                "privateKey": "...",
                "teamId":     "...",
            }
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Discord

<Tabs additionalValues={[{ value: "dashboard", label: "Dashboard" }, { value: "curl", label: "cURL" }]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "discord",
        name: "Discord",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Facebook

<Tabs additionalValues={[{ value: "dashboard", label: "Dashboard" }, { value: "curl", label: "cURL" }]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "facebook",
        name: "Facebook",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## GitHub

To generate your client ID and secret follow the [official documentation](https://docs.github.com/en/developers/apps/creating-an-oauth-app)

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "github",
        name: "GitHub",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## GitLab

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "gitlab",
        name: "GitLab",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }],
        oidcDiscoveryEndpoint: "https://gitlab.example.com/.well-known/openid-configuration",
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Twitter

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "twitter",
        name: "Twitter",
        clients: [{
            clientId: "4398792-WXpqVXRiazdRMGNJdEZIa3RVQXc6MTpjaQ",
            clientSecret: "BivMbtwmcygbRLNQ0zk45yxvW246tnYnTFFq-LH39NwZMxFpdC",
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## LinkedIn

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "linkedin",
        name: "LinkedIn",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }]
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Okta

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "okta",
        name: "Okta",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }],
        oidcDiscoveryEndpoint: "https://dev-<id>.okta.com/.well-known/openid-configuration",
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## SAML

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "boxy-saml",
        name: "<provider-name>",
        clients: [{
            clientId: "...",
            clientSecret: "...",
            additionalConfig: {
                "boxyURL": "<TODO: Example: http://domain.example.com:5225/>",
            }
        }],
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

## Active Directory

<Tabs>
<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "active-directory",
        name: "Active Directory",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }],
        oidcDiscoveryEndpoint: "https://login.microsoftonline.com/<directoryId>/v2.0/.well-known/openid-configuration",
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

</TenantType.MultiTenantContent>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/social/custom-providers" label="Custom providers" />
  <ReferenceCard href="/docs/authentication/social/add-multiple-clients-for-the-same-provider" label="Multiple clients on the same provider" />
  <ReferenceCard href="/docs/authentication/social/custom-invite-flow" label="Invite based sign up" />
  <ReferenceCard href="/docs/authentication/social/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Social Login -  ## Overview
Source: https://supertokens.com/docs/authentication/social/custom-providers

If you can't find a provider in [the built-in list](/docs/authentication/social/built-in-providers-config), you can add your own custom implementation as shown below.

:::info Note
If you think that SuperTokens should support this provider by default, make sure to let the team know [on GitHub](https://github.com/supertokens/supertokens-node/issues/88).
:::

---

## Create a custom provider

### 1. Render the authentication method in the authentication UI



<PrebuiltUIInstructions>

<Tabs>
<Tab value="reactjs">

Include the provider in the `providers` array in the frontend SDK.

```tsx
SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                // highlight-start
                providers: [
                    {
                        id: "custom",
                        name: "X", // Will display "Continue with X"

                        // optional
                        // you do not need to add a click handler to this as
                        // we add it for you automatically.
                        buttonComponent: (props: {name: string}) => <div style={{
                            cursor: "pointer",
                            border: "1",
                            paddingTop: "5px",
                            paddingBottom: "5px",
                            borderRadius: "5px",
                            borderStyle: "solid"
                        }}>{"Login with " + props.name}</div>
                    }
                ],
                // highlight-end
                // ...
            },
            // ...
        }),
        // ...
    ]
});
```
</Tab>

<Tab value="angular">

:::caution
This is impossible for non-react apps at the moment. Please use custom UI instead for the sign in form.
:::

</Tab>

<Tab value="vue">

:::caution
This is impossible for non-react apps at the moment. Please use custom UI instead for the sign in form.
:::

</Tab>
</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

You need to build your own UI listing the buttons for each of the social login providers you want your users to use. See [the implementation details page](../../custom-ui/thirdparty-login) for what to do after a user clicks one of the buttons.

</CustomUIInstructions>

### 2. Configure the credentials

<Tabs values={[{ label: "With OAuth endpoints", value: "OAuth" }, { label: "With OpenID Connect (OIDC) endpoints", value: "OIDC" }]}>
    
<TabItem value="OAuth">

You can define a custom provider in a couple of ways. The simplest method is to provide the configuration for the `AuthorizationEndpoint`, `TokenEndpoint`, and the mapping for how the user's ID and email from the provider's profile information endpoint. This appears below:

<Tabs additionalValues={[{ label: "Dashboard", value: "dashboard" }, { label: "cURL", value: "curl" }]}>

<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                // highlight-start
                providers: [{
                    config: {
                        thirdPartyId: "custom",
                        name: "Custom provider",
                        clients: [{
                            clientId: "...",
                            clientSecret: "...",
                            scope: ["profile", "email"]
                        }],
                        authorizationEndpoint: "https://example.com/oauth/authorize",
                        authorizationEndpointQueryParams: {
                            "someKey1": "value1",
                            "someKey2": null
                        },
                        tokenEndpoint: "https://example.com/oauth/token",
                        tokenEndpointBodyParams: {
                            "someKey1": "value1",
                        },
                        userInfoEndpoint: "https://example.com/oauth/userinfo",
                        userInfoMap: {
                            fromUserInfoAPI: {
                                userId: "id",
                                email: "email",
                                emailVerified: "email_verified",
                            }
                        }
                    }
                }]
                // highlight-end
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

```go

<img src="/img/dashboard/tenant-management/third-party-providers.png" alt="Social/Enterprise providers"/>

Select **Add Custom Provider** option

<img src="/img/dashboard/tenant-management/new-provider.png" alt="New Provider"/>

Fill in the details as shown below and click on **Save**

<img src="/img/dashboard/tenant-management/new-oauth-provider.png" alt="OAuth2 provider"/>

</Tab>

</Tabs>

| Configuration Field | Description | Example |
|---|---|---|
| `thirdPartyId` | Unique identifier for the provider | For Google: `"google"` |
| `name` | Display name used on the frontend login button | Setting `"XYZ"` shows "Login using XYZ" |
| `clients` | Array of client credentials for frontend clients | Multiple entries needed for web/mobile apps with different credentials. Include `clientType` if using multiple clients |
| `AuthorizationEndpoint` | URL for user login | Google: `"https://accounts.google.com/o/oauth2/v2/auth"` |
| `AuthorizationEndpointQueryParams` | Optional configuration to modify query parameters | Can add, modify, or remove (using null) query params |
| `TokenEndpoint` | API endpoint for exchanging Authorization Code | Google: `"https://oauth2.googleapis.com/token"` |
| `TokenEndpointBodyParams` | Optional configuration to modify request body | Can add, modify, or remove (using null) body params |
| `UserInfoEndpoint` | API endpoint for getting user information | Google: `"https://www.googleapis.com/oauth2/v1/userinfo"` |
| `UserInfoMap.FromUserInfoAPI` | Maps provider's JSON response fields to user info | Example mapping:<br/>`userId: "id"`<br/>`email: "email"`<br/>`emailVerified: "email_verified"`<br/>For nested values use: `userId: "user.id"` |

</TabItem>
<TabItem value="OIDC">

If the provider is Open ID Connect (OIDC) compatible, you can provide URL for the `OIDCDiscoverEndpoint` configuration. The backend SDK automatically discovers authorization endpoint, token endpoint and the user info endpoint by querying the `<OIDCDiscoverEndpoint>/.well-known/openid-configuration`.

Below is an example of how to set the OIDC discovery endpoint:

<Tabs additionalValues={[{ label: "Dashboard", value: "dashboard" }, { label: "cURL", value: "curl" }]}>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                // highlight-start
                providers: [{
                    config: {
                        thirdPartyId: "custom",
                        name: "Custom provider",
                        clients: [{
                            clientId: "...",
                            clientSecret: "...",
                            scope: ["profile", "email"]
                        }],
                        // highlight-start
                        oidcDiscoveryEndpoint: "https://example.com/.well-known/openid-configuration",
                        // highlight-end
                        authorizationEndpointQueryParams: {
                            "someKey1": "value1",
                            "someKey2": null
                        },
                        userInfoMap: {
                            fromIdTokenPayload: {
                                userId: "id",
                                email: "email",
                                emailVerified: "email_verified",
                            }
                        }
                    }
                }]
                // highlight-end
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

```go

<img src="/img/dashboard/tenant-management/third-party-providers.png" alt="Social/Enterprise providers"/>

Select **Add Custom Provider** option

<img src="/img/dashboard/tenant-management/new-provider.png" alt="New Provider"/>

Fill in the details as shown below and click on **Save**

<img src="/img/dashboard/tenant-management/new-oidc-provider.png" alt="OAuth2 provider"/>

</Tab>

</Tabs>

- The configuration values are similar to the ones in the "Via OAuth endpoints" method. Please read that section to understand the `thirdPartyId`, `name`, `clients` configuration.
- Unlike the "Via OAuth endpoints", you can obtain the user's info from the ID token payload using the configuration specified by you in the `UserInfoMap.FromIdTokenPayload` map.
- You can also add the `UserInfoMap.FromUserInfoAPI` map as done in the "Via OAuth endpoints" section. SuperTokens auto merges the user information.

</TabItem>
</Tabs>

---

## Handle non standard providers.

Sometimes, one of the steps in the providers interaction may not be per a standard. Therefore, providing the configuration like shown above may not work. To handle this case, you can override any of the steps that happen during the OAuth exchange.

For example, the API call made to get the user's profile info makes a `GET` call to the `UserInfoEndpoint` with the user's access token. If your provider requires a different method or requires multiple calls to different endpoints to get the profile info, then you can override the default implementation as shown below:

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [{
                    config: {
                        thirdPartyId: "custom",
                        name: "Custom provider",
                        clients: [{
                            clientId: "...",
                            clientSecret: "...",
                            scope: ["profile", "email"]
                        }],
                        authorizationEndpoint: "https://example.com/oauth/authorize",
                        authorizationEndpointQueryParams: {
                            "response_type": "token", // Changing an existing parameter
                            "response_mode": "form", // Adding a new parameter
                            "scope": null,    // Removing a parameter
                        },
                        tokenEndpoint: "https://example.com/oauth/token"
                    },
                    // highlight-start
                    override: (originalImplementation) => {
                        return {
                            ...originalImplementation,
                            getUserInfo: async function (input) {
                                // Call provider's APIs to get profile info
                                // ...
                                return {
                                    thirdPartyUserId: "...",
                                    email: {
                                        id: "...",
                                        isVerified: true
                                    },
                                    rawUserInfoFromProvider: {
                                        fromUserInfoAPI: {
                                            "first_name": "...",
                                            "last_name": "..."
                                        },
                                    }
                                }
                            }
                        }
                    }
                    // highlight-end
                }]
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

```go

2. `GetAuthorisationRedirectURL`

    This function returns the full URL (along with query params) to which the user needs to navigate to log in.

3. `ExchangeAuthCodeForOAuthTokens`

    This function is responsible for exchanging one time use `Authorization Code` with the user's tokens, such as `Access Token`, `ID Token`, etc.

4. `GetUserInfo`

    This function is responsible for fetching the user information such as `UserId`, `Email` and `EmailVerified` using the tokens returned from the previous function.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/user-management/common-actions" label="Get user info from the third party provider" />
  <ReferenceCard href="/docs/authentication/enterprise/introduction" label="Multi-tenancy authentication" />
  <ReferenceCard href="/docs/authentication/social/custom-providers" label="Built-in providers" />
  <ReferenceCard href="/docs/authentication/social/add-multiple-clients-for-the-same-provider" label="Multiple clients on the same provider" />
  <ReferenceCard href="/docs/authentication/social/custom-invite-flow" label="Invite based sign up" />
  <ReferenceCard href="/docs/authentication/social/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Social Login -  Hooks and overrides
Source: https://supertokens.com/docs/authentication/social/hooks-and-overrides

**SuperTokens** exposes a set of constructs that allow you to trigger different actions during the authentication lifecycle or to even fully customize the logic based on your use case. 
The following sections describe how you can adjust the `thirdparty` recipe to your needs.

Explore the [references pages](/docs/references) for a more in depth guide on hooks and overrides.

## Frontend hook



<PrebuiltUIInstructions>

This method gets fired, with the `SUCCESS` action, immediately after a successful sign in or sign up.
Follow the code snippet to determine if the user is signing up or signing in.

With this method you can fire events immediately after a successful sign in.
You can use it to send analytics events. 

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        ThirdParty.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "SUCCESS") {
                    if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                        // TODO: Sign up
                    } else {
                        // TODO: Sign in
                    }
                }
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIThirdParty.init({
            // highlight-start
            onHandleEvent: async (context) => {
                if (context.action === "SUCCESS") {
                    if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                        // TODO: Sign up
                    } else {
                        // TODO: Sign in
                    }
                }
            }
            // highlight-end
        }),
        supertokensUISession.init()
    ]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

:::caution Not applicable
This section is not applicable for custom UI since you are calling the `signInUp` API yourself anyway. You can do anything you want post `signIn` / `signUp` based on the result of the API call.
:::

</CustomUIInstructions>

## Backend override

Overriding the `signInUp` function allows you to introduce your own logic for the sign in process.
Use it to persist different types of data or trigger actions.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [/* ... */]
            },
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signInUp: async function (input) {

                            // First we call the original implementation of signInUp.
                            let response = await originalImplementation.signInUp(input);

                            // Post sign up response, we check if it was successful
                            if (response.status === "OK") {
                                let { id, emails } = response.user;

                                // This is the response from the OAuth 2 provider that contains their tokens or user info.
                                let providerAccessToken = response.oAuthTokens["access_token"];
                                let firstName = response.rawUserInfoFromProvider.fromUserInfoAPI!["first_name"];

                                if (input.session === undefined) {
                                    if (response.createdNewRecipeUser && response.user.loginMethods.length === 1) {
                                        // TODO: Post sign up logic
                                    } else {
                                        // TODO: Post sign in logic
                                    }
                                }
                            }
                            return response;
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```
</Tab>
<Tab value="go">

```go
            provider_access_token = result.oauth_tokens["access_token"]
            print(provider_access_token)

            if result.raw_user_info_from_provider.from_user_info_api is not None:
                first_name = result.raw_user_info_from_provider.from_user_info_api[
                    "first_name"
                ]
                print(first_name)

            if session is None:
                if (
                    result.created_new_recipe_user
                    and len(result.user.login_methods) == 1
                ):
                    print("New user was created")
                    # TODO: Post sign up logic
                else:
                    print("User already existed and was signed in")
                    # TODO: Post sign in logic

        return result

    original_implementation.sign_in_up = sign_in_up

    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        thirdparty.init(
            # highlight-start
            override=thirdparty.InputOverrideConfig(
                functions=override_thirdparty_functions
            ),
            # highlight-end
            sign_in_and_up_feature=thirdparty.SignInAndUpFeature(providers=[]),
        )
    ],
)
```

</Tab>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/references/frontend-sdks/function-overrides" label="Frontend function overrides" />
  <ReferenceCard href="/docs/references/frontend-sdks/hooks" label="Frontend hooks" />
  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/override-react-components" label="React component override" />
  <ReferenceCard href="/docs/references/backend-sdks/function-overrides" label="Backend function overrides" />
  <ReferenceCard href="/docs/references/backend-sdks/api-overrides" label="Backend API overrides" />
  <ReferenceCard href="/docs/authentication/social/custom-invite-flow" label="Invite based sign up" />
</ReferenceCard.Grid>

# Authentication - Social Login -  Add multiple clients for the same provider
Source: https://supertokens.com/docs/authentication/social/add-multiple-clients-for-the-same-provider

## Overview

If you use a third-party login method for your web and mobile app, then you might need to setup different Client ID/Secret for the same provider on the backend.
For example, in case of Apple login, Apple gives you different client IDs for iOS login vs web & Android login (same client ID for web and Android).

## Before you start

This guide assumes that you have already implemented the [EmailPassword recipe](/docs/authentication/email-password/introduction) and have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

## Steps

### 1. Update the backend configuration

Add more clients to the Apple.init on the backend.
Each client would need to be uniquely identified, and you achieve this using the `clientType` string.
For example, you can add one `clientType` for `web-and-android` and one for `ios`.

<Tabs>

<Tab value="nodejs">

```tsx

let providers: ProviderInput[] = [
    {
        config: {
            thirdPartyId: "apple",
            clients: [{
                clientType: "web-and-android",
                clientId: "...",
                additionalConfig: {
                    "keyId": "...",
                    "privateKey": "...",
                    "teamId": "...",
                }
            }, {
                clientType: "ios",
                clientId: "...",
                additionalConfig: {
                    "keyId": "...",
                    "privateKey": "...",
                    "teamId": "...",
                }
            }]
        }
    }
]
```

</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    // highlight-next-line
    clientType: "web-and-android",
    recipeList: [/*...*/],
});
```

<Tabs.Section>

If you are using the pre-built UI SDK (SuperTokens-auth-react) as well, you can provide the `clientType` configuration to it as follows:

</Tabs.Section>

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    // highlight-next-line
    clientType: "web-and-android",
    recipeList: [/*...*/],
});
```

</Tab>

<Tab value="scripts">

<Tabs.Section>

We pass in the `clientType` during the init call.

</Tabs.Section>

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    // highlight-next-line
    clientType: "web-and-android",
    recipeList: [/*...*/],
});
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

When making calls to the APIs from your mobile app, the request body also takes a `clientType` prop as seen in the above API calls.

</Tab>
</Tabs>


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/social/custom-providers" label="Custom providers" />
  <ReferenceCard href="/docs/authentication/social/custom-invite-flow" label="Invite based sign up" />
  <ReferenceCard href="/docs/authentication/social/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Social Login -  Implement a custom invite flow
Source: https://supertokens.com/docs/authentication/social/custom-invite-flow

## Overview

This guide shows you how to disable public sign ups to allow only certain people to access your app.
From a third-party login perspective, you need to maintain an allow list of emails and validate the users based on it. 

## Before you start

The tutorial assumes that you already have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

### Prerequisites

This guide uses the `UserMetadata` recipe to store the allow list.
You need to [enable it](/docs/post-authentication/user-management/user-metadata) in the SDK initialization step.

## Steps

### 1. Implement the allow list

You can store this list in your own database, or use the metadata feature provided by SuperTokens to store this.
This may seem like a strange use case of the user metadata recipe provided, but it works.

The following code samples show you how to save the allow list in the user metadata.

<Tabs>
<Tab value="nodejs">

```tsx

async function addEmailToAllowlist(email: string) {
    let existingData = await UserMetadata.getUserMetadata("emailAllowList");
    let allowList: string[] = existingData.metadata.allowList || [];
    allowList = [...allowList, email];
    await UserMetadata.updateUserMetadata("emailAllowList", {
        allowList
    });
}

async function isEmailAllowed(email: string) {
    let existingData = await UserMetadata.getUserMetadata("emailAllowList");
    let allowList: string[] = existingData.metadata.allowList || [];
    return allowList.includes(email);
}
```

</Tab>
<Tab value="go">

```go
:::

### 2. Check if the email is allowed

Update the backend SDK API function to only allow sign up requests from users that are on the allow list.
To do this you need to use the check functions from the previous code snippet.

<Tabs>
<Tab value="nodejs">

```tsx
declare let isEmailAllowed: (email: string) => Promise<boolean> // REMOVE_FROM_OUTPUT

ThirdParty.init({
    override: {
        functions: (originalImplementation) => {
            return {
                ...originalImplementation,
                signInUp: async function (input) {
                    let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                        email: input.email
                    });
                    if (existingUsers.length === 0) {
                        // this means that the email is new and is a sign up
                        if (!(await isEmailAllowed(input.email))) {
                            // email is not in allow list, so we disallow
                            throw new Error("No sign up")
                        }
                    }
                    // We allow the sign in / up operation
                    return originalImplementation.signInUp(input);
                }
            }
        },
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                signInUpPOST: async function (input) {
                    try {
                        return await originalImplementation.signInUpPOST!(input);
                    } catch (err: any) {
                        if (err.message === "No sign up") {
                            // this error was thrown from our function override above.
                            // so we send a useful message to the user
                            return {
                                status: "GENERAL_ERROR",
                                message: "Sign ups are disabled. Please contact the admin."
                            }
                        }
                        throw err;
                    }
                }
            }
        }
    }
})
```

</Tab>
<Tab value="go">

```go
	return false, nil
}

func main() {
	thirdparty.Init(&tpmodels.TypeInput{
		Override: &tpmodels.OverrideStruct{
			Functions: func(originalImplementation tpmodels.RecipeInterface) tpmodels.RecipeInterface {
				ogThirdPartySignInUp := *originalImplementation.SignInUp

				(*originalImplementation.SignInUp) = func(thirdPartyID, thirdPartyUserID, email string, oAuthTokens map[string]interface{}, rawUserInfoFromProvider tpmodels.TypeRawUserInfoFromProvider, tenantId string, userContext supertokens.UserContext) (tpmodels.SignInUpResponse, error) {
					existingUsers, err := thirdparty.GetUsersByEmail(tenantId, email)
					if err != nil {
						return tpmodels.SignInUpResponse{}, err
					}

					if len(existingUsers) == 0 {
						// this means that the email is new and is a sign up
						allowed, err := isEmailAllowed(email)
						if err != nil {
							return tpmodels.SignInUpResponse{}, err
						}
						if !allowed {
							return tpmodels.SignInUpResponse{}, errors.New("No sign up")
						}
					}
					// We allow the sign in / up operation
					return ogThirdPartySignInUp(thirdPartyID, thirdPartyUserID, email, oAuthTokens, rawUserInfoFromProvider, tenantId, userContext)
				}

				return originalImplementation
			},

			APIs: func(originalImplementation tpmodels.APIInterface) tpmodels.APIInterface {
				originalSignInUpPOST := *originalImplementation.SignInUpPOST

				(*originalImplementation.SignInUpPOST) = func(provider *tpmodels.TypeProvider, input tpmodels.TypeSignInUpInput, tenantId string, options tpmodels.APIOptions, userContext supertokens.UserContext) (tpmodels.SignInUpPOSTResponse, error) {

					resp, err := originalSignInUpPOST(provider, input, tenantId, options, userContext)

					if err.Error() == "No sign up" {
						// this error was thrown from our function override above.
						// so we send a useful message to the user
						return tpmodels.SignInUpPOSTResponse{
							GeneralError: &supertokens.GeneralErrorResponse{
								Message: "Sign ups are disabled. Please contact the admin.",
							},
						}, nil
					}

					return resp, err
				}

				return originalImplementation
			},
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from typing import Any, Dict, Optional, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import list_users_by_account_info
from supertokens_python.recipe import thirdparty
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.thirdparty.interfaces import (
    APIInterface,
    APIOptions,
    RecipeInterface,
)
from supertokens_python.recipe.thirdparty.provider import Provider, RedirectUriInfo
from supertokens_python.recipe.thirdparty.types import RawUserInfoFromProvider
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.types.base import AccountInfoInput

async def is_email_allowed(email: str):
    # from previous code snippet..
    return False

def override_thirdparty_functions(original_implementation: RecipeInterface):
    original_thirdparty_sign_in_up = original_implementation.sign_in_up

    async def thirdparty_sign_in_up(
        third_party_id: str,
        third_party_user_id: str,
        email: str,
        is_verified: bool,
        oauth_tokens: Dict[str, Any],
        raw_user_info_from_provider: RawUserInfoFromProvider,
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):
        existing_users = await list_users_by_account_info(
            tenant_id, AccountInfoInput(email=email)
        )
        if len(existing_users) == 0:
            if not await is_email_allowed(email):
                raise Exception("No sign up")

        # this means this email is new so we allow sign up
        return await original_thirdparty_sign_in_up(
            third_party_id,
            third_party_user_id,
            email,
            is_verified,
            oauth_tokens,
            raw_user_info_from_provider,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            user_context,
        )
        raise Exception("No sign up")

    original_implementation.sign_in_up = thirdparty_sign_in_up

    return original_implementation

def override_thirdparty_apis(original_implementation: APIInterface):
    original_sign_in_up_post = original_implementation.sign_in_up_post

    async def thirdparty_sign_in_up_post(
        provider: Provider,
        redirect_uri_info: Optional[RedirectUriInfo],
        oauth_tokens: Optional[Dict[str, Any]],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        try:
            return await original_sign_in_up_post(
                provider,
                redirect_uri_info,
                oauth_tokens,
                session,
                should_try_linking_with_session_user,
                tenant_id,
                api_options,
                user_context,
            )
        except Exception as e:
            if str(e) == "No sign up":
                return GeneralErrorResponse(
                    "Seems like you already have an account with another method. Please use that instead."
                )
            raise e

    original_implementation.sign_in_up_post = thirdparty_sign_in_up_post
    return original_implementation

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        thirdparty.init(
            override=thirdparty.InputOverrideConfig(
                apis=override_thirdparty_apis, functions=override_thirdparty_functions
            ),
        )
    ],
)
```

</Tab>
</Tabs>


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/social/custom-providers" label="Built-in providers" />
  <ReferenceCard href="/docs/authentication/social/custom-providers" label="Custom providers" />
  <ReferenceCard href="/docs/authentication/social/add-multiple-clients-for-the-same-provider" label="Multiple clients on the same provider" />
  <ReferenceCard href="/docs/authentication/social/hooks-and-overrides" label="Hooks and overrides" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Important concepts
Source: https://supertokens.com/docs/authentication/enterprise/important-concepts

## Overview

[Multitenancy](https://supertokens.com/features/multi-tenancy) is a way to organize your application to support multiple groups of users who share a common access with to an application.
The user groups, or **tenants**, isolate from one another and can only access their specific data.
Furthermore, each tenant can have different methods of logging in, configured by the tenant, or by you (the application developer).

For example, a SaaS application for a financial company may want to separate their users by the financial institution they represent.
This would require a login screen that asks for a username and password, as well as the name of the tenant.
The application would then route the user to their specific tenant, which could be a different database or a different collection of data within a database.

## References

With SuperTokens, there are two levels of abstractions for multi tenancy: **Tenant** and **Application**.

### Tenant

A tenant is a group of users who share a common access with specific privileges to the application. Key characteristics:

-   Each tenant can have its own login method.
For example, one tenant can have email password login, while another can have SSO login.
-   Each tenant has its own user pool.
One user can login using the same email across different tenants, and the system treats them as different users.
You can also share a user across tenants.
-   This feature also allows implementing data isolation for each of your tenants wherein a different database serves each tenant.
-   Roles and permissions exist on an app level, but the system defines their mapping to the users on a tenant level.
This means that the same user shared across tenants can have different roles / permissions, depending on the tenant they log into.
It also means that you can share the same role / permission set across tenants.
-   Sessions are per tenant (`appId` -> `tenantId` -> session handle) and cannot be shared across tenants.
-   For multiple tenants, you can run the same backend and frontend across all tenants of an app.
Each request from the frontend contains a `tenantId` identifying that tenant to the backend, and once logged in, each session also contains that user's `tenantId`.

### Application

The top-most level of abstraction in SuperTokens multitenancy. Key characteristics:

-   Each app can have its own set of tenants and users, which can't be shared with other apps.
-   Each app needs to have its own SuperTokens backend and SuperTokens frontend SDK setup.
-   User metadata is per app level since users are also on a per app level.
-   When you start the core for the first time, SuperTokens creates an app (`appId` is `"public"`) and one tenant in it (tenantId is `"public"`).
When you create a new app, you also get a new tenant (`tenantId` is `"public"`) as part of that app created for you.
-   A user can be uniquely recognized by their `appId` -> `userId`.
This allows the same user to share across tenants (if you want that to happen).
-   The identity of the user (their email for example) can be uniquely identified by `appId` -> `tenantId` -> email.
This allows the same email to use across tenants in a way that they are still treated as different users (they have different user IDs).
The same holds true for phone numbers and third party login profile.
-   You can create multiple apps and tenants in the same database or in different databases.
The only restriction is that for an app, you cannot share a user across `tenantA` and `tenantB` if the databases for `tenantA` and `tenantB` are different.
Putting it another way, a user can only share across the tenants if those tenants use the same database.

## Types of setup

Based on the above abstractions you can choose between four different setup types when setting up authentication with **SuperTokens**.

### Single tenant, single app

The default use case when you are not making use of the multi tenancy feature.

![Single tenant single app architecture](/img/single-tenant-single-app-diagram.svg)

### Single tenant, multi app

This is where you have multiple applications running on the same SuperTokens core instance and each application has a single user pool.
This could be two different apps in your organization, or two different development environments for the same app (or some combination of this).

![Single tenant multi app architecture](/img/single-tenant-multi-app-diagram.svg)

### Multi tenant, single app

Different customers use the same application, but each customer has their own set of users and login methods (each customer is a unique tenant in SuperTokens).

![Multi tenant single app architecture](/img/multi-tenant-single-app-diagram.svg)

### Multi tenant, multi app

Multiple applications run on the same **SuperTokens** core instance, and each application has its own set of tenants.
This could be two different applications in your organization, or two different development environments for the same application (or some combination of this).

![Multi tenant multi app architecture](/img/multi-tenant-multi-app-diagram.svg)

In a multi app, multi tenant setup: A user can be uniquely recognized by their `appId` -> `userId`.
This allows the same user to share across tenants (if you want that to happen).
The identity of the user (their email for example) can be uniquely identified by `appId` -> `tenantId` -> email.
This allows the same email to use across tenants in a way that they are still treated as different users (they have different user IDs).
The same holds true for phone numbers and third party login profile.
Roles and permissions exist on an app level, but the system defines their mapping to the users on a tenant level.
This means that the same user shared across tenants can have different roles / permissions, depending on the tenant they log into.
It also means that you can share the same role / permission set across tenants.
Sessions are per tenant (`appId` -> `tenantId` -> session handle) and cannot be shared across tenants.
User metadata is per app level since users are also on a per app level.

# Authentication - Enterprise Login -  Initial setup
Source: https://supertokens.com/docs/authentication/enterprise/initial-setup

## Before you start



These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page please follow the tutorial and return here once you're done.

## Steps

### 1. Create a tenant 

The first step in setting up a multi tenant login system is to create a tenant in the SuperTokens core.
Each tenant has a unique `tenantId` mapped to that tenant's configuation.
The `tenantId` could be that tenant's sub domain, or a workspace URL, or anything else that can help identify them.

The configuration mapped to each tenant contains information about which login methods they enable.

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: ["emailpassword", "thirdparty", "otp-email", "otp-phone", "link-phone", "link-email"]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

The snippet creates a new tenant with the id `"customer1"`.
It enables the email password, third party and passwordless login methods for this tenant.
You can also disable any of these by not including them in the `firstFactors` input.
If `firstFactors` is not specified, by default, the system does not enable any of the login methods.

If you set `firstFactors` to `null` the SDK uses any of the login methods.

The built-in Factor IDs available for `firstFactors` include:

| Authentication Type | Factor ID |
|-------------------|-----------|
| Email password auth | `emailpassword` |
| Social login / enterprise SSO auth | `thirdparty` |
| Passwordless - Email OTP | `otp-email` |
| Passwordless - SMS OTP | `otp-phone` |
| Passwordless - Email magic link | `link-email` |
| Passwordless - SMS magic link | `link-phone` |

</Tab>
<Tab value="go">

```go

#### Configure third party providers 

If you are using the `thirdparty` recipe on a tenant, you also need to set the providers that you want to use with it.
There's an extensive list of [built-in providers](/docs/authentication/social/built-in-providers-config), but you can also configure [a custom provider](/docs/authentication/enterprise/manage-tenants).

The next code snippet shows how you can add an Active Directory login to your tenant.
Update the `clientId`, `clientSecret`, and `directoryId` based on your tenant configuration.

<Tabs>
<Tab value="nodejs">

```tsx

async function addThirdPartyToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "active-directory",
        name: "Active Directory",
        clients: [{
            clientId: "...",
            clientSecret: "...",
        }],
        oidcDiscoveryEndpoint: "https://login.microsoftonline.com/<directoryId>/v2.0/.well-known/openid-configuration",
    });

    if (resp.createdNew) {
        // Provider added to customer1
    } else {
        // Existing provider config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

### 2. Provide additional configuration per tenant

You can also configure a tenant to use different settings. 
The next sample shows you how to customize the values.

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function createNewTenant() {

    // highlight-start
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        coreConfig: {
            "email_verification_token_lifetime": 7200000,
            "password_reset_token_lifetime": 3600000,
            "postgresql_connection_uri": "postgresql://localhost:5432/db2",
        }
    });
    // highlight-end

    if (resp.createdNew) {
        // new tenant was created
    } else {
        // existing tenant's config was modified.
    }
}
```

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.

</Tab>
<Tab value="go">

```go

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate

async def some_func():
    tenant_id = "customer1"
    result = await create_or_update_tenant(tenant_id, TenantConfigCreateOrUpdate(
        core_config={
            "email_verification_token_lifetime": 7200000,
            "password_reset_token_lifetime": 3600000,
            "postgresql_connection_uri": "postgresql://localhost:5432/db2",
        },
    ))

    if result.status != "OK":
        print("handle error")
    elif result.created_new:
        print("new tenant created")
    else:
        print("existing tenant's config was modified.")
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate

tenant_id = "customer1"
result = create_or_update_tenant(tenant_id, TenantConfigCreateOrUpdate(
    core_config={
        "email_verification_token_lifetime": 7200000,
        "password_reset_token_lifetime": 3600000,
        "postgresql_connection_uri": "postgresql://localhost:5432/db2",
    },
))

if result.status != "OK":
    print("handle error")
elif result.created_new:
    print("new tenant created")
else:
    print("existing tenant's config was modified.")
```

</Tab>
</Tabs>

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.
 

</Tab>

<Tab value="curl">

```bash
curl --location --request PUT 'http://localhost:3567/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "customer1",
    "coreConfig": {
		"email_verification_token_lifetime": 7200000,
		"password_reset_token_lifetime": 3600000,
		"postgresql_connection_uri": "postgresql://localhost:5432/db2"
	}	
}'
```

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.

</Tab>

<Tab value="dashboard" className="tab-with-background">

<img src="/img/dashboard/tenant-management/custom-tenant-configuration.png" alt="Custom tenant configuration"/>

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.
You can edit the values by clicking on the pencil icon and then specifying a new value.

:::caution

You cannot edit database connection settings directly from the Dashboard, and you may need to use the SDK or cURL to update them.

:::

</Tab>

</Tabs>

### 3. View tenant details 

To view the configuration for a specific tenant you can use an SDK method or call the API directly.

<Tabs additionalValues={[{label: "Curl", value: "curl"}]}>

<Tab value="nodejs">

```tsx

async function getTenant(tenantId: string) {

    // highlight-start
    let resp = await Multitenancy.getTenant(tenantId);
    // highlight-end

    if (resp === undefined) {
        // tenant does not exist
    } else {
        let coreConfig = resp.coreConfig;

        let firstFactors = resp.firstFactors;

        let configuredThirdPartyProviders = resp.thirdParty.providers;
    }
}
```

</Tab>
<Tab value="go">

```go
		isThirdPartyLoginEnabled := tenant.ThirdParty.Enabled;
		isPasswordlessLoginEnabled := tenant.Passwordless.Enabled;

		if (isEmailPasswordLoginEnabled) {
			// Tenant support email password login
		}
	
		if (isThirdPartyLoginEnabled) {
			// Tenant support third party login
			configuredThirdPartyProviders := tenant.ThirdParty.Providers;
			fmt.Println(configuredThirdPartyProviders);
		}
	
		if (isPasswordlessLoginEnabled) {
			// Tenant support passwordless login
		}
	}
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import get_tenant

async def some_func():
    tenant = await get_tenant("customer1")

    if tenant is None:
        print("tenant does not exist")
    else:
        core_config = tenant.core_config
        first_factors = tenant.first_factors
        providers = tenant.third_party_providers
        
        print(core_config)
        print(first_factors)
        print(providers)
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import get_tenant

tenant = get_tenant("customer1")

if tenant is None:
    print("tenant does not exist")
else:
    core_config = tenant.core_config
    first_factors = tenant.first_factors
    providers = tenant.third_party_providers
    
    print(core_config)
    print(first_factors)
    print(providers)
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash
curl --location --request GET 'http://localhost:3567/customer1/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json'
```

Notice that you add `customer1` to the path of the request. This tells the core that the tenant you want to get the information about is `customer1` (the one created before in this page).

If the input tenant does not exist, you get back a `200` status code with the following JSON:

```json
{"status": "TENANT_NOT_FOUND_ERROR"}
```

Otherwise you get a `200` status code with the following JSON output:

```json
{
  "status": "OK",
  "thirdParty": {
    "providers": [...]
  },
  "coreConfig": {
	"email_verification_token_lifetime": 7200000,
	"password_reset_token_lifetime": 3600000,
	"postgresql_connection_uri": "postgresql://localhost:5432/db2"
  },
  "tenantId": "customer1",
  "firstFactors": ["emailpassword", "thirdparty", "otp-email", "otp-phone", "link-email", "link-phone"]
}
```

</Tab>

</Tabs>

The returned `coreConfig` is the same as what you set when creating / updating the tenant. The rest of the core configurations for this tenant inherit from the app's (or the `public` tenant) configuration. The `public` tenant, for the `public` app inherits its configurations from the `config.yaml` / docker environment variables values.

### 4. Set up the user interface

To allow users to authenticate using one of your previously created tenants you need to update your frontend application.
You can do this in two ways: [through a common domain](/docs/authentication/enterprise/common-domain-login), [through subdomains](/docs/authentication/enterprise/subdomain-login).

Explore the two guides for a full list of instructions on how to implement the flows.


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/enterprise/common-domain-login" label="Implement common domain login" />
  <ReferenceCard href="/docs/authentication/enterprise/subdomain-login" label="Implement subdomain login" />
  <ReferenceCard href="/docs/authentication/enterprise/saml/what-is-saml" label="SAML" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-tenants" label="Manage tenants" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-apps" label="Manage apps" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Common domain login
Source: https://supertokens.com/docs/authentication/enterprise/common-domain-login

## Overview  

This guide shows you how to authenticate users through the same page, `https://example.com/auth`, and then redirect to their sub domain after login.
The login page adjusts the authentication method based on the tenant's configuration.

You can figure out which is the tenant that you are working with through different methods.
A common way is to ask the user to enter their organisation name, which is equal to the `tenantId` that you configure in SuperTokens.

:::info Important
You can find an example app for this setup with the **pre-built UI** on [the GitHub example directory](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-one-login-many-subdomains). The app is setup to have three tenants:
- `tenant1`: Login with `emailpassword` + Google sign in
- `tenant2`: Login with `emailpassword`
- `tenant3`: Login with passwordless + GitHub sign in

You can also generate a demo app using the following command:

```bash
npx create-supertokens-app@latest --recipe=multitenancy

```
:::

## Before you start



The tutorial assumes that you already have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

You also need to create the tenants that your application requires.
View the [previous tutorial](/docs/authentication/enterprise/initial-setup) for more information on how to do this.

## Steps

### 1. Ask for the tenant ID on the login page



<PrebuiltUIInstructions>



If you have [followed the pre-built UI setup](/docs/quickstart/frontend-setup), when you visit the login screen, you see the login screen immediately.
The flow needs to change to first ask the user to enter their tenant ID and then display the login UI based on the tenant ID.

To do that, first obtain the tenant ID from the user.
You can achieve this by building a UI that asks them to enter their `tenantId` or Organisation name (which can serve as the tenant ID).
This UI builds in a component called `AuthPage`.

:::warning no-title
You have to [create tenants](/docs/authentication/enterprise/initial-setup) before you can complete this step.
:::

<Tabs>

<Tab value="reactjs">

<Question defaultAnswer="Yes"
    question="Do you use react-router-dom?">

<Answer title="Yes">

```tsx

export const AuthPage = () => {
    const location = reactRouterDom.useLocation();
    const [inputTenantId, setInputTenantId] = useState("");
    const tenantId = localStorage.getItem("tenantId") ?? undefined;
    const session = useSessionContext();

    if (session.loading) {
        return null;
    }

    if (
        tenantId !== undefined || // if we have a tenantId stored
        session.doesSessionExist === true || // or an active session (it'll contain the tenantId)
        new URLSearchParams(location.search).has("tenantId") // or we are on a link (e.g.: email verification) that contains the tenantId
    ) {
        // Since this component (AuthPage) is rendered in the <WEBSITE_BASE_PATH> route in the main Routes component,
        // and we are rendering this in a sub route as shown below, the third arg to getSuperTokensRoutesForReactRouterDom
        // tells SuperTokens to create Routes without <WEBSITE_BASE_PATH> prefix to them, otherwise they would
        // render on <WEBSITE_BASE_PATH>^{form_websiteBasePath} path.
        return (
            <Routes>
                {getSuperTokensRoutesForReactRouterDom(
                    reactRouterDom,
                    [EmailPasswordPreBuiltUI],
                    "<WEBSITE_BASE_PATH>"
                )}
            </Routes>
        );
    } else {
        return (
            <form
                onSubmit={() => {
                    // this value will be read by SuperTokens as shown in the next steps.
                    localStorage.setItem("tenantId", inputTenantId);
                }}>
                <h2>Enter your organisation's name:</h2>
                <input type="text" value={inputTenantId} onChange={(e) => setInputTenantId(e.target.value)} />
                <br />
                <button type="submit">Next</button>
            </form>
        );
    }
};
```

</Answer>
<Answer title="No">

```tsx

export const AuthPage = () => {
    const [inputTenantId, setInputTenantId] = useState("");
    const tenantId = localStorage.getItem("tenantId") ?? undefined;
    const session = useSessionContext();

    if (session.loading) {
        return null;
    }

    if (
        tenantId !== undefined || // if we have a tenantId stored
        session.doesSessionExist === true || // or an active session (it'll contain the tenantId)
        new URLSearchParams(location.search).has("tenantId") // or we are on a link (e.g.: email verification) that contains the tenantId
    ) {
        return getRoutingComponent([EmailPasswordPreBuiltUI]);
    } else {
        return (
            <form
                onSubmit={() => {
                    // this value will be read by SuperTokens as shown in the next steps.
                    localStorage.setItem("tenantId", inputTenantId);
                }}>
                <h2>Enter your organisation's name:</h2>
                <input type="text" value={inputTenantId} onChange={(e) => setInputTenantId(e.target.value)} />
                <br />
                <button type="submit">Next</button>
            </form>
        );
    }
};
```

</Answer>
</Question>

The example creates a simple UI renders which asks the user for their organisation's name.
Their input serves as their tenant ID.
When the user submits that form, the value stores in `localstorage`.

:::info Important
The `AuthPage` component should render to show on `<WEBSITE_BASE_PATH>/*` paths of the website.

The `AuthPage` replaces the call to `getSuperTokensRoutesForReactRouterDom` or `getRoutingComponent` that you may have added to your app from the quick setup section.
:::

</Tab>

<Tab value="angular">

:::info Caution
No code snippet provided here, however, if you visit the auth component, you see that the pre-built UI renders in the `"supertokensui"` `div` element on page load. The logic here needs to change to first check if the user has provided the `tenantId`. If they have, the SuperTokens UI renders as usual. If they have not, a simple UI renders which asks the user for their tenant id and saves that in `localstorage`.

Switch to the React code tab here to see the implementation in React, and a similar logic applies here.
:::

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

You need to build a UI that asks the user to enter their `tenantId` or Organisation name (which can serve as the tenant ID). The input value is then utilized in function calls, as seen below.

Once you have the user's tenant ID, you can fetch their list of configured providers and render the third party login buttons accordingly:

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function fetchThirdPartyLoginProvidersForTenant(tenantId: string) {
	const loginMethods = await Multitenancy.getLoginMethods({
		tenantId
	})

	if (loginMethods.firstFactors.includes("thirdparty")) {
		const providers = loginMethods.thirdParty.providers;
		if (providers.find(i => i.id === "active-directory")) {
			// render sign in with Active Directory button
		} else {
			// more checks for other providers
		}
	} else {
		// thirdparty login is disabled for the tenant
	}
}
```

</Tab>
<Tab value="scripts">

```tsx
async function fetchThirdPartyLoginProvidersForTenant(tenantId: string) {
	const loginMethods = await Multitenancy.getLoginMethods({
		tenantId
	})

	if (loginMethods.firstFactors.includes("thirdparty")) {
		const providers = loginMethods.thirdParty.providers;
		if (providers.find(i => i.id === "active-directory")) {
			// render sign in with Active Directory button
		} else {
			// more checks for other providers
		}
	} else {
		// thirdparty login is disabled for the tenant
	}
}
```

</Tab>
</Tabs>

- In the code snippet above, the login methods for the `tenantId` fetch.
- We then render the login UI buttons based on the configured `thirdPartyId`s in the response

</Tab>

<Tab value="mobile">



```bash
curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/loginmethods'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: The `recipes` field contains information about which login methods are active along with the list of third party providers configured for this tenant.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should appear on the frontend.

</Tab>

</Tabs>

</CustomUIInstructions>

### 2. Include the tenant ID in authentication flow 

You need to tell SuperTokens how to resolve the tenant ID.
To do this, set the `getTenantId` function in the `Multitenancy` recipe.
In the current example, local storage provides the `tenantId`.

<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
        apiBasePath: "...",
        websiteBasePath: "..."
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        // highlight-start
        Multitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: (input) => {
                            let tid = localStorage.getItem("tenantId");
                            return tid === null ? undefined : tid;
                        }
                    }
                }
            }
        })
        // highlight-end
        // other recipes...
    ]
});
```

:::info Important
Set the `usesDynamicLoginMethods` to `true` to tell SuperTokens that the login methods are dynamic (based on the `tenantId`). On page load (of the login page), SuperTokens first fetches the configured login methods for the `tenantId`. It then displays the login UI based on the result of the API call.
:::

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
        apiBasePath: "...",
        websiteBasePath: "..."
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        // highlight-start
        supertokensUIMultitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: (input) => {
                            let tid = localStorage.getItem("tenantId");
                            return tid === null ? undefined : tid;
                        }
                    }
                }
            }
        })
        // highlight-end
        // other recipes...
    ]
});
```

:::info Important
Set the `usesDynamicLoginMethods` to `true` to tell SuperTokens that the login methods are dynamic (based on the `tenantId`). On page load (of the login page), SuperTokens first fetches the configured login methods for the `tenantId`. It then displays the login UI based on the result of the API call.
:::

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

Initialize the multi tenancy recipe with the following callback defined. You can get the value of `tenantId` from wherever you had stored it when asking the user for its value.

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
    },
    recipeList: [
        // highlight-start
        Multitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: (input) => {
                            let tid = localStorage.getItem("tenantId");
                            return tid === null ? undefined : tid;
                        }
                    }
                }
            }
        })
        // highlight-end
        // other recipes...
    ]
});
```

</Tab>
<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
    },
    recipeList: [
        // highlight-start
        supertokensMultitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: (input) => {
                            let tid = localStorage.getItem("tenantId");
                            return tid === null ? undefined : tid;
                        }
                    }
                }
            }
        })
        // highlight-end
        // other recipes...
    ]
});
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

All the steps for mobile app login are similar to the [social login steps](../../custom-ui/thirdparty-login). However, when you are calling the sign in up API, you also need to pass in the `tenantId` in the request path. An example of this appears below:



```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thirdPartyId": "...",
    "clientType": "...",
    "oAuthTokens": {
        "access_token": "...",
        "id_token": "..."
    },
}'
```

</Tab>

</Tabs>

</CustomUIInstructions>

### 3. Redirect users based on tenant subdomain  {{optional}}

If each tenant has access to specific sub domains in your application you need to redirect them after login.

#### 3.1 Restrict subdomain access

Before you perform the actual redirect step, you should restrict which sub domains they have access to.
To do this configure the SDK to know which domain each `tenantId` has access to.

<Tabs>

<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        Multitenancy.init({
            getAllowedDomainsForTenantId: async (tenantId, userContext) => {
                // query your db to get the allowed domain for the input tenantId
                // or you can make the tenantId equal to the sub domain itself
                return [tenantId + ".myapp.com", "myapp.com", "www.myapp.com"]
            }
        }),
        // highlight-end
        // other recipes...
    ]
})
```

</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            let claimValue: string[] | undefined = await Session.getClaimValue({
                claim: Multitenancy.AllowedDomainsClaim
            });
            if (claimValue !== undefined) {
                window.location.href = "https://" + claimValue[0];
            } else {
                // there was no configured allowed domain for this user. Throw an error cause of
                // misconfig or redirect to a default sub domain
            }
        }
        return undefined;
    },
    // highlight-end
    recipeList: [ /* Recipe init here... */ ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            let claimValue: string[] | undefined = await supertokensUISession.getClaimValue({
                claim: supertokensUIMultitenancy.AllowedDomainsClaim
            });
            if (claimValue !== undefined) {
                window.location.href = "https://" + claimValue[0];
            } else {
                // there was no configured allowed domain for this user. Throw an error cause of
                // misconfig or redirect to a default sub domain
            }
        }
        return undefined;
    },
    // highlight-end
    recipeList: [ /* Recipe init here... */ ]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

On the frontend, once the user has completed login, you can read the domain that they have access to (from their session) and redirect them accordingly.

<Tabs>
<Tab value="npm">

```tsx

async function redirectToSubDomain() {
    if (await Session.doesSessionExist()) {
        let claimValue: string[] | undefined = await Session.getClaimValue({
            claim: Multitenancy.AllowedDomainsClaim
        });
        if (claimValue !== undefined) {
            window.location.href = "https://" + claimValue[0];
        } else {
            // there was no configured allowed domain for this user. Throw an error cause of
            // misconfig or redirect to a default sub domain
        }
    } else {
        window.location.href = "/auth";
    }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function redirectToSubDomain() {
    if (await supertokensSession.doesSessionExist()) {
        let claimValue: string[] | undefined = await supertokensSession.getClaimValue({
            claim: supertokensMultitenancy.AllowedDomainsClaim
        });
        if (claimValue !== undefined) {
            window.location.href = "https://" + claimValue[0];
        } else {
            // there was no configured allowed domain for this user. Throw an error cause of
            // misconfig or redirect to a default sub domain
        }
    } else {
        window.location.href = "/auth";
    }
}
```

</Tab>
</Tabs>

</CustomUIInstructions>

- The `AllowedDomainsClaim` claim is auto added to the session by the backend SDK if you provide the `GetAllowedDomainsForTenantId` configuration from the previous step.
- This claim contains a list of domains that this user can access, based on their tenant ID.

### 6. Share sessions across sub domains {{optional}}

If the user authenticates into your main website domain (`https://example.com/auth`), and redirects to a sub domain, the session recipe needs updating.
It should allow sharing of sessions across sub domains.
You can do this [by setting the `sessionTokenFrontendDomain` value in the Session recipe](/docs/post-authentication/session-management/share-session-across-sub-domains).

If the sub domains assigned to your tenants have their own backend on a separate sub domain (one per tenant), you can also enable [sharing of sessions across API domains](/docs/post-authentication/session-management/advanced-workflows/multiple-api-endpoints).

### 7. Limit user access to their sub domain. {{optional}}

The frontend uses session claim validators to restrict sub domain access.
Before proceeding, make sure that you define the `GetAllowedDomainsForTenantId` function mentioned above.
This adds the list of allowed domains into the user's access token payload.

On the frontend, it is necessary to check if the tenant has access to the current sub domain.
If not, they should redirect to the right sub domain.
You can achieve this by using the `hasAccessToCurrentDomain` session validator from the multi tenancy recipe.

<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

Session.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await Session.getClaimValue({
                            claim: AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```
Above, in `Session.init` on the frontend, add the `hasAccessToCurrentDomain` claim validator to the global validators. This means that [whenever a route requires protection](/docs/additional-verification/session-verification/protect-frontend-routes), it checks if `hasAccessToCurrentDomain` has passed. If not, SuperTokens redirects the user to their right sub domain (via the values set in the `AllowedDomainsClaim` session claim).

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUISession.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...supertokensMultitenancy.AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await supertokensUISession.getClaimValue({
                            claim: supertokensMultitenancy.AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:
```tsx

Session.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await Session.getClaimValue({
                            claim: AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

Above, in `Session.init` on the frontend, add the `hasAccessToCurrentDomain` claim validator to the global validators. This means that [whenever a route requires protection](../sessions/protecting-frontend-routes), it checks if `hasAccessToCurrentDomain` has passed. If not, SuperTokens redirects the user to their right sub domain (via the values set in the `AllowedDomainsClaim` session claim).

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="npm">

```tsx

Session.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await Session.getClaimValue({
                            claim: AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

</Tab>
<Tab value="scripts">

```tsx
supertokensSession.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...supertokensMultitenancy.AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await supertokensSession.getClaimValue({
                            claim: supertokensMultitenancy.AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

</Tab>
</Tabs>

Above, in `Session.init` on the frontend, add the `hasAccessToCurrentDomain` claim validator to the global validators. This means that [whenever a route requires protection](../sessions/protecting-frontend-routes#verifying-the-claims-of-a-session--cust), it checks if `hasAccessToCurrentDomain` has passed. If not, SuperTokens redirects the user to their right sub domain (via the values set in the `AllowedDomainsClaim` session claim).

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/enterprise/manage-tenants" label="Create and configure tenants" />
  <ReferenceCard href="/docs/authentication/enterprise/common-domain-login" label="Implement common domain login" />
  <ReferenceCard href="/docs/authentication/enterprise/subdomain-login" label="Implement subdomain login" />
  <ReferenceCard href="/docs/authentication/enterprise/saml/what-is-saml" label="SAML" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-apps" label="Create and configure apps" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Subdomain login
Source: https://supertokens.com/docs/authentication/enterprise/subdomain-login

## Overview  

This guide shows you how to authenticate users through different subdomains.
The authentication method that displayed on each page varies based on tenant configuration.

:::important
Throughout this page, assume that the tenant ID for a tenant is equal to their sub domain. If the sub domain assigned to a tenant is `customer1.example.com`, then their `tenantId` is `customer1`.

An example app for this setup with the **pre-built UI** is available on [the GitHub example directory](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-one-login-per-subdomain). The app is setup to have three tenants:
- `tenant1.example.com`: Login with `emailpassword` + Google sign in
- `tenant2.example.com`: Login with `emailPassword`
- `tenant3.example.com`: Login with passwordless + GitHub sign in
:::

## Before you start



The tutorial assumes that you already have a working application integrated with **SuperTokens**.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 

Your application also needs you to create the tenants it requires.
View the [previous tutorial](/docs/authentication/enterprise/initial-setup) for more information on how to do this.

## Steps

### 1. Change CORS setting and `websiteDomain`

:::warning no-title
You have to [create tenants](/docs/authentication/enterprise/initial-setup) before you can complete this step.
:::

#### 1.1 CORS setup

In order for the browser to be able to make requests to the backend, the CORS setting on the backend needs to reflect the right set of allowed origins.
For example, if you have `customer1.example.com` on the frontend, then the CORS setting on the backend should allow `customer1.example.com` as an allowed origin.
You can specifically whitelist the set of frontend sub domains on the backend, or you can use a regex like `*.example.com`.

#### 1.2 `websiteDomain` setup

Set the `websiteDomain` to `window.location.origin` in the frontend SDK initialization step.
On the backend, update the `websiteDomain` to be the main domain (`example.com` if your sub domains are `sub.example.com`).
Then override the `sendEmail` functions to change the domain of the link dynamically based on the tenant ID supplied to the `sendEmail` function.
See the Email Delivery section in the docs for how to override the `sendEmail` function.

### 2. Load login methods dynamically on the frontend based on the `tenantId`

<PrebuiltUIInstructions>

Modify the `SuperTokens.init` to do the following:
1. Set the `usesDynamicLoginMethods` to true. This tells the frontend SDK that the login page relies on the `tenantId` and to fetch the tenant configuration from the backend before showing any login UI.
2. Initialize the `Multitenancy` recipe and provide `getTenantId` configuration function.



<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    // highlight-start
    usesDynamicLoginMethods: true,
    // highlight-end
    recipeList: [
        // Other recipes..
        // highlight-start
        Multitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: async () => {
                            // We treat the sub domain as the tenant ID
                            return window.location.host.split('.')[0]
                        }
                    }
                }
            },
        })
        // highlight-end
    ]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
  appInfo: {
    appName: "<APP_NAME>",
    apiDomain: "<API_DOMAIN>",
    websiteDomain: "<WEBSITE_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
    websiteBasePath: "<WEBSITE_BASE_PATH>"
  },
  // highlight-start
  usesDynamicLoginMethods: true,
  // highlight-end
  recipeList: [
    // Other recipes...
    supertokensUISession.init(),
    // highlight-start
    supertokensUIMultitenancy.init({
      override: {
        functions: (oI) => {
          return {
            ...oI,
            getTenantId: async () => {
              // We treat the sub domain as the tenant ID
              return window.location.host.split('.')[0]
            }
          }
        }
      },
    })
    // highlight-end
  ]
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

You can fetch the list of user's login methods based on their tenant ID (which you can derive from the current sub domain value) as shown below.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function fetchThirdPartyLoginProvidersForTenant(tenantId: string) {
	const loginMethods = await Multitenancy.getLoginMethods({
		tenantId
	})

	if (loginMethods.firstFactors.includes("thirdparty")) {
		const providers = loginMethods.thirdParty.providers;
		if (providers.find(i => i.id === "active-directory")) {
			// render sign in with Active Directory button
		} else {
			// more checks for other providers
		}
	} else {
		// thirdparty login is disabled for the tenant
	}
}
```

</Tab>
<Tab value="scripts">

```tsx
async function fetchThirdPartyLoginProvidersForTenant(tenantId: string) {
	const loginMethods = await Multitenancy.getLoginMethods({
		tenantId
	})

	if (loginMethods.firstFactors.includes("thirdparty")) {
		const providers = loginMethods.thirdParty.providers;
		if (providers.find(i => i.id === "active-directory")) {
			// render sign in with Active Directory button
		} else {
			// more checks for other providers
		}
	} else {
		// thirdparty login is disabled for the tenant
	}
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain onlyShowMultiTenancy>

```bash
curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/loginmethods'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: The `recipes` field contains information about which login methods are active along with the list of third party providers configured for this tenant.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.

</AppInfoForm>

</Tab>

<Tab value="web">

You also need to initialize the multi tenancy recipe with the following callback defined. You can get the value of `tenantId` from the sub domain as shown below.

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
    },
    recipeList: [
        // highlight-start
        Multitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: async () => {
                            // We treat the sub domain as the tenant ID
                            return window.location.host.split('.')[0]
                        }
                    }
                }
            },
        })
        // highlight-end
        // other recipes...
    ]
});
```

</Tab>
<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
    },
    recipeList: [
        // highlight-start
        supertokensMultitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        getTenantId: async () => {
                            // We treat the sub domain as the tenant ID
                            return window.location.host.split('.')[0]
                        }
                    }
                }
            },
        })
        // highlight-end
        // other recipes...
    ]
});
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

After you have shown the login methods and the user tries to sign in, follow all the steps for mobile app login similar to the [social login steps](../../custom-ui/thirdparty-login). When calling the sign in up API, also pass in the `tenantId` in the request path. An example of this appears below:

<AppInfoForm askForAPIDomain onlyShowMultiTenancy>

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/signinup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thirdPartyId": "...",
    "clientType": "...",
    "oAuthTokens": {
        "access_token": "...",
        "id_token": "..."
    },
}'
```

</AppInfoForm>

</Tab>

</Tabs>

</CustomUIInstructions>

### 3. Restrict subdomain access

Restrict which sub domains the user has access to.
To do this configure the SDK to know which domain each `tenantId` has access to.

<Tabs>

<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        Multitenancy.init({
            getAllowedDomainsForTenantId: async (tenantId, userContext) => {
                // query your db to get the allowed domain for the input tenantId
                // or you can make the tenantId equal to the sub domain itself
                return [tenantId + ".myapp.com", "myapp.com", "www.myapp.com"]
            }
        }),
        // highlight-end
        // other recipes...
    ]
})
```

</Tab>
<Tab value="go">

```go

<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

Session.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await Session.getClaimValue({
                            claim: AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```
Above, in `Session.init` on the frontend, add the `hasAccessToCurrentDomain` claim validator to the global validators. This means that [whenever you check protect a route](/docs/additional-verification/session-verification/protect-frontend-routes), it checks if `hasAccessToCurrentDomain` has passed. If not, SuperTokens redirects the user to their right sub domain (via the values set in the `AllowedDomainsClaim` session claim).

</Tab>

<Tab value="angular">

Make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUISession.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...supertokensMultitenancy.AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await supertokensUISession.getClaimValue({
                            claim: supertokensMultitenancy.AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:
```tsx

Session.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await Session.getClaimValue({
                            claim: AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

Above, in `Session.init` on the frontend, add the `hasAccessToCurrentDomain` claim validator to the global validators. This means that [whenever you check protect a route](../sessions/protecting-frontend-routes), it checks if `hasAccessToCurrentDomain` has passed. If not, SuperTokens redirects the user to their right sub domain (via the values set in the `AllowedDomainsClaim` session claim).

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="npm">

```tsx

Session.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await Session.getClaimValue({
                            claim: AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

</Tab>
<Tab value="scripts">

```tsx
supertokensSession.init({
    override: {
        functions: (oI) => ({
            ...oI,
            getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => [
                ...claimValidatorsAddedByOtherRecipes,
                {
                    ...supertokensMultitenancy.AllowedDomainsClaim.validators.hasAccessToCurrentDomain(),
                    onFailureRedirection: async () => {
                        let claimValue = await supertokensSession.getClaimValue({
                            claim: supertokensMultitenancy.AllowedDomainsClaim,
                        });
                        return "https://" + claimValue![0];
                    },
                },
            ],
        }),
    },
})
```

</Tab>
</Tabs>

Above, in `Session.init` on the frontend, add the `hasAccessToCurrentDomain` claim validator to the global validators. This means that [whenever you check protect a route](../sessions/protecting-frontend-routes#verifying-the-claims-of-a-session--cust), it checks if `hasAccessToCurrentDomain` has passed. If not, SuperTokens redirects the user to their right sub domain (via the values set in the `AllowedDomainsClaim` session claim).

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/enterprise/manage-tenants" label="Create and configure tenants" />
  <ReferenceCard href="/docs/authentication/enterprise/common-domain-login" label="Implement common domain login" />
  <ReferenceCard href="/docs/authentication/enterprise/saml/what-is-saml" label="SAML" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-apps" label="Create and configure apps" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Tenant discovery
Source: https://supertokens.com/docs/authentication/enterprise/tenant-discovery

## Overview

This tutorial shows you how to add tenant discovery functionality to your SuperTokens authentication flows.
The guide makes use of the plugins functionality which automatically discovers and routes users to the appropriate tenants based on their email domains.

## How it works

The plugin extracts the domain from user email addresses and to infer the tenant ID.
For example, `user@company.com` would be routed to the `company` tenant.
The system includes built-in protection against popular email providers and falls back to the `public` tenant when appropriate.

## Before you start

The tenant discovery plugin supports only the `React` and `NodeJS` SDKs.
Support for other platforms is under active development.
Besides initializing the plugin, you also have to configure multi-tenancy in your SuperTokens setup.

## Steps

### 1. Initialize the backend plugin

#### 1.1 Install the plugin

```bash
npm install @supertokens-plugins/tenant-discovery-nodejs
```

#### 1.2 Update your backend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your other recipes
  ],
  experimental: {
    plugins: [
      TenantDiscoveryPlugin.init({
        enableTenantListAPI: false, // Optional: defaults to false
      }),
    ],
  }
});
```

### 2. Initialize the frontend plugin

#### 2.1 Install the plugin

```bash
npm install @supertokens-plugins/tenant-discovery-react
```

#### 2.2 Update your frontend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      TenantDiscoveryPlugin.init({
        showTenantSelector: true, // Optional: defaults to true
        extractTenantIdFromDomain: true, // Optional: defaults to true
      }),
    ],
  }
});
```

### 3. Use tenant discovery

With this configuration, when a user tries to sign in, the system automatically determines their tenant based on the email domain.
Hence, you don't need to change anything else to make it work.

<img
	alt="Email authentication form"
	width="700px"
	src="/img/tenant-discovery-email-form.png"
/>

If you want to customize the user interface experience the plugin also provides other options.

#### Tenant selection interface

You can use the tenant selection interface accessible at `/tenant-discovery/select`.
This page displays all available tenants and allows users to choose their organization before proceeding with authentication.

:::info
Keep in mind that you also need to enable the `tenant list` endpoint in your backend plugin configuration.
:::

####  

## Customization

### Block emails from specific tenants

You can override the default tenant assignment logic to prevent certain emails from accessing specific tenants:

```typescript

TenantDiscoveryPlugin.init({
  enableTenantListAPI: false,
  override: (originalImplementation) => ({
    ...originalImplementation,
    isTenantAllowedForEmail: (email: string, tenantId: string) => {
      // Prevent routing to public tenant
      return tenantId !== "public";
    },
  }),
});
```

### Add custom domain restrictions

Extend the list of restricted domains that should always use the `public` tenant:

```typescript
TenantDiscoveryPlugin.init({
  override: (originalImplementation) => ({
    ...originalImplementation,
    isRestrictedEmailDomain: (emailDomain: string) => {
      return originalImplementation.isRestrictedEmailDomain(emailDomain) || 
             emailDomain === "example.com";
    },
  }),
});
```

### Implement a custom user interface

To create a custom tenant discovery interface, use the `usePluginContext` hook:

```typescript

function CustomTenantDiscovery() {
  const { api, functions } = usePluginContext();
  const [email, setEmail] = useState("");
  const [tenants, setTenants] = useState([]);

  const handleEmailSubmit = async () => {
    const result = await api.tenantIdFromEmail(email);
    if (result.status === "OK") {
      functions.setTenantId(result.tenant, email, true);
    }
  };

  const loadTenants = async () => {
    const response = await api.fetchTenants();
    if (response.status === "OK") {
      setTenants(response.tenants);
    }
  };

  return (
    <div>
      <h2>Enter your email to find your organization</h2>
      <input
        type="email"
        value={email}
        onChange={(e) => setEmail(e.target.value)}
        placeholder="user@company.com"
      />
      <button onClick={handleEmailSubmit}>Continue</button>
      
      <h3>Or choose from available organizations:</h3>
      <button onClick={loadTenants}>Load Organizations</button>
      {tenants.map((tenant) => (
        <button
          key={tenant.tenantId}
          onClick={() => functions.setTenantId(tenant.tenantId, undefined, true)}
        >
          {tenant.tenantId === 'public' ? 'Personal Account' : tenant.tenantId}
        </button>
      ))}
    </div>
  );
}
```


Besides tenant discovery, you can also explore other enterprise authentication features:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/enterprise/initial-setup" label="Initial setup" />
  <ReferenceCard href="/docs/authentication/enterprise/saml/what-is-saml" label="SAML" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-tenants" label="Manage tenants" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-apps" label="Manage apps" />
  <ReferenceCard href="/docs/references/plugins/introduction" label="Plugins References" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Manage tenants
Source: https://supertokens.com/docs/authentication/enterprise/manage-tenants

## Create a new tenant

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: ["emailpassword", "thirdparty", "otp-email", "otp-phone", "link-phone", "link-email"]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

The snippet creates a new tenant with the id `"customer1"`.
It enables the email password, third party and passwordless login methods for this tenant.
You can also disable any of these by not including them in the `firstFactors` input.
If `firstFactors` is not specified, by default, the system does not enable any of the login methods.

If you set `firstFactors` to `null` the SDK uses any of the login methods.

The built-in Factor IDs available for `firstFactors` include:

| Authentication Type | Factor ID |
|-------------------|-----------|
| Email password auth | `emailpassword` |
| Social login / enterprise SSO auth | `thirdparty` |
| Passwordless - Email OTP | `otp-email` |
| Passwordless - SMS OTP | `otp-phone` |
| Passwordless - Email magic link | `link-email` |
| Passwordless - SMS magic link | `link-phone` |

</Tab>
<Tab value="go">

```go

---

## Update a tenant

You can also configure a tenant to have different configurations per the core's `config.yaml` or docker environment variables. Below is how you can specify the configuration, when creating or modifying a tenant:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function createNewTenant() {

    // highlight-start
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        coreConfig: {
            "email_verification_token_lifetime": 7200000,
            "password_reset_token_lifetime": 3600000,
            "postgresql_connection_uri": "postgresql://localhost:5432/db2",
        }
    });
    // highlight-end

    if (resp.createdNew) {
        // new tenant was created
    } else {
        // existing tenant's config was modified.
    }
}
```

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.

</Tab>
<Tab value="go">

```go

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate

async def some_func():
    tenant_id = "customer1"
    result = await create_or_update_tenant(tenant_id, TenantConfigCreateOrUpdate(
        core_config={
            "email_verification_token_lifetime": 7200000,
            "password_reset_token_lifetime": 3600000,
            "postgresql_connection_uri": "postgresql://localhost:5432/db2",
        },
    ))

    if result.status != "OK":
        print("handle error")
    elif result.created_new:
        print("new tenant created")
    else:
        print("existing tenant's config was modified.")
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate

tenant_id = "customer1"
result = create_or_update_tenant(tenant_id, TenantConfigCreateOrUpdate(
    core_config={
        "email_verification_token_lifetime": 7200000,
        "password_reset_token_lifetime": 3600000,
        "postgresql_connection_uri": "postgresql://localhost:5432/db2",
    },
))

if result.status != "OK":
    print("handle error")
elif result.created_new:
    print("new tenant created")
else:
    print("existing tenant's config was modified.")
```

</Tab>
</Tabs>

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.
 

</Tab>

<Tab value="curl">

```bash
curl --location --request PUT 'http://localhost:3567/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "customer1",
    "coreConfig": {
		"email_verification_token_lifetime": 7200000,
		"password_reset_token_lifetime": 3600000,
		"postgresql_connection_uri": "postgresql://localhost:5432/db2"
	}	
}'
```

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.

Notice the `postgresql_connection_uri`.
This allows you to achieve **data isolation on a tenant level**.
This configuration is not required.
If not provided, the database stores the tenant's information as specified in the core's configuration.
It is still a different user pool though.

</Tab>

<Tab value="dashboard" className="tab-with-background">

<img src="/img/dashboard/tenant-management/custom-tenant-configuration.png" alt="Custom tenant configuration"/>

In the above example, the system assigns different values for certain configurations for `customer1` tenant.
All other configurations inherit from the base configuration.
You can edit the values by clicking on the pencil icon and then specifying a new value.

:::caution

You cannot edit database connection settings directly from the Dashboard, and you may need to use the SDK or cURL to update them.

:::

</Tab>

</Tabs>

---

## Get tenant details

Once you have set the configs for a specific tenant, you can fetch the tenant info as shown below:

<Tabs additionalValues={[{label: "Curl", value: "curl"}]}>

<Tab value="nodejs">

```tsx

async function getTenant(tenantId: string) {

    // highlight-start
    let resp = await Multitenancy.getTenant(tenantId);
    // highlight-end

    if (resp === undefined) {
        // tenant does not exist
    } else {
        let coreConfig = resp.coreConfig;

        let firstFactors = resp.firstFactors;

        let configuredThirdPartyProviders = resp.thirdParty.providers;
    }
}
```

</Tab>
<Tab value="go">

```go
		isThirdPartyLoginEnabled := tenant.ThirdParty.Enabled;
		isPasswordlessLoginEnabled := tenant.Passwordless.Enabled;

		if (isEmailPasswordLoginEnabled) {
			// Tenant support email password login
		}
	
		if (isThirdPartyLoginEnabled) {
			// Tenant support third party login
			configuredThirdPartyProviders := tenant.ThirdParty.Providers;
			fmt.Println(configuredThirdPartyProviders);
		}
	
		if (isPasswordlessLoginEnabled) {
			// Tenant support passwordless login
		}
	}
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import get_tenant

async def some_func():
    tenant = await get_tenant("customer1")

    if tenant is None:
        print("tenant does not exist")
    else:
        core_config = tenant.core_config
        first_factors = tenant.first_factors
        providers = tenant.third_party_providers
        
        print(core_config)
        print(first_factors)
        print(providers)
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import get_tenant

tenant = get_tenant("customer1")

if tenant is None:
    print("tenant does not exist")
else:
    core_config = tenant.core_config
    first_factors = tenant.first_factors
    providers = tenant.third_party_providers
    
    print(core_config)
    print(first_factors)
    print(providers)
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash
curl --location --request GET 'http://localhost:3567/customer1/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json'
```

Notice that you add `customer1` to the path of the request. This tells the core that the tenant you want to get the information about is `customer1` (the one created before in this page).

If the input tenant does not exist, you get back a `200` status code with the following JSON:

```json
{"status": "TENANT_NOT_FOUND_ERROR"}
```

Otherwise you get a `200` status code with the following JSON output:

```json
{
  "status": "OK",
  "thirdParty": {
    "providers": [...]
  },
  "coreConfig": {
	"email_verification_token_lifetime": 7200000,
	"password_reset_token_lifetime": 3600000,
	"postgresql_connection_uri": "postgresql://localhost:5432/db2"
  },
  "tenantId": "customer1",
  "firstFactors": ["emailpassword", "thirdparty", "otp-email", "otp-phone", "link-email", "link-phone"]
}
```

</Tab>

</Tabs>

The returned `coreConfig` is the same as what you set when creating / updating the tenant. The rest of the core configurations for this tenant inherit from the app's (or the `public` tenant) configuration. The `public` tenant, for the `public` app inherits its configurations from the `config.yaml` / docker environment variables values.

---

## List all the tenants of an app

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function listAllTenants() {

    // highlight-start
    let resp = await Multitenancy.listAllTenants();
    let tenants = resp.tenants;
    // highlight-end

    tenants.forEach(tenant => {
        let coreConfig = tenant.coreConfig;

        let firstFactors = tenant.firstFactors;

        let configuredThirdPartyProviders = tenant.thirdParty.providers;
    });
}
```

The value of `firstFactors` can be as follows:

- `undefined`: The core enables all login methods, and any auth recipe initialized in the backend SDK works.
- `[]` (empty array): The tenant does not enable any login methods.
- a non-empty array: The tenant enables only the login methods in the array.

</Tab>
<Tab value="go">

```go
        currTenant := resp.OK.Tenants[i]
        coreConfig := currTenant.CoreConfig;

        fmt.Println(coreConfig)

        isEmailPasswordLoginEnabled := currTenant.EmailPassword.Enabled;
        isThirdPartyLoginEnabled := currTenant.ThirdParty.Enabled;
        isPasswordlessLoginEnabled := currTenant.Passwordless.Enabled;

        configuredThirdPartyProviders := currTenant.ThirdParty.Providers;

        if isEmailPasswordLoginEnabled {
            // Tenant has email password login enabled
        }

        if isThirdPartyLoginEnabled {
            // Tenant has third party login enabled
            fmt.Println(configuredThirdPartyProviders)
        }

        if isPasswordlessLoginEnabled {
            // Tenant has passwordless login enabled
        }
    }
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import list_all_tenants

async def some_func():
    response = await list_all_tenants()

    if response.status != "OK":
        print("Handle error")
        return
    
    for tenant in response.tenants:
        core_configuration = tenant.core_config

        first_factors = tenant.first_factors

        configured_third_party_providers = tenant.third_party_providers

        print(core_configuration)
        print(f"First factors: {first_factors}")
        print(f"Configured third party providers: {configured_third_party_providers}")
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import list_all_tenants

def some_func():
    response = list_all_tenants()

    if response.status != "OK":
        print("Handle error")
        return
    
    for tenant in response.tenants:
        core_config = tenant.core_config

        first_factors = tenant.first_factors

        configured_third_party_providers = tenant.third_party_providers

        print(core_config)
        print(f"First factors: {first_factors}")
        print(f"Configured third party providers: {configured_third_party_providers}")
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash
curl --location --request GET '<CORE_URI>/recipe/multitenancy/tenant/list/v2' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json'
```

You get the following JSON output:

```json
{
    "status": "OK",
    "tenants": [{
        "tenantId": "customer1",
        "thirdParty": {
            "providers": [...]
        },
        "coreConfig": {...},
        "firstFactors": [...]
    }]
}
```

The value of `firstFactors` can be as follows:

- `undefined`: The core enables all login methods, and any auth recipe initialized in the backend SDK works.
- `[]` (empty array): The tenant does not enable any login methods.
- a non-empty array: The tenant enables only the login methods in the array.

</Tab>

</Tabs>

---

## Add a custom third-party provider to a tenant

If you can't find a provider in [the built-in list](/docs/authentication/social/built-in-providers-config), you can add your own custom implementation. 
This page shows you how to do that on a per tenant basis.

:::info Note
If you think that SuperTokens should support this provider by default, make sure to let the team know [on GitHub](https://github.com/supertokens/supertokens-node/issues/88).
:::

Once you have created a tenant, you want to call the API / function to create a new provider for the tenant as shown below.

### Using OAuth endpoints

<Tabs additionalValues={[{ value: "dashboard", label: "Dashboard" }, { value: "curl", label: "cURL" }]}>

<Tab value="nodejs">

```tsx

async function createTenant() {
    let resp = await Multiteancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "custom",
        name: "Custom Provider",
        clients: [{
            clientId: "...",
            clientSecret: "...",
            scope: ["email", "profile"]
        }],
        authorizationEndpoint: "https://example.com/oauth/authorize",
        authorizationEndpointQueryParams: { // optional
            "someKey1": "value1",
            "someKey2": null,
        },
        tokenEndpoint: "https://example.com/oauth/token",
        tokenEndpointBodyParams: {
            "someKey1": "value1",
        },
        userInfoEndpoint: "https://example.com/oauth/userinfo",
        userInfoMap: {
            fromUserInfoAPI: {
                userId: "id",
                email: "email",
                emailVerified: "email_verified",
            }
        }
    });

    if (resp.createdNew) {
        // custom provider added to tenant
    } else {
        // existing custom provider config overwritten for tenant
    }
}
```

</Tab>
<Tab value="go">

```go
                UserId:        "id",
                Email:         "email",
                EmailVerified: "email_verified",
            },
        },
    }, nil)
	// highlight-end

	if err != nil {
		// handle error
	}
	if resp.OK.CreatedNew {
		// Custom provider added to tenant
	} else {
		// Existing custom provider config overwritten for tenant
	}
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_third_party_config
from supertokens_python.recipe.thirdparty.provider import ProviderConfig, ProviderClientConfig, UserInfoMap, UserFields

async def some_func():
    tenant_id = "..."
    result = await create_or_update_third_party_config(tenant_id, ProviderConfig(
        third_party_id="custom",
        name="Custom Provider",
        clients=[
            ProviderClientConfig(
                client_id="...",
                client_secret="...",
                scope=["email", "profile"],
            ),
        ],
        authorization_endpoint="https://example.com/oauth/authorize",
        authorization_endpoint_query_params={
            "someKey1": "value1",
            "someKey2": None,
        },
        token_endpoint="https://example.com/oauth/token",
        token_endpoint_body_params={
            "someKey1": "value1",
        },
        user_info_endpoint="https://example.com/oauth/userinfo",
        user_info_map=UserInfoMap(
            from_user_info_api=UserFields(
                user_id="id",
                email="email",
                email_verified="email_verified",
            ),
            from_id_token_payload=UserFields(),
        ),
    ))

    if result.status != "OK":
        print("handle error")
    elif result.created_new:
        print("Custom provider added to tenant")
    else:
        print("Existing custom provider config overwritten for tenant")
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_third_party_config
from supertokens_python.recipe.thirdparty.provider import ProviderConfig, ProviderClientConfig, UserInfoMap, UserFields

tenant_id = "..."
result = create_or_update_third_party_config(tenant_id, ProviderConfig(
    third_party_id="custom",
    name="Custom Provider",
    clients=[
        ProviderClientConfig(
            client_id="...",
            client_secret="...",
            scope=["email", "profile"],
        ),
    ],
    authorization_endpoint="https://example.com/oauth/authorize",
    authorization_endpoint_query_params={
        "someKey1": "value1",
        "someKey2": None,
    },
    token_endpoint="https://example.com/oauth/token",
    token_endpoint_body_params={
        "someKey1": "value1",
    },
    user_info_endpoint="https://example.com/oauth/userinfo",
    user_info_map=UserInfoMap(
        from_user_info_api=UserFields(
            user_id="id",
            email="email",
            email_verified="email_verified",
        ),
        from_id_token_payload=UserFields(),
    ),
))

if result.status != "OK":
    print("handle error")
elif result.created_new:
    print("Custom provider added to tenant")
else:
    print("Existing custom provider config overwritten for tenant")
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash
curl --location --request PUT '<CORE_URI>/<TENANT_ID>/recipe/multitenancy/config/thirdparty' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {
        "thirdPartyId": "custom",
        "name": "Custom provider",
        "clients": [{
            "clientId": "...",
            "clientSecret": "...",
            "scope": ["email", "profile"]
        }],
        "authorizationEndpoint": "https://example.com/oauth/authorize",
        "authorizationEndpointQueryParams": {
            "someKey1": "value1",
            "someKey2": "value2"
        },
        "tokenEndpoint": "https://example.com/oauth/token",
        "tokenEndpointBodyParams": {
            "someKey1": "value1"
        },
        "userInfoEndpoint": "https://example.com/oauth/userinfo",
        "userInfoMap": {
            "fromUserInfoAPI": {
                "userId": "id",
                "email": "email",
                "emailVerified": "email_verified"
            }
        }
    }
}'
```

</Tab>

<Tab value="dashboard">

Click on **Add new provider** in the Social/Enterprise Providers section

<img src="/img/dashboard/tenant-management/third-party-providers.png" alt="Social/Enterprise providers"/>

Select **Add Custom Provider** option

<img src="/img/dashboard/tenant-management/new-provider.png" alt="New Provider"/>

Fill in the details as shown below and click on **Save**

<img src="/img/dashboard/tenant-management/new-oauth-provider.png" alt="OAuth2 provider"/>

</Tab>

</Tabs>

You can see all the options in the [CDI documentation](https://supertokens.com/docs/cdi).

| Field | Description | Example |
|-------|-------------|---------|
| `tenantId` | Unique ID that identifies the tenant. If not specified, defaults to `"public"` | `"customer1"` |
| `thirdPartyId` | Unique ID for identifying the provider | `"google"` |
| `name` | Display name used for the login button UI | `"XYZ"` → displays "Login using XYZ" |
| `clients` | Array of client credentials/settings. Can contain multiple items for different client types (web/mobile) | Contains `clientId`, `clientSecret`, and optional `clientType` |
| `authorizationEndpoint` | URL for user login | `"https://accounts.google.com/o/oauth2/v2/auth"` |
| `authorizationEndpointQueryParams` | Optional configuration to modify query params | |
| `tokenEndpoint` | API endpoint for exchanging Authorization Code | `"https://oauth2.googleapis.com/token"` |
| `tokenEndpointBodyParams` | Optional configuration to modify request body | |
| `userInfoEndpoint` | API endpoint that provides user information | `"https://www.googleapis.com/oauth2/v1/userinfo"` |
| `userInfoMap` | Maps provider's JSON response to user info fields. Use dot notation to map nested fields: `user.id` | ```{ userId: "id", email: "email", emailVerified: "email_verified" }``` |

### Using OpenID Connect endpoints

If the provider is Open ID Connect (OIDC) compatible, you can provide a URL for the `OIDCDiscoverEndpoint` configuration.
The backend SDK automatically discovers authorization endpoint, token endpoint and the user info endpoint by querying the `<OIDCDiscoverEndpoint>/.well-known/openid-configuration`.

<Tabs additionalValues={[{ value: "dashboard", label: "Dashboard"}, { value: "curl", label: "cURL"}]}>
<Tab value="nodejs">

```tsx

async function createTenant() {
    let resp = await Multiteancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "custom",
        name: "Custom Provider",
        clients: [{
            clientId: "...",
            clientSecret: "...",
            scope: ["email", "profile"]
        }],
        // highlight-start
        oidcDiscoveryEndpoint: "https://example.com/.well-known/openid-configuration",
        // highlight-end
        authorizationEndpointQueryParams: { // optional
            "someKey1": "value1",
            "someKey2": null,
        },
        userInfoMap: {
            fromIdTokenPayload: {
                userId: "id",
                email: "email",
                emailVerified: "email_verified",
            }
        }
    });

    if (resp.createdNew) {
        // custom provider added to tenant
    } else {
        // existing custom provider config overwritten for tenant
    }
}
```

</Tab>
<Tab value="go">

```go
                UserId:        "id",
                Email:         "email",
                EmailVerified: "email_verified",
            },
        },
    }, nil)

	if err != nil {
		// handle error
	}
	if resp.OK.CreatedNew {
		// Custom provider added to tenant
	} else {
		// Existing custom provider config overwritten for tenant
	}
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_third_party_config
from supertokens_python.recipe.thirdparty.provider import ProviderConfig, ProviderClientConfig, UserInfoMap, UserFields

async def some_func():
    tenant_id = "..."
    result = await create_or_update_third_party_config(tenant_id, ProviderConfig(
        third_party_id="custom",
        name="Custom Provider",
        clients=[
            ProviderClientConfig(
                client_id="...",
                client_secret="...",
                scope=["email", "profile"],
            ),
        ],
        # highlight-start
        oidc_discovery_endpoint="https://example.com/.well-known/openid-configuration",
        # highlight-end
        authorization_endpoint_query_params={
            "someKey1": "value1",
            "someKey2": None,
        },
        user_info_map=UserInfoMap(
            from_user_info_api=UserFields(),
            from_id_token_payload=UserFields(
                user_id="id",
                email="email",
                email_verified="email_verified",
            ),
        ),
    ))

    if result.status != "OK":
        print("handle error")
    elif result.created_new:
        print("Custom provider added to tenant")
    else:
        print("Existing custom provider config overwritten for tenant")
```

</Tab>

<Tab value="curl">

```bash
curl --location --request PUT '<CORE_URI>/<TENANT_ID>/recipe/multitenancy/config/thirdparty' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {
        "thirdPartyId": "custom",
        "name": "Custom provider",
        "clients": [{
            "clientId": "...",
            "clientSecret": "...",
            "scope": ["email", "profile"]
        }],
        "oidcDiscoveryEndpoint": "https://example.com/.well-known/openid-configuration",
        "authorizationEndpointQueryParams": {
            "someKey1": "value1",
            "someKey2": "value2"
        },
        "userInfoMap": {
            "fromIdTokenPayload": {
                "userId": "id",
                "email": "email",
                "emailVerified": "email_verified"
            }
        }
    }
}'
```

</Tab>

<Tab value="dashboard">

Click on **Add new provider** in the Social/Enterprise Providers section

<img src="/img/dashboard/tenant-management/third-party-providers.png" alt="Social/Enterprise providers"/>

Select **Add Custom Provider** option

<img src="/img/dashboard/tenant-management/new-provider.png" alt="New Provider"/>

Fill in the details as shown below and click on **Save**

<img src="/img/dashboard/tenant-management/new-oidc-provider.png" alt="OAuth2 provider"/>

</Tab>

</Tabs>

You can see all the options in the [CDI documentation](https://supertokens.com/docs/cdi).

| Field | Description |
|-------|-------------|
| `tenantId` | Unique ID that identifies the tenant. If not specified, defaults to `"public"` |
| `thirdPartyId`, `name`, `clients` | Configuration values similar to OAuth endpoints method |
| `userInfoMap.fromIdTokenPayload` | Maps user info from the ID token payload |
| `userInfoMap.fromUserInfoAPI` | Optional mapping from user info API. You can combine it with ID token payload mapping |

---

## Add a user to a tenant

When a user creates an account, they receive a `tenantId` to sign up. This means that the user can only log in to that tenant. SuperTokens allows you to assign a user ID to multiple tenants. This is possible as long as that user's email or phone number is unique for that login method, for each of the new tenants. Once associated with multiple tenants, that user can log in to each of the tenants they have access to.

For example, if a user signs up with email password login in the `public` tenant with email `user@example.com`, they can join another tenant (`t1` for example). This is possible as long as `t1` does not already have an email password user with the same email (that is `user@example.com`).

To associate a user with a tenant, you can call the following API:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function addUserToTenant(recipeUserId: RecipeUserId, tenantId: string) {
    let resp = await Multitenancy.associateUserToTenant(tenantId, recipeUserId);

    if (resp.status === "OK") {
        // User is now associated with tenant
    } else if (resp.status === "UNKNOWN_USER_ID_ERROR") {
        // The provided user ID was not one that signed up using one of SuperTokens' auth recipes.
    } else if (resp.status === "EMAIL_ALREADY_EXISTS_ERROR") {
        // This means that the input user is one of  passwordless or email password logins, and the new tenant already has a user with the same email for that login method. 
    } else if (resp.status === "PHONE_NUMBER_ALREADY_EXISTS_ERROR") {
        // This means that the input user is a passwordless user and the new tenant already has a user with the same phone number, for passwordless login.
    } else if (resp.status === "ASSOCIATION_NOT_ALLOWED_ERROR") {
        // This can happen if using account linking along with multi tenancy. One example of when this
        // happens if if the target tenant has a primary user with the same email / phone numbers
        // as the current user.
    } else {
        // status is THIRD_PARTY_USER_ALREADY_EXISTS_ERROR
        // This means that the input user had already previously signed in with the same third party provider (e.g. Google) for the new tenant.
    }
}
```

</Tab>
<Tab value="go">

```go

You can even remove a user's access from a tenant using the API call shown below. In fact, you can remove a user from all tenants that they have access to, and the user and their metadata remain in the system. However, they cannot log in to any tenant. To remove a user from a tenant, call the following API:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function removeUserFromTeannt(recipeUserId: RecipeUserId, tenantId: string) {
    let resp = await Multitenancy.disassociateUserFromTenant(tenantId, recipeUserId);

    if (resp.wasAssociated) {
        // User was removed from tenant
    } else {
        // User was never a part of the tenant anyway
    }
}
```

</Tab>
<Tab value="go">

```go
	} else {
		// User was never a part of the tenant anyway
	}
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import disassociate_user_from_tenant
from supertokens_python.types import RecipeUserId

async def some_func():
    response = await disassociate_user_from_tenant("customer1", RecipeUserId("user1"))

    if response.was_associated:
        print("User was removed from tenant")
    else:
        print("User was never a part of the tenant anyway")
```

</Tab>

<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import disassociate_user_from_tenant
from supertokens_python.types import RecipeUserId

def some_func():
    response = disassociate_user_from_tenant("customer1", RecipeUserId("user1"))

    if response.was_associated:
        print("User was removed from tenant")
    else:
        print("User was never a part of the tenant anyway")
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash
curl --location --request POST '<CORE_URI>/<TENANT_ID>/recipe/multitenancy/tenant/user/remove \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recipeUserId": "..."
}'
```

</Tab>

</Tabs>

:::important
- Users can only share access across tenants and not across apps. 
- If your app has two tenants, that are in different database locations, then you cannot share users between them.
:::


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/enterprise/manage-tenants" label="Create and configure tenants" />
  <ReferenceCard href="/docs/authentication/enterprise/common-domain-login" label="Implement common domain login" />
  <ReferenceCard href="/docs/authentication/enterprise/subdomain-login" label="Implement subdomain login" />
  <ReferenceCard href="/docs/authentication/enterprise/saml/what-is-saml" label="SAML" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Tenant management plugin
Source: https://supertokens.com/docs/authentication/enterprise/tenant-management-plugin

## Overview

This tutorial shows you how to add comprehensive tenant management functionality to your SuperTokens authentication flows.
The guide makes use of the plugins functionality which provides complete multi-tenancy management including tenant creation, user roles, invitations, join requests, and seamless tenant switching.

## Before you start

The tenant management plugin supports only the `React` and `NodeJS` SDKs.
Support for other platforms is under active development.

## Steps

### 1. Initialize the backend plugin

#### 1.1 Install the plugin

```bash
npm install @supertokens-plugins/tenants-nodejs
```

#### 1.2 Update your backend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      TenantsPlugin.init(),
    ],
  },
});
```

##### Configuration options

The plugin supports the following configuration options:

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `requireNonPublicTenantAssociation`    | `boolean` | `false` | Require users to associate with at least one non-public tenant |
| `requireTenantCreationRequestApproval` | `boolean` | `true` | Whether tenant creation requires admin approval |
| `enableTenantListAPI`                  | `boolean` | `false` | Enable API to list all tenants |
| `createRolesOnInit` | `boolean` | `true` | Auto-create required roles on init |

### 2. Initialize the frontend plugin

#### 2.1 Install the plugin

```bash
npm install @supertokens-plugins/tenants-react
```

#### 2.2 Update your frontend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes 
  ],
  experimental: {
    plugins: [
      ProfileBasePlugin.init(),
      TenantsPlugin.init(),
    ],
  },
});
```

##### Configuration options

The plugin supports the following configuration options:

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `requireTenantCreation`    | `boolean` | `false` | Whether users must create a tenant before accessing the app |
| `redirectToUrlOnJoiningTenant` | `string` | `/` | The path to which users are redirected after joining a tenant |

### 3. Test the implementation

With this configuration, users can access comprehensive tenant management features through the profile interface.
Make sure that you have a user with the required permissions and then access`/user/tenants/create` to create a new tenant. 

## Customization

### Roles and permissions

The plugin automatically creates the following roles and permissions:

#### Default roles

| Role | Description | Permissions |
|------|-------------|-------------|
| `tenant-admin` | Full administrative access within the tenant | All tenant permissions |
| `tenant-member` | Basic member access within the tenant | `tenant-access` |
| `app-admin` | Global application administrator | All permissions across all tenants |

#### Available permissions

| Permission | Description |
|------------|-------------|
| `tenant-access` | Basic access to tenant |
| `list-users` | View list of users in tenant |
| `manage-invitations` | Create and manage tenant invitations |
| `manage-join-requests` | Approve or reject join requests |
| `change-user-roles` | Modify user roles within tenant |
| `remove-users` | Remove users from tenant |

### Email delivery configuration

Configure custom email delivery for tenant-related notifications:

```typescript

SuperTokens.init({
  // ... other config
  experimental: {
    plugins: [
      TenantsPlugin.init({
        emailDelivery: {
          service: new PluginSMTPService({
            smtpSettings: {
              host: "smtp.example.com",
              port: 587,
              from: {
                name: "Your App",
                email: "noreply@example.com",
              },
              secure: false,
              authUsername: "username",
              password: "password",
            },
          }),
        },
      }),
    ],
  },
});
```

### Custom implementation override

You can override default behaviors by providing custom implementations:

```typescript
TenantsPlugin.init({
  override: {
    functions: (originalImplementation) => ({
      ...originalImplementation,
      isAllowedToCreateTenant: async (session) => {
        // Custom logic to determine if user can create tenant
        const userId = session.getUserId();
        // Add your custom logic here
        return true;
      },
      canApproveJoinRequest: async (targetUser, tenantId, session) => {
        // Custom logic for approving join requests
        return true;
      },
    }),
  },
});
```

### Custom user interface

To create your own UI you can use the `usePluginContext` hook.
It exposes an interface which you can use to interface with the endpoints exposed by the backend plugin.

```typescript

function CustomTenantComponent() {
  const { api, t } = usePluginContext();
  const [tenants, setTenants] = useState([]);

  const handleFetchTenants = async () => {
    const result = await api.fetchTenants();
    if (result.status === "OK") {
      setTenants(result.tenants);
    }
  };

  const handleCreateTenant = async (name) => {
    const result = await api.createTenant({ name });
    if (result.status === "OK") {
      console.log("Tenant created successfully");
    }
  };

  const handleSwitchTenant = async (tenantId) => {
    const result = await api.switchTenant(tenantId);
    if (result.status === "OK") {
      console.log("Switched to tenant successfully");
    }
  };

  return (
    <div>
      <h2>{t("PL_TD_SELECT_TENANT_TITLE")}</h2>
      <button onClick={handleFetchTenants}>Load Tenants</button>
      {tenants.map((tenant) => (
        <div key={tenant.id}>
          <span>{tenant.name} ({tenant.role})</span>
          <button onClick={() => handleSwitchTenant(tenant.id)}>
            Switch
          </button>
        </div>
      ))}
    </div>
  );
}
```

### Custom page components

You can customize the default pages by providing your own components:

```typescript

SuperTokens.init({
  // ... other config
  experimental: {
    plugins: [
      TenantsPlugin.init({
        override: (oI) => ({
          ...oI,
          pages: (originalPages) => ({
            ...originalPages,
            selectTenant: CustomSelectTenant,
            tenantManagement: CustomTenantManagement,
          }),
        }),
      }),
    ],
  },
});
```


Besides tenant management, you can also explore other enterprise authentication features:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/enterprise/tenant-discovery" label="Tenant discovery" />
  <ReferenceCard href="/docs/authentication/enterprise/initial-setup" label="Initial setup" />
  <ReferenceCard href="/docs/authentication/enterprise/manage-tenants" label="Manage tenants" />
  <ReferenceCard href="/docs/additional-verification/user-roles/introduction" label="User roles" />
  <ReferenceCard href="/docs/references/plugins/introduction" label="Plugins reference" />
</ReferenceCard.Grid>

# Authentication - Enterprise Login -  Manage apps
Source: https://supertokens.com/docs/authentication/enterprise/manage-apps

## Run multiple apps using the same SuperTokens core

Like how you can create multiple tenants / user pools within one SuperTokens core, you can create multiple apps within one core as well:
- Each app operates in isolation and can have multiple tenants.
- Each app can have its own database or share a database with another app (and yet remain logically isolated).
- Each app can have its own set of [core and db configurations](https://github.com/supertokens/supertokens-core/blob/master/config.yaml). If a specific configuration is not explicitly set for an app, it inherits from the base configuration.yaml / docker environment variables configuration.
- The core and db configurations of each tenant within an app inherit from the configurations of that app.

You can use this feature to deploy one SuperTokens core across multiple independent apps within your company. Additionally, you can create multiple development environments (`dev`, staging, prod, etc.) for one app without deploying individual SuperTokens core instances.

### 1. Create a new app in the core

:::caution
This is a paid feature, even if creating an additional `dev` `env` on the managed service, or if using the `dev` license keys in case of self-hosting. The pricing is $50 / month / additional app. Please reach out to [support@SuperTokens.com](mailto:support@SuperTokens.com) if you have any questions, or if you want to create multiple `environments` and want a bulk discount.
:::

To create a new app in the SuperTokens core, you can use the following cURL command:

```bash
curl --location --request PUT '<CORE_URI>/recipe/multitenancy/app/v2' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "app1",
    "coreConfig": {...}
}'
```

- The above command creates (or updates) an app with the `appId` of `app1`.
- It also creates a default tenant for this app with the tenant ID of `public` (that is, the default `tenantId`).
- You can set core configurations for this app (see the configuration.yaml / docker environment variable options for your core). The core configurations for a new app inherit from the configurations provided in the configuration.yaml / docker environment (or the edit configuration dashboard for managed service).
- By default, all the login methods enable for a new app (specifically, the `public` tenant of the new app), but you can pass in `firstFactors` input to specifically enable selected login methods.

The built-in Factor IDs that you can use for `firstFactors` are:
- Email password auth: `emailpassword`
- Social login / enterprise SSO auth: `thirdparty`
- Passwordless:
    - With email OTP: `otp-email`
    - With SMS OTP: `otp-phone`
    - With email magic link: `link-email`
    - With SMS magic link: `link-phone`

```bash
curl --location --request PUT '<CORE_URI>/recipe/multitenancy/app' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "app1",
    "thirdPartyEnabled": true,
    "passwordlessEnabled": true,
    "emailPasswordEnabled": true,
    "coreConfig": {...}
}'
```

- The above command creates (or updates) an app with the `appId` of `app1`.
- It also creates a default tenant for this app with the tenant ID of `public` (that is, the default `tenantId`).
- You can set core configurations for this app (see the configuration.yaml / docker environment variable options for your core). The core configurations for a new app inherit from the configurations provided in the configuration.yaml / docker environment (or the edit configuration dashboard for managed service).
- By default, all the login methods enable for a new app (specifically, the `public` tenant of the new app), but you can pass in `false` to any of the login methods specified above to disable them.

:::important
Even if a login method enables for a tenant, you still require to initialize the right recipe on the backend for sign up / in to be possible with that login method. For example, if for a tenant, you have enabled the passwordless login method, but don't use the passwordless (or a combination recipe that has passwordless) on the backend, then end users cannot sign up / in using the passwordless APIs because those APIs are not exposed via the backend SDK's middleware.
:::

### 2. Configure the `appId` during backend SDK init

Whilst one core can have multiple apps, you must use a dedicated backend (integrated with the backend SDK) per app. For example, if you have two apps, and both use a NodeJS backend, then you need to configure one app's backend to have `appId` as `app1` (as an example). The other app's backend should have `appId` as `app2`. You can specify an `appId` on the backend SDK SuperTokens.init by appending the `appId` to the `connectionUri` as shown below:

<Tabs>
<Tab value="nodejs">

```tsx

supertokens.init({
    supertokens: {
        // highlight-next-line
        connectionURI: "http://localhost:3567/appid-app1",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: []
});
```

</Tab>
<Tab value="go">

```go

The following snippet shows you how to delete an app from a SuperTokens Core instance.
This operation is irreversible and deletes all user data associated with the app.

:::important
Before you delete an app, ensure that you satisfy the following requirements:
- The request must originate from the public app and tenant
- The app must not have any tenants other than the public tenant. You need to delete other tenants first.

After deleting an app, make sure to update any backend services configured to use this app ID to prevent unexpected errors.
:::

```bash
curl --location --request POST '<CORE_URI>/recipe/multitenancy/app/remove' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "app1"
}'
```

- The above command deletes the app with the `appId` of `app1` and all its associated tenants.
- All user data, configuration, and tenant information associated with this app are permanently deleted.
- The API key used must have the necessary permissions to delete apps.

:::danger
This operation cannot be undone. Make sure you have backed up any important data before proceeding.
:::

# Authentication - Enterprise Login - SAML -  Overview
Source: https://supertokens.com/docs/authentication/enterprise/saml/overview

`SAML`, or Security Assertion Markup Language, is an open protocol that exchanges information between the auth server and the client application.
Some identity providers require OAuth 2.0 for user login, some require `SAML`, and some can work with both.

## How it works?

Your `SAML` identity provider has a metadata file (`.xml`) that you or your end users need to upload to the `SAML` client.

The `.xml` metadata file contains (amongst other things):
- A unique entity ID that you must keep private. The `SAML` provider uses this to identify your application.
- A public certificate that verifies the signature attached to the incoming `SAML` response.
This ensures the response is coming from the expected Identity Provider.
- Information about where to redirect the end user to when they click on the login button in your application. 
This URL is to a website controlled by the `SAML` provider and asks the end user for their credentials.

## Add SAML login with SuperTokens

SuperTokens is not a `SAML` client.
This means that you have to use a third-party solution along with SuperTokens to integrate with a `SAML` provider.
The way this works is that the third-party solution acts as an OAuth 2.0 provider to SuperTokens, and a `SAML` client to the `SAML` provider:

<img alt="Flowchart explaining integration of a `SAML` provider with SuperTokens using a third-party solution" src="/img/saml-oauth.png" />

### BoxyHQ

[BoxyHQ](https://boxyhq.com/) is a commercial open-source company that has a product called "SAML Jackson" which helps integrate `SAML` providers into your application.

`SAML` Jackson is a perfect fit with SuperTokens because:
- It's an OAuth provider and a `SAML` client.
This fits with the architecture.
- For self hosted, it supports PostgreSQL and MySQL amongst [other databases](https://boxyhq.com/docs/jackson/deploy/service#database).
Self hosted SuperTokens only supports PostgreSQL as a data source.

`SAML` Jackson provides an HTTP service that you can host yourself or let BoxyHQ manage.
The HTTP service uses NodeJS, and is embeddable within your NodeJS backend.
However, because SuperTokens supports multiple backends, the focus is on deploying `SAML` Jackson as a microservice.

<img alt="Flowchart of integrating a `SAML` provider with SuperTokens using `SAML` Jackson ( BoxyHQ )" src="/img/saml/supertokens-boxyhq.png" />

1. The user clicks on the login button and redirects to `SAML` Jackson's microservice at `http://localhost:5225/api/oauth/authorize`
2. `SAML` Jackson redirects the user to the `SAML` provider's login page where the user needs to enter their credentials
3. After successfully authenticating the user, the `SAML` provider redirects the user to `SAML` Jackson. Step (2) and (3) follow the `SAML` protocol.
4. `SAML` Jackson redirects the user to the frontend app on the configured callback URL. The callback URL contains the one-time use auth code.
5. SuperTokens' frontend `SDK` passes the one-time use auth code to your app's backend.
6. SuperTokens' backend `SDK` verifies the auth code by querying `SAML` Jackson. On success, `SAML` Jackson returns the end user's information and access token.
7. SuperTokens' backend `SDK` creates a new user in the core associated with the end user's email. New session tokens are also created
8. A SuperTokens' session establishes between your app's backend and frontend - logging in the user.

:::info Example App
An [example app on GitHub](https://github.com/supertokens/jackson-supertokens-express) with SuperTokens + `SAML` Jackson, for React and NodeJS express apps, is available. This uses [mocksaml.com](https://mocksaml.com/) as a `SAML` provider
:::

# Authentication - Enterprise Login - SAML -  Integration guide
Source: https://supertokens.com/docs/authentication/enterprise/saml/boxy-hq-guide

## Before you start

These instructions assume that you already are familiar with **SuperTokens** and you have configured a demo application.
If you have skipped those steps page please go through the main [quickstart guide](/docs/quickstart/introduction).
 
## Using the SuperTokens dashboard

:::caution

This is only available with Node and Python SDKs.

:::

### 1. Generate the XML metadata file from your SAML provider
Your SAML provider allows you to download a `.xml` file that you can upload to SAML Jackson. During this process, you need to provide it:
- the SSO URL and;
- the Entity ID.

You can learn more about these in the [SAML Jackson docs](https://boxyhq.com/docs/jackson/configure-saml-idp).

In the example app, [mocksaml.com](https://mocksaml.com/) serves as a free SAML provider for testing. When you navigate to the site, you see a "Download metadata" button which you should click on to get the `.xml` file.

### 2. Start the SAML Jackson service

You can run SAML Jackson [with or without Docker](https://boxyhq.com/docs/jackson/deploy/service).
```bash
docker run \
  -p 5225:5225 \
  -e JACKSON_API_KEYS="secret" \
  -e DB_ENGINE="sql" \
  -e DB_TYPE="postgres" \
  -e DB_URL="postgres://postgres:postgres@postgres:5432/postgres" \
  -d boxyhq/jackson
```

This starts the SAML Jackson server on `http://localhost:5225`.

:::important

If you are using the SuperTokens managed service, Boxy HQ hosts the server for you ([contact support](mailto:support@supertokens.com) to activate your instance).

:::

### 3. Create a new tenant in SuperTokens (if not done already)

<img src="/img/dashboard/tenant-management/tp-create-tenant.gif" alt="Create Tenant"/>

### 4. Configure the SAML provider for the tenant

<img src="/img/dashboard/tenant-management/new-boxy-config.gif" alt="Create Tenant"/>

To configure SAML login with SuperTokens, ensure that you use the correct provider name in the third-party configuration.
Make sure to specify provider name with one of the following:

- Microsoft Entra ID <br/>
- Microsoft AD FS <br/>
- Okta <br/>
- Auth0 <br/>
- Google <br/>
- OneLogin <br/>
- PingOne <br/>
- JumpCloud <br/>
- Rippling <br/>
- SAML <br/>

Make sure to replace `http://localhost:5225` with the correct value for where you have hosted the BoxyHQ server. If you are using the SuperTokens managed service, Boxy HQ hosts the server for you ([contact support](mailto:support@supertokens.com) to activate your instance).

:::success
You have successfully configured a new tenant in SuperTokens. The next step is to wire up the frontend SDK to show the right login UI for this tenant. The specifics of this step depend on the UX that you want to provide to your users. The "Common UX flows" section documents two common UX flows.
:::

### 5. Adding multiple SAML connections to a single tenant

If you have one SAML connection for a tenant, then the `Third Party Id` for that connection can be `boxy-saml`. This displays a single "SAML Login" button on the pre-built UI.

If you want to add a second SAML connection for the same tenant, follow the same steps as above, but also use the `Add Suffix` option for the Third Party Id.

For example, if a tenant has Active Directory and Okta login (both with SAML), you can create the Active Directory provider using `"boxy-saml"` as the `Third Party Id`.
For Okta, you could use `okta` as a suffix to make the `Third Party Id` equal to `"boxy-saml-okta"`.
You can also give them different names. Instead of "SAML Login" (that's shown above), you can use "Active Directory" and "Okta" to ensure that the button on the pre-built UI shows the right name.

--- 

## Using the BoxyHQ API

### 1. Generate the XML metadata file from your SAML provider
Your SAML provider allows you to download a `.xml` file that you can upload to SAML Jackson. During this process, you need to provide it:
- the SSO URL and;
- the Entity ID.

You can learn more about these in the [SAML Jackson docs](https://boxyhq.com/docs/jackson/configure-saml-idp).

In the example app, [mocksaml.com](https://mocksaml.com/) serves as a free SAML provider for testing. When you navigate to the site, you see a "Download metadata" button which you should click on to get the `.xml` file.

### 2. Convert the `.xml` file to base64
You can use [an online base64 encoder](https://www.base64encode.org/) to do this. First copy the contents of the `.xml` file, and then put it in the encoder tool. The output string is the base64 version of the .xml file.

For example, with an input `.xml` file (obtained from mocksaml.com):
```text
<?xml version="1.0" encoding="UTF-8" standalone="no"?><EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://saml.example.com/entityid" validUntil="2026-06-22T18:39:53.000Z"><IDPSSODescriptor WantAuthnRequestsSigned="false" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><KeyDescriptor use="signing"><KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><X509Data><X509Certificate>MIIC4jCCAcoCCQC33wnybT5QZDANBgkqhkiG9w0BAQsFADAyMQswCQYDVQQGEwJV
SzEPMA0GA1UECgwGQm94eUhRMRIwEAYDVQQDDAlNb2NrIFNBTUwwIBcNMjIwMjI4
MjE0NjM4WhgPMzAyMTA3MDEyMTQ2MzhaMDIxCzAJBgNVBAYTAlVLMQ8wDQYDVQQK
DAZCb3h5SFExEjAQBgNVBAMMCU1vY2sgU0FNTDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBALGfYettMsct1T6tVUwTudNJH5Pnb9GGnkXi9Zw/e6x45DD0
RuRONbFlJ2T4RjAE/uG+AjXxXQ8o2SZfb9+GgmCHuTJFNgHoZ1nFVXCmb/Hg8Hpd
4vOAGXndixaReOiq3EH5XvpMjMkJ3+8+9VYMzMZOjkgQtAqO36eAFFfNKX7dTj3V
pwLkvz6/KFCq8OAwY+AUi4eZm5J57D31GzjHwfjH9WTeX0MyndmnNB1qV75qQR3b
2/W5sGHRv+9AarggJkF+ptUkXoLtVA51wcfYm6hILptpde5FQC8RWY1YrswBWAEZ
NfyrR4JeSweElNHg4NVOs4TwGjOPwWGqzTfgTlECAwEAATANBgkqhkiG9w0BAQsF
AAOCAQEAAYRlYflSXAWoZpFfwNiCQVE5d9zZ0DPzNdWhAybXcTyMf0z5mDf6FWBW
5Gyoi9u3EMEDnzLcJNkwJAAc39Apa4I2/tml+Jy29dk8bTyX6m93ngmCgdLh5Za4
khuU3AM3L63g7VexCuO7kwkjh/+LqdcIXsVGO6XDfu2QOs1Xpe9zIzLpwm/RNYeX
UjbSj5ce/jekpAw7qyVVL4xOyh8AtUW1ek3wIw1MJvEgEPt0d16oshWJpoS1OT8L
r/22SvYEo3EmSGdTVGgk3x3s+A0qWAqTcyjr7Q4s/GKYRFfomGwz0TZ4Iw1ZN99M
m0eo2USlSRTVl7QHRTuiuSThHpLKQQ==
</X509Certificate></X509Data></KeyInfo></KeyDescriptor><NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</NameIDFormat><SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://mocksaml.com/api/saml/sso"/><SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://mocksaml.com/api/saml/sso"/></IDPSSODescriptor></EntityDescriptor>
```

The base64 output is:
```text
PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PEVudGl0eURlc2NyaXB0b3IgeG1sbnM6bWQ9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDptZXRhZGF0YSIgZW50aXR5SUQ9Imh0dHBzOi8vc2FtbC5leGFtcGxlLmNvbS9lbnRpdHlpZCIgdmFsaWRVbnRpbD0iMjAyNi0wNi0yMlQxODozOTo1My4wMDBaIj48SURQU1NPRGVzY3JpcHRvciBXYW50QXV0aG5SZXF1ZXN0c1NpZ25lZD0iZmFsc2UiIHByb3RvY29sU3VwcG9ydEVudW1lcmF0aW9uPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiPjxLZXlEZXNjcmlwdG9yIHVzZT0ic2lnbmluZyI+PEtleUluZm8geG1sbnM6ZHM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvMDkveG1sZHNpZyMiPjxYNTA5RGF0YT48WDUwOUNlcnRpZmljYXRlPk1JSUM0akNDQWNvQ0NRQzMzd255YlQ1UVpEQU5CZ2txaGtpRzl3MEJBUXNGQURBeU1Rc3dDUVlEVlFRR0V3SlYKU3pFUE1BMEdBMVVFQ2d3R1FtOTRlVWhSTVJJd0VBWURWUVFEREFsTmIyTnJJRk5CVFV3d0lCY05Nakl3TWpJNApNakUwTmpNNFdoZ1BNekF5TVRBM01ERXlNVFEyTXpoYU1ESXhDekFKQmdOVkJBWVRBbFZMTVE4d0RRWURWUVFLCkRBWkNiM2g1U0ZFeEVqQVFCZ05WQkFNTUNVMXZZMnNnVTBGTlREQ0NBU0l3RFFZSktvWklodmNOQVFFQkJRQUQKZ2dFUEFEQ0NBUW9DZ2dFQkFMR2ZZZXR0TXNjdDFUNnRWVXdUdWROSkg1UG5iOUdHbmtYaTlady9lNng0NUREMApSdVJPTmJGbEoyVDRSakFFL3VHK0FqWHhYUThvMlNaZmI5K0dnbUNIdVRKRk5nSG9aMW5GVlhDbWIvSGc4SHBkCjR2T0FHWG5kaXhhUmVPaXEzRUg1WHZwTWpNa0ozKzgrOVZZTXpNWk9qa2dRdEFxTzM2ZUFGRmZOS1g3ZFRqM1YKcHdMa3Z6Ni9LRkNxOE9Bd1krQVVpNGVabTVKNTdEMzFHempId2ZqSDlXVGVYME15bmRtbk5CMXFWNzVxUVIzYgoyL1c1c0dIUnYrOUFhcmdnSmtGK3B0VWtYb0x0VkE1MXdjZlltNmhJTHB0cGRlNUZRQzhSV1kxWXJzd0JXQUVaCk5meXJSNEplU3dlRWxOSGc0TlZPczRUd0dqT1B3V0dxelRmZ1RsRUNBd0VBQVRBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFBWVJsWWZsU1hBV29acEZmd05pQ1FWRTVkOXpaMERQek5kV2hBeWJYY1R5TWYwejVtRGY2RldCVwo1R3lvaTl1M0VNRURuekxjSk5rd0pBQWMzOUFwYTRJMi90bWwrSnkyOWRrOGJUeVg2bTkzbmdtQ2dkTGg1WmE0CmtodVUzQU0zTDYzZzdWZXhDdU83a3dramgvK0xxZGNJWHNWR082WERmdTJRT3MxWHBlOXpJekxwd20vUk5ZZVgKVWpiU2o1Y2UvamVrcEF3N3F5VlZMNHhPeWg4QXRVVzFlazN3SXcxTUp2RWdFUHQwZDE2b3NoV0pwb1MxT1Q4TApyLzIyU3ZZRW8zRW1TR2RUVkdnazN4M3MrQTBxV0FxVGN5anI3UTRzL0dLWVJGZm9tR3d6MFRaNEl3MVpOOTlNCm0wZW8yVVNsU1JUVmw3UUhSVHVpdVNUaEhwTEtRUT09CjwvWDUwOUNlcnRpZmljYXRlPjwvWDUwOURhdGE+PC9LZXlJbmZvPjwvS2V5RGVzY3JpcHRvcj48TmFtZUlERm9ybWF0PnVybjpvYXNpczpuYW1lczp0YzpTQU1MOjEuMTpuYW1laWQtZm9ybWF0OmVtYWlsQWRkcmVzczwvTmFtZUlERm9ybWF0PjxTaW5nbGVTaWduT25TZXJ2aWNlIEJpbmRpbmc9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpiaW5kaW5nczpIVFRQLVJlZGlyZWN0IiBMb2NhdGlvbj0iaHR0cHM6Ly9tb2Nrc2FtbC5jb20vYXBpL3NhbWwvc3NvIi8+PFNpbmdsZVNpZ25PblNlcnZpY2UgQmluZGluZz0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOmJpbmRpbmdzOkhUVFAtUE9TVCIgTG9jYXRpb249Imh0dHBzOi8vbW9ja3NhbWwuY29tL2FwaS9zYW1sL3NzbyIvPjwvSURQU1NPRGVzY3JpcHRvcj48L0VudGl0eURlc2NyaXB0b3I+
```

### 3. Start the SAML Jackson service

You can run SAML Jackson [with or without Docker](https://boxyhq.com/docs/jackson/deploy/service).
```bash
docker run \
  -p 5225:5225 \
  -e JACKSON_API_KEYS="secret" \
  -e DB_ENGINE="sql" \
  -e DB_TYPE="postgres" \
  -e DB_URL="postgres://postgres:postgres@postgres:5432/postgres" \
  -d boxyhq/jackson
```

This starts the SAML Jackson server on `http://localhost:5225`.

:::important

If you are using the SuperTokens managed service, Boxy HQ hosts the server for you ([contact support](mailto:support@supertokens.com) to activate your instance).

:::

### 4. Upload the base64 XML string to SAML Jackson
Take the string generated in step (2) and run:

```bash
curl --location --request POST 'http://localhost:5225/api/v1/saml/config' \
--header 'Authorization: Api-Key secret' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'encodedRawMetadata=<STRING_FROM_STEP_2>' \
--data-urlencode 'defaultRedirectUrl=<REDIRECT_URI>' \
--data-urlencode 'redirectUrl=["<REDIRECT_URI>"]' \
--data-urlencode 'tenant=<TENANT_ID>' \
--data-urlencode 'product=<PRODUCT_NAME>' \
--data-urlencode 'name=demo-config' \
--data-urlencode 'description=Demo SAML config'
```

You can learn more about the configuration values [in the SAML Jackson docs](https://boxyhq.com/docs/jackson/saml-flow#2-saml-config-api).

For the example app, you can see [this command here](https://github.com/supertokens/jackson-supertokens-express/blob/main/addTenant.sh). This helper script, `addTenant.sh`, provides the command. You can run it like:
```bash
./addTenant.sh <TENANT_ID>

# example
./addTenant.sh customer1
./addTenant.sh customer2
```

The output of this command provides you the `client_id` and `client_secret` for this tenant. You need to provide these values to SuperTokens for this tenant when configuring this tenant's providers (see below).

### 5. Create a new tenant in SuperTokens (if not done already)

<Tabs additionalValues={[ {value: "curl", label: "cURL"} ]}>

<Tab value="nodejs">

```tsx

async function createTenant() {
    let resp = await Multiteancy.createOrUpdateTenant("customer1", {
        firstFactors: ["thirdparty"]
    });

    if (resp.createdNew) {
        // new tenant was created
    } else {
        // existing tenant's config was modified.
    }
}
```

</Tab>
<Tab value="go">

```go

async function addThirdPartyConfigToTenant() {
    let resp = await Multitenancy.createOrUpdateThirdPartyConfig("customer1", {
        thirdPartyId: "boxy-saml",
        name: "<provider-name>",
        clients: [{
            clientId: "<TODO: GENERATED FROM PREVIOUS STEP>",
            clientSecret: "<TODO: GENERATED FROM PREVIOUS STEP>",
            additionalConfig: {
                "boxyURL": "http://localhost:5225",
            }
        }]
    });

    if (resp.createdNew) {
        // SAML Login added to customer1
    } else {
        // Existing SAML Login config overwritten for customer1
    }
}
```

</Tab>
<Tab value="go">

```go

# Authentication - Unified Login -  OAuth2 basics
Source: https://supertokens.com/docs/authentication/unified-login/oauth2-basics

## Overview

Each quickstart guide uses OAuth2 specific concepts that you should be aware of.
Read through this page to get a better understanding of the specifications. 

**OAuth2**, Open Authorization, is an industry-standard authorization framework that enables third-party applications to obtain limited access to a user's resources without exposing their credentials.

## Terminology

### Roles

In OAuth, roles define the different responsibilities of entities involved in the process of granting and obtaining access to protected resources.
The specification defines four roles:

#### Resource Owner

The **Resource Owner** is an entity capable of granting access to a protected resource.
This is an actual person that uses an application.

#### Client

An **OAuth 2.0 Client** is an application that wants to access protected resources.
It needs to get an [**OAuth2 Access Token**](#oauth2-access-token) from the [**Authorization Server**](#authorization-server).
With that token the client can perform authorized operations on behalf of the [**Resource Owner**](#resource-owner).

The term **client** does not imply any particular implementation characteristics (for example, whether the application executes on a server, a desktop, or other devices).

#### Resource Server

The server hosting the protected resources, capable of accepting and responding to protected resource requests using [**OAuth2 Access Tokens**](#oauth2-access-token).
Some real-world examples in this case would be things like:
- A file storage service that allows users to access only their files
- A social media application that allows users to access only posts from their friends
- A chat app that shows only messages from conversations in which the user is a participant

#### Authorization Server

The server issuing [**OAuth2 Access Tokens**](#oauth2-access-token) to the [**Client**](#client) after successfully authenticating the [**Resource Owner**](#resource-owner).

### Tokens

Tokens are strings that represent the authorization issued to the [**Client**](#client).
They are mainly used to access to protected resources, on behalf of the [**Resource Owner**](#resource-owner).
At the same time, tokens can provide more information about who the owner is.

#### OAuth2 Access Token

This is the main token that provides temporary access to protected resources.
The **OAuth2 Access Token** should only be accessed and validated by the [**Resource Server**](#resource-server).

:::info
This token is different from the **SuperTokens Session Access Token**.
The latter functions in the **OAuth 2.0** authentication flows to maintain a session between the **authorization frontend** and the **authorization backend server**. 
:::

#### OAuth2 Refresh Token

A token that allows obtaining a new [**OAuth2 Access Token**](#oauth2-access-token) when the current one has expired.
Using the refresh token does not require the user to re-authenticate.

:::info
This token is different from the **SuperTokens Session Refresh Token**.
The latter functions in the **OAuth 2.0** authentication flows to maintain a session between the **authorization frontend** and the **authorization backend server**. 
:::

#### ID Token

This token provides identity information about the [**Resource Owner**](#resource-owner).
Unlike [**OAuth2 Access Tokens**](#oauth2-access-token), the **ID Tokens** should only be accessed by the [**Client**](#client).

### Scopes

Scopes define the range of access that the [**Client**](#client) is requesting on behalf of the [**Resource Owner**](#resource-owner).
They specify what portions of the **Resource Owner’s** data the **Client** can access and what actions it can perform.

For example, when a user grants a web application permission to read their email, the application might request the `email` scope.

In a general authentication flow scopes get used in the following way:
1. When the **Client** gets created, it configures a series of scopes for the **Authorization Server**
2. The **Authorization Server** authenticates the **Resource Owner** and uses the scopes to generate an **OAuth2 Access Token**.
3. The **Resource Server** checks the scopes of the **OAuth2 Access Token** and only allows the requested actions.

### Authorization flows

The **OAuth 2.0** protocol defines several *flows* to accommodate different use cases.
They are a set of steps an **OAuth Client** has to perform to obtain an access token.

Our implementation supports the following flow types:

#### [Authorization Code Grant](https://oauth.net/2/grant-types/authorization-code/)

<img src="/img/oauth/authorization-code-flow.png" alt="Authorization Code Grant"/>

This flow is best suited for scenarios that involve **web applications**.
It consists of the following steps:
1. The **Client** redirects the **Resource Owner** to the **Authorization Server’s** authorization endpoint.
2. If the **Resource Owner** grants permission, the **Authorization Server** redirects their browser back to the specified **Redirect URI** and includes an **Authorization Code** as a query parameter.
3. The **Client** then sends a request to the **Authorization Server**’s token endpoint, including the **Authorization Code**.
4. The **Authorization Server** verifies the information sent by the **Client** and, if valid, issues an **OAuth2 Access Token**.
5. The token can make requests to the **Resource Server** to access the protected resources on behalf of the **Resource Owner**.

##### Authorization code

An **Authorization Code** is a short-lived code that the [**Authorization Server**](#authorization-server) provides to the [**Client**](#client), via a **Redirect URI**, after authorization approval.
This code then gets exchanged for an [**OAuth2 Access Token**](#oauth2-access-token). 
The **Authorization Code** flow enhances security by keeping tokens out of the user-agent and letting the [**Client**](#client) manage the backend communication with the [**Authorization Server**](#authorization-server).

##### Proof key for code exchange (PKCE)

To prevent cross-site request forgery (CSRF) and code injection attacks, the **Authorization Code flow** can use [**PKCE**](https://oauth.net/2/pkce/).

At the beginning of the authentication flow the **Client** generates a random string called a *code verifier*.
This ensures that, even if the **Authorization Code** gets intercepted, it cannot be exchanged for a token without also including the initial code.

#### [Client credentials](https://oauth.net/2/grant-types/client-credentials/)

<img src="/img/oauth/client-credentials-flow.png" alt="Client Credentials Grant"/>

This flow is best suited for **machine-to-machine** (M2M) interactions where there is no end-user.
It consists of the following steps:
1. The **Client** authenticates with the **Authorization Server** using its own credentials.
2. The **Authorization Server** verifies the credentials. 
3. The **Authorization Server** returns an **OAuth2 Access Token**.
4. The **Client** uses the **OAuth2 Access Token** to access protected resources.
5. The **Resource Server** validates the **OAuth2 Access Token**.
6. If the validation is successful, the **Resource Server** returns the requested resources.

# Authentication - Unified Login - Quickstart Guides -  Multiple frontend domains with a common backend
Source: https://supertokens.com/docs/authentication/unified-login/quickstart-guides/multiple-frontends-with-a-single-backend

## Overview

You can implement the following guide if you have multiple **`frontend applications`** that use the same **`backend service`**.
The authentication flow works in the following way:

<Steps>
## The User accesses the `frontend` application:
  - The application `frontend` redirects the user to the **Authorization Service** backend, using the authorize URL.
  - The **Authorization Service** backend redirects the user to the login UI.

## The User completes the login attempt:
  - The **Authorization Service** backend redirects the user to the `callback URL`.

## The user accesses the callback URL:
  - The `frontend` uses the callback URL information to obtain a **OAuth2 Access Token** from the **Authorization Service** backend.

</Steps>

<img src="/img/oauth/multiple-frontend-domains-with-a-single-backend.png" alt="Multiple Frontend Domains with a Single Backend"/>

## Before you start



These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page, please follow the tutorial and return here once you're done.

:::info

If your frontend applications are on the same **domain**, but on different **sub-domains**, you can use [Session Sharing Across Subdomains](/docs/post-authentication/session-management/share-session-across-sub-domains).

:::

## Steps

### 1. Enable the Unified Login feature

Go to the [**SuperTokens.com SaaS Dashboard**](https://supertokens.com) and follow these instructions:
1. Click on the **Enabled Paid Features** button
2. Click on **Managed Service**
3. Check the **Unified Login / M2M** option
4. Click *Save* 

### 2. Create the OAuth2 Clients

For each of your **`frontend`** applications create a separate [**OAuth2 client**](/docs/authentication/unified-login/oauth2-basics#client).
This can occur by directly calling the **SuperTokens Core** API.

<HTTPRequestCard path="/recipe/oauth/clients" method="post" title="Create Client">
  <HTTPRequestCard.ShellExample>

```bash
curl --location --request POST '<CORE_URI>/recipe/oauth/clients' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '
    {
      "clientName": "<YOUR_CLIENT_NAME>",
      "responseTypes": ["code"],
      "grantTypes": ["authorization_code", "refresh_token"],
      "scope": "offline_access <custom_scope_1> <custom_scope_2>",
      "redirectUris": ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
    }
'
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/recipe/oauth/clients`;
    const options = {
      method: 'POST',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
      body: JSON.stringify({
        clientName: "<YOUR_CLIENT_NAME>",
        responseTypes: ["code"],
        grantTypes: ["authorization_code", "refresh_token"],
        scope: "offline_access <custom_scope_1> <custom_scope_2>",
        redirectUris: ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
      })
    };

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

    BASE_URL = "<CORE_URI>"
    API_KEY = "^{coreInfo.key}"

    url = f"{BASE_URL}/recipe/oauth/clients"

    payload: Dict[str, Any] ={
      "clientName": "<YOUR_CLIENT_NAME>",
      "responseTypes": ["code"],
      "grantTypes": ["authorization_code", "refresh_token"],
      "scope": "offline_access <custom_scope_1> <custom_scope_2>",
      "redirectUris": ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
    } 

    headers = {
        "api-key": API_KEY,
        "Content-Type": "application/json",
    }

    response = requests.post(url, json=payload, headers=headers)

    print(response.json())
    ```

  </HTTPRequestCard.PythonExample>
  <HTTPRequestCard.DetailsModal>
<CreateOAuth2ClientRequestDetails />
  </HTTPRequestCard.DetailsModal>
</HTTPRequestCard>

:::caution
You have to save the create OAuth2 Client response because this is not persisted internally for security reasons.
The information is necessary in the next steps.
:::

### 3. Set up the Authorization Service Backend



#### 3.1 Initialize the OAuth2 recipe

<Tabs disableOtherFrameworks>
<Tab value="nodejs">

Update the `supertokens.init` call to include the new recipe.

```tsx

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "...",
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      OAuth2Provider.init(),
    ]
});
```

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

<Tab value="python">

```python 
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import oauth2provider 

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    framework="fastapi",
    supertokens_config=SupertokensConfig(
        connection_uri="...",
        api_key="..."
    ),
    recipe_list=[
        oauth2provider.init()
    ],
)
```

</Tab>

</Tabs>

#### 3.2 Update the CORS configuration

Set up the Backend API to allow requests from all the frontend domains.

<Tabs disableOtherFrameworks>

<Tab value="nodejs">

```tsx

const app = express();
 
// Add your actual frontend domains here
const allowedOrigins = ["<WEBSITE_DOMAIN>", "<CLIENT_DOMAIN_1>", "<CLIENT_DOMAIN_2>"];

app.use(cors({
    // highlight-start
    origin: allowedOrigins,
    allowedHeaders: ["content-type", ...supertokens.getAllCORSHeaders()],
    credentials: true,
    // highlight-end
}));
```

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

<Tab value="python">

```python
from supertokens_python import get_all_cors_headers
from fastapi import FastAPI
from starlette.middleware.cors import CORSMiddleware
from supertokens_python.framework.fastapi import get_middleware

app = FastAPI()
app.add_middleware(get_middleware())

app.add_middleware(
    CORSMiddleware,
    # highlight-start
    allow_origins=[
       "<YOUR_WEBSITE_DOMAIN>", "<CLIENT_DOMAIN_1>", "<CLIENT_DOMAIN_2>" 
    ],
    # highlight-end
    allow_credentials=True,
    allow_methods=["GET", "PUT", "POST", "DELETE", "OPTIONS", "PATCH"],
    allow_headers=["Content-Type"] + get_all_cors_headers(),
)

```

</Tab>

</Tabs>

#### 3.3 Implement a custom session verification function

Given that the backend, the **Authorization Server**, also acts as a **Resource Server** you have to account for this in the session verification process.

This is necessary because the flow uses two types of tokens:
- **SuperTokens Session Access Token**: Used during the login and logout. 
- **OAuth2 Access Token**: Used to access protected resources and perform actions that need authorization.

Hence the logic should distinguish between these two and prevent errors.

<Tabs disableOtherFrameworks>

<Tab value="nodejs">

Here is an example of how to implement this in the context of an Express API:

```tsx

interface RequestWithUserId extends Request {
  userId?: string;
}

async function verifySession(req: RequestWithUserId, res: Response, next: NextFunction) {
  let session = undefined;
  try {
    session = await Session.getSession(req, res, { sessionRequired: false });
  } catch (err) {
    if (
      !Session.Error.isErrorFromSuperTokens(err) ||
      err.type !== Session.Error.TRY_REFRESH_TOKEN
    ) {
      return next(err);
    }
  }

  // In this case we are dealing with a SuperTokens Session
  if (session !== undefined) {
    const userId = session.getUserId();
    req.userId = userId;
    return next();
  }

  // The OAuth2 Access Token needs to be manually extracted and validated
  let jwt: string | undefined = undefined;
  if (req.headers["authorization"]) {
    jwt = req.headers["authorization"].split("Bearer ")[1];
  }
  if (jwt === undefined) {
    return next(new Error("No JWT found in the request"));
  }

  try {
    const tokenPayload = await validateToken(jwt, '<CUSTOM_SCOPE>');
    const userId = tokenPayload.sub;
    req.userId = userId;
    return next();
  } catch (err) {
    return next(err);
  }
}

const JWKS = jose.createRemoteJWKSet(
  new URL("<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json"),
);

// This is a basic example on how to validate an OAuth2 Token
// We have a separate page that talks more in depth about the process
async function validateToken(jwt: string, requiredScope: string) {
  const { payload } = await jose.jwtVerify(jwt, JWKS, {
    requiredClaims: ["stt", "scp", "sub"],
  });

  if (payload.stt !== 1) throw new Error("Invalid token");
  const scopes = payload.scp as string[];
  if (!scopes.includes(requiredScope)) throw new Error("Invalid token");

  return payload;
}

// You can then use the function as a middleware for a protected route
const app = express();
app.get("/protected", verifySession, async (req, res) => {
    // Custom logic 
});
```

For more information on how to verify the **OAuth2 Access Tokens**, please check the [separate guide](/docs/authentication/unified-login/verify-tokens).

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

<Tab value="python">

```python 
from supertokens_python.recipe.session.syncio import get_session
from supertokens_python.recipe.session.exceptions import SuperTokensSessionError, TryRefreshTokenError 
from fastapi.requests import Request
from typing import List, Optional 
   return True

def validate_token(token: str, required_scope: str) -> bool:
  api_domain = "<API_DOMAIN>"
  api_base_path = "<API_BASE_PATH>"
  client_id = "<CLIENT_ID>"

  jwks_url = f"{api_domain}{api_base_path}/jwt/jwks.json"
  jwks_client = PyJWKClient(jwks_url)

  try:
      signing_key = jwks_client.get_signing_key_from_jwt(token)
      decoded = jwt.decode(
          token,
          signing_key.key,
          algorithms=['RS256'],
          options={"require": ["stt", "client_id", "scp"]}
      )

      stt: Optional[int] = decoded.get('stt')
      if stt != 1:
          return False

      token_client_id: Optional[str] = decoded.get('client_id', None)
      if client_id != token_client_id:
          return False

      scopes: List[str] = decoded.get('scp', [])
      if required_scope not in scopes:
          return False

      return True
  except Exception: 
      return False
  #
```

</Tab>

</Tabs>

### 4. Configure the Authorization Service Frontend



<PrebuiltUIInstructions>

#### 4.1 Initialize the recipe 

<Tabs uiType="prebuilt">

<Tab value="reactjs">

Add the import statement for the new recipe and update the list of recipe to also include the new initialization.

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        OAuth2Provider.init()
    ]
});
```

#####  Include the pre-built UI in the rendering tree.

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">

<Answer title="Yes">

```tsx

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        {/*This renders the login UI on the /auth route*/}
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [OAuth2ProviderPreBuiltUI])}
                        {/*Your app routes*/}
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```

</Answer>

<Answer title="No">

```tsx

class App extends React.Component {
    render() {
        if (canHandleRoute([OAuth2ProviderPreBuiltUI])) {
            // This renders the login UI on the /auth route
            return getRoutingComponent([OAuth2ProviderPreBuiltUI])
        }

        return (
            <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
        );
    }
}
```

</Answer>

</Question>
    
</Tab>

<Tab value="angular">

Update the `AuthComponent` to include the `OAuth2Provider` recipe.
You need to add a new item in the `recipeList` array.

```tsx title="/app/auth/auth.component.ts"

  @Component({
      selector: "app-auth",
      template: '<div id="supertokensui"></div>',
  })
  export class AuthComponent implements OnDestroy, AfterViewInit {

      constructor(
          private renderer: Renderer2,
          @Inject(DOCUMENT) private document: Document
      ) { }

      ngAfterViewInit() {
          this.loadScript('^{jsdeliver_prebuiltui}');
      }

      ngOnDestroy() {
          // Remove the script when the component is destroyed
          const script = this.document.getElementById('supertokens-script');
          if (script) {
              script.remove();
          }
      }

      private loadScript(src: string) {
          const script = this.renderer.createElement('script');
          script.type = 'text/javascript';
          script.src = src;
          script.id = 'supertokens-script';
          script.onload = () => {
              supertokensUIInit({
                  appInfo: {
                      appName: "<APP_NAME>",
                      apiDomain: "<API_DOMAIN>",
                      websiteDomain: "<WEBSITE_DOMAIN>",
                      apiBasePath: "<API_BASE_PATH>",
                      websiteBasePath: "<WEBSITE_BASE_PATH>"
                  },
                  recipeList: [
                    // Don't forget to also include the other recipes that you are already using
                    supertokensUIOAuth2Provider.init()
                  ],
              });
          }
          this.renderer.appendChild(this.document.body, script);
      }
  }
```

</Tab>

<Tab value="vue">

Update the `AuthView` component to include the `OAuth2Provider` recipe.
You need to add a new item in the `recipeList` array, inside the `supertokensUIInit` call.

```tsx
    <script lang="ts">
        export default defineComponent({
            setup() {
                const loadScript = (src: string) => {
                    const script = document.createElement('script');
                    script.type = 'text/javascript';
                    script.src = src;
                    script.id = 'supertokens-script';
                    script.onload = () => {
                        supertokensUIInit({
                            appInfo: {
                                appName: "<APP_NAME>",
                                apiDomain: "<API_DOMAIN>",
                                websiteDomain: "<WEBSITE_DOMAIN>",
                                apiBasePath: "<API_BASE_PATH>",
                                websiteBasePath: "<WEBSITE_BASE_PATH>"
                            },
                            recipeList: [
                              // Don't forget to also include the other recipes that you are already using
                              supertokensUIOAuth2Provider.init()
                            ],
                        });
                    };
                    document.body.appendChild(script);
                };

                onMounted(() => {
                    loadScript('^{jsdeliver_prebuiltui}');
                });

                onUnmounted(() => {
                    const script = document.getElementById('supertokens-script');
                    if (script) {
                        script.remove();
                    }
                });
            },
        });
    </script>

    <template>
        <div id="supertokensui" />
    </template>
```

</Tab>
    
</Tabs>

#### 4.2 Disable network interceptors

The **Authorization Service Frontend** that you are configuring makes use of two types of access tokens:
- **SuperTokens Session Access Token**: Used only during the login flow to keep track of the authentication state.
- **OAuth2 Access Token**: Returned after a successful login attempt. It can then access protected resources.

By default, the **SuperTokens** frontend SDK intercepts all the network requests sent to your Backend API and adjusts them based on the **SuperTokens Session Tokens**.
This allows operations, such as automatic token refreshing or adding authorization headers, without needing to configure anything else.

Given that in the scenario you are implementing, the **OAuth2 Access Tokens** serve authorization purposes.
The automatic request interception causes conflicts.
To prevent this, you need to override the `shouldDoInterceptionBasedOnUrl` function in the `Session.init` call.

:::caution

The code samples assume that you are using `<API_BASE_PATH>` as the `apiBasePath` for the backend authentication routes.
If that is different please adjust them based on your use case.

:::

<Tabs uiType="prebuilt">

<Tab value="reactjs">

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        // Interception should be done only for routes that need the SuperTokens Session Tokens
                        const isAuthApiRoute = urlObj.pathname.startsWith("<API_BASE_PATH>");
                        const isOAuth2ApiRoute = urlObj.pathname.startsWith("<API_BASE_PATH>/oauth");
                        if (!isAuthApiRoute || isOAuth2ApiRoute) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUISession.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("<API_BASE_PATH>")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("<API_BASE_PATH>")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>

<Tab value="vue">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUISession.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("<API_BASE_PATH>")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("<API_BASE_PATH>")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>

</Tabs>

The code snippet only allows interception for API endpoints that start with `<API_BASE_PATH>`. 
This ensures that calls made from the Frontend SDKs continue to use the **SuperTokens Session Tokens**. As a result, the authentication flow ends up working.

For the other routes, you have full control on how you want to attach the **OAuth2 Access Tokens** to the API calls.

</PrebuiltUIInstructions>

<CustomUIInstructions>

The user interface that you are going to build should respect this flow:

<Steps>

## A user accesses your application and tries to login.

It's up to you how you want to handle this. 
They can click a button to login or you can directly start the login flow.

## They get redirected to the **Authorization Service Backend** 

A **OAuth2/OpenID Connect (OIDC)** library can execute this action.
Check the previous guides for information on what you could use.

## The **Authorization Service Backend** redirects them to the **Authorization Service Frontend** login page.

The page URL contains a `loginChallenge` parameter that keeps track of the login attempt.
Besides that, the URL can also include a `forceFreshAuth` parameter.
As the name suggests, this should force the login UI to be visible even though the user has an existing valid session.
This guide shows you how to handle this.

## The **Authorization Service Frontend** renders the login UI and the user performs the login action.

The login UI should render based on instructions that are specific to each authentication method which you are using.
The additional thing that you have to do here is to consider the `forceFreshAuth` parameter. 

## The **Authorization Service Frontend** redirects the user back to the **Authorization Service Backend** 

After the user submits the login form, you need to redirect them to a specific route that sends them to the original application.
From here, the authentication flow completes.

</Steps>

Let's see how you can actually implement this UI.

#### 4.1 Configure the redirection URLs

As it has hinted in the previous section, the **Authorization Service Backend** sends the user to different pages from the **Authorization Service Frontend**, based on the action that needs execution.

The default values for these routes are:

- The login page maps to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>` (this is also the place where a user ends up after logout)
- The token refresh page maps to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/try-refresh`
- The logout page maps to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/logout`

If you want to change these routes, you need to add a custom override.

:::info
This override needs addition to the **Authorization Service Backend**.
:::

<Tabs>

<Tab value="nodejs">

```tsx

OAuth2Provider.init({
    override: {
        functions: (originalFunctions) => ({
            ...originalFunctions,
            getFrontendRedirectionURL: async (input) => {
                const websiteDomain = '<WEBSITE_DOMAIN>'; 
                const websiteBasePath = '<WEBSITE_BASE_PATH>';

                if (input.type === "login") {
                    const queryParams = new URLSearchParams({
                        loginChallenge: input.loginChallenge,
                    });
                    if (input.hint !== undefined) {
                        queryParams.set("hint", input.hint);
                    }
                    if (input.forceFreshAuth) {
                        queryParams.set("forceFreshAuth", "true");
                    }

                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>?${queryParams.toString()}`;
                } else if (input.type === "try-refresh") {
                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/try-refresh?loginChallenge=${input.loginChallenge}`;
                } else if (input.type === "post-logout-fallback") {
                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>`;
                } else if (input.type === "logout-confirmation") {
                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/oauth/logout?logoutChallenge=${input.logoutChallenge}`;
                }

                return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>`;
            },
        }),
    },
})

```

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

<Tab value="python">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Python SDK.

:::

</Tab>

</Tabs>

#### 4.2 Handle the forceFreshAuth parameter

Sometimes, even though there is an existing valid session in the **Authorization Service Frontend**, the requesting **Client** might force a new login attempt.
The `forceFreshAuth` parameter shows this.

When the login page renders, you also need to check for this parameter. You are doing this to know if you need to show the login UI.

Here is an example of how you can evaluate this case.

```tsx

async function shouldLogin() {
  const urlParams = new URLSearchParams(window.location.search);
  const forceFreshAuth = urlParams.get('forceFreshAuth') as string;
  if(forceFreshAuth === "true") return true;

  return Session.doesSessionExist();
}

```

:::info Multi Tenancy

If you are using multi-tenancy, you also need to keep track of the `tenantId` query parameter and pass it between the **Authorization Service Frontend** pages.

:::

#### 4.3 Complete the login attempt
  

After the user submits the login form, you need to redirect them to a specific route to complete the **OAuth 2** flow.

The following code sample shows you how to determine which URL to use.

<Tabs uiType="custom">

<Tab value="web">

```tsx

async function getInitialRedirectionURL() {
  const urlParams = new URLSearchParams(window.location.search);
  const loginChallenge = urlParams.get('loginChallenge') as string;
  const redirectionResponse = await OAuth2Provider.getRedirectURLToContinueOAuthFlow({ loginChallenge });
  if (redirectionResponse.status === "OK") {
    return redirectionResponse.frontendRedirectTo;
  }
}

```

</Tab>

<Tab value="mobile">

:::caution

For mobile apps, you need to reuse the web authentication flow. Check this [guide](/docs/authentication/unified-login/reuse-website-login) for more information.

:::

</Tab>

</Tabs>

#### 4.4 Add the token refresh page

To have support for token refreshing, you need to add a new page to your application.
The path should correspond to the one outlined during the first step.

When the user ends up on this page, you need to use the `Session` recipe to perform the refresh action.
Then they need redirection to a page from your application.

Here's a code sample that shows you how to do this.

<Tabs uiType="custom">

<Tab value="web">

```tsx

async function refreshToken() {
  await Session.attemptRefreshingSession();
  const urlParams = new URLSearchParams(window.location.search);
  const loginChallenge = urlParams.get('loginChallenge') as string;
  const redirectionResponse = await OAuth2Provider.getRedirectURLToContinueOAuthFlow({ loginChallenge });
  if (redirectionResponse.status === "OK") {
    window.location.href = redirectionResponse.frontendRedirectTo;
  }
}

```

</Tab>

<Tab value="mobile">

:::caution

For mobile apps, you need to reuse the web authentication flow. Check this [guide](/docs/authentication/unified-login/reuse-website-login) for more information.

:::

</Tab>

</Tabs>

#### 4.5 Add the logout page 

You need to add a logout page that users access when they want to end their session.
The path should correspond to the one outlined during the first step.

The logout action should first ask the user for confirmation.
If the confirmation passes, then you can call the recipe function.
Based on the final response you can redirect the user to the provided redirection URL.

<Tabs uiType="custom">

<Tab value="web">

```tsx

async function logout() {
  const confirmation = confirm("Are you sure that you want to log out?");
  if(!confirmation) return;

  const urlParams = new URLSearchParams(window.location.search);
  const logoutChallenge = urlParams.get('logoutChallenge') as string;
  const redirectResponse = await OAuth2Provider.logOut({ logoutChallenge });
  window.location.href = redirectResponse.frontendRedirectTo;
}
```

</Tab>

<Tab value="mobile">

:::caution

For mobile apps, you need to reuse the web authentication flow. Check this [guide](/docs/authentication/unified-login/reuse-website-login) for more information.

:::

</Tab>

</Tabs>

</CustomUIInstructions>

### 5. Update the login flow in your frontend applications

Use a generic OAuth2 library to handle the login flow

<Tabs>

<Tab value="reactjs"> 

You can use the [react-oidc-context](https://github.com/authts/react-oidc-context) library.
Follow the instructions from the library's page.

Identify the configuration parameters based on the response received on **step 2**, when creating the **OAuth2 Client**.

- `authority` corresponds to the endpoint of the **Authorization Service** `<API_DOMAIN><API_BASE_PATH>`
- `clientID` corresponds to `clientId`
- `redirectUri` corresponds to a value from `callbackUrls`
- `scope` corresponds to `scope` 
    
If you are using a multi-tenant setup, you also need to specify the `tenantId` parameter in the authorization URL.
To do this, set the `extraQueryParams` property with a specific value that should look like this: `{ tenant_id: "<TENANT_ID>" }`.

</Tab>

<Tab value="angular">

You can use the [angular-oauth2-oidc](https://github.com/manfredsteyer/angular-oauth2-oidc) library.
Follow the instructions described in the [GitHub repository](https://github.com/manfredsteyer/angular-oauth2-oidc?tab=readme-ov-file#logging-in).
Identify the configuration parameters based on the response received on **step 2**, when creating the **OAuth2 Client**.

- `issuer` corresponds to the endpoint of the **Authorization Service** `<API_DOMAIN><API_BASE_PATH>`
- `client_id` corresponds to `clientId`
- `redirect_uri` corresponds to a value from `callbackUrls`
- `scope` corresponds to `scope` 

If you are using a multi-tenant setup, you also need to specify the `tenantId` parameter in the authorization URL.
To do this, set the `extraQueryParams` property with a specific value that should look like this: `{ tenant_id: "<TENANT_ID>" }`.

</Tab>

<Tab value="vue">

You can use the [oidc-client-ts](https://github.com/authts/oidc-client-ts?tab=readme-ov-file) library.
Follow the instructions described in the [GitHub repository](https://github.com/authts/oidc-client-ts/blob/main/docs/protocols/authorization-code-grant-with-pkce.md).
Identify the configuration parameters based on the response received on **step 2**, when creating the **OAuth2 Client**.

- `issuer` corresponds to the endpoint of the **Authorization Service** `<API_DOMAIN><API_BASE_PATH>`
- `client_id` corresponds to `clientId`
- `redirect_uri` corresponds to a value from `callbackUrls`
- `scope` corresponds to `scope` 

If you are using a multi-tenant setup, you also need to specify the `tenantId` parameter in the authorization URL.
To do this, set the `extraQueryParams` property with a specific value that should look like this: `{ tenant_id: "<TENANT_ID>" }`.

</Tab>
    
</Tabs>

:::info

If you want to use the [**OAuth2 Refresh Tokens**](/docs/authentication/unified-login/oauth2-basics#oauth2-refresh-token) make sure to include the `offline_access` scope during the initialization step.

:::

### 6. Test the new authentication flow

With everything set up, you can test your login flow.
Use the setup created in the previous step to check if the authentication flow completes without any issues.

# Authentication - Unified Login - Quickstart Guides -  Multiple frontend domains with separate backends
Source: https://supertokens.com/docs/authentication/unified-login/quickstart-guides/multiple-frontends-with-separate-backends

## Overview

You can use the following guide if you have a single [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) that multiple applications use.
In turn, each app has separate **`frontend`** and **`backend`** instances that serve from different domains.
The authentication flow works in the following way:

<Steps>
  ## The User accesses the `frontend` app 
   - The application `frontend` calls a login endpoint on the `backend` application.
   - The `backend` application generates an `authorization` URL to the [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) and redirects the user to it.
   - The [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) backend redirects the user to the login UI

  ## The User completes the login attempt  
   - The [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) backend redirects the user to a `callback URL` that includes the **Authorization Code**.

  ## The user accesses the callback URL
   - The **Authentication Code** gets sent to the application `backend` 
   - The `backend` exchanges the **Authentication Code** for an [**OAuth2 Access Token**](/docs/authentication/unified-login/oauth2-basics#oauth2-access-token)
   - The `backend` saves the received token in a server session and sends it back to the `frontend` as a cookie.
</Steps>

The `frontend` can use the new cookie to access protected resources from the `backend`.

<img src="/img/oauth/multiple-frontend-domains-with-separate-backends.png" alt="Multiple Frontend Domains with separate Backends"/>

## Before you start



These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page, please follow the tutorial and return here once you're done.

:::info
Note that, if the *frontends* and *backends* are in different *sub domains*, you don't need to use *OAuth* and can instead use [session sharing across sub domains](/docs/post-authentication/session-management/share-session-across-sub-domains).
:::

## Steps

### 1. Enable the Unified Login feature

Go to the [**SuperTokens.com SaaS Dashboard**](https://supertokens.com) and follow these instructions:
1. Click on the **Enabled Paid Features** button
2. Click on **Managed Service**
3. Check the **Unified Login / M2M** option
4. Click *Save* 

### 2. Create the OAuth2 Clients

For each of your applications you need to create a separate [**OAuth2 client**](/docs/authentication/unified-login/oauth2-basics#client).
You can do this by directly calling the **SuperTokens Core** API.

<HTTPRequestCard path="/recipe/oauth/clients" method="post" title="Create Client">
  <HTTPRequestCard.ShellExample>

```bash
curl --location --request POST '<CORE_URI>/recipe/oauth/clients' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '
    {
      "clientName": "<YOUR_CLIENT_NAME>",
      "responseTypes": ["code"],
      "grantTypes": ["authorization_code", "refresh_token"],
      "scope": "offline_access <custom_scope_1> <custom_scope_2>",
      "redirectUris": ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
    }
'
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/recipe/oauth/clients`;
    const options = {
      method: 'POST',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
      body: JSON.stringify({
        clientName: "<YOUR_CLIENT_NAME>",
        responseTypes: ["code"],
        grantTypes: ["authorization_code", "refresh_token"],
        scope: "offline_access <custom_scope_1> <custom_scope_2>",
        redirectUris: ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
      })
    };

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

    BASE_URL = "<CORE_URI>"
    API_KEY = "^{coreInfo.key}"

    url = f"{BASE_URL}/recipe/oauth/clients"

    payload: Dict[str, Any] ={
      "clientName": "<YOUR_CLIENT_NAME>",
      "responseTypes": ["code"],
      "grantTypes": ["authorization_code", "refresh_token"],
      "scope": "offline_access <custom_scope_1> <custom_scope_2>",
      "redirectUris": ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
    } 

    headers = {
        "api-key": API_KEY,
        "Content-Type": "application/json",
    }

    response = requests.post(url, json=payload, headers=headers)

    print(response.json())
    ```

  </HTTPRequestCard.PythonExample>
  <HTTPRequestCard.DetailsModal>
<CreateOAuth2ClientRequestDetails />
  </HTTPRequestCard.DetailsModal>
</HTTPRequestCard>

:::caution
You have to save the create OAuth2 Client response because this is not persisted internally for security reasons.
The information is necessary for the next steps.
:::

### 3. Set Up your Authorization Service backend

In your [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) you need to initialize the **OAuth2Provider** recipe.
The recipe exposes the endpoints needed for enabling the [**OAuth 2.0**](/docs/authentication/unified-login/oauth2-basics) flow.

<Tabs>
<Tab value="nodejs">

Update the `supertokens.init` call to include the `OAuth2Provider` recipe.

Add the import statement for the recipe and update the list of recipes with the new initialization step.

```tsx 

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "...",
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        OAuth2Provider.init(),
    ]
});
```

</Tab>

<Tab value="go">

:::caution

At the moment there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

<Tab value="python">

```python 
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import oauth2provider 

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    framework="fastapi",
    supertokens_config=SupertokensConfig(
        connection_uri="...",
        api_key="..."
    ),
    recipe_list=[
        oauth2provider.init()
    ],
)
```

</Tab>

</Tabs>

### 4. Configure the Authorization Service frontend 



<PrebuiltUIInstructions>

#### 4.1 Initialize the recipe 

<Tabs>

<Tab value="reactjs">

Add the import statement for the new recipe and update the list of recipe to also include the new initialization.

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        OAuth2Provider.init()
    ]
});
```

#### 4.2 Include the pre-built UI in the rendering tree.

<Question question="Do you use react-router-dom?">

<Answer title="Yes">

```tsx

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        {/*This renders the login UI on the /auth route*/}
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [OAuth2ProviderPreBuiltUI])}
                        {/*Your app routes*/}
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```

</Answer>

<Answer title="No">

```tsx

class App extends React.Component {
    render() {
        if (canHandleRoute([OAuth2ProviderPreBuiltUI])) {
            // This renders the login UI on the /auth route
            return getRoutingComponent([OAuth2ProviderPreBuiltUI])
        }

        return (
            <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
        );
    }
}
```

</Answer>

</Question>
    
</Tab>

<Tab value="angular">

Update the `AuthComponent` to include the `OAuth2Provider` recipe.
You need to add a new item in the `recipeList` array.

```tsx title="/app/auth/auth.component.ts"

  @Component({
      selector: "app-auth",
      template: '<div id="supertokensui"></div>',
  })
  export class AuthComponent implements OnDestroy, AfterViewInit {

      constructor(
          private renderer: Renderer2,
          @Inject(DOCUMENT) private document: Document
      ) { }

      ngAfterViewInit() {
          this.loadScript('^{prebuiltUIVersion}');
      }

      ngOnDestroy() {
          // Remove the script when the component is destroyed
          const script = this.document.getElementById('supertokens-script');
          if (script) {
              script.remove();
          }
      }

      private loadScript(src: string) {
          const script = this.renderer.createElement('script');
          script.type = 'text/javascript';
          script.src = src;
          script.id = 'supertokens-script';
          script.onload = () => {
              supertokensUIInit({
                  appInfo: {
                      appName: "<APP_NAME>",
                      apiDomain: "<API_DOMAIN>",
                      websiteDomain: "<WEBSITE_DOMAIN>",
                      apiBasePath: "<API_BASE_PATH>",
                      websiteBasePath: "<WEBSITE_BASE_PATH>"
                  },
                  recipeList: [
                    // Don't forget to also include the other recipes that you are already using
                    supertokensUIOAuth2Provider.init()
                  ],
              });
          }
          this.renderer.appendChild(this.document.body, script);
      }
  }
```

</Tab>

<Tab value="vue">

Update the `AuthView` component to include the `OAuth2Provider` recipe.
You need to add a new item in the `recipeList` array, inside the `supertokensUIInit` call.

```tsx
    <script lang="ts">
        export default defineComponent({
            setup() {
                const loadScript = (src: string) => {
                    const script = document.createElement('script');
                    script.type = 'text/javascript';
                    script.src = src;
                    script.id = 'supertokens-script';
                    script.onload = () => {
                        supertokensUIInit({
                            appInfo: {
                                appName: "<APP_NAME>",
                                apiDomain: "<API_DOMAIN>",
                                websiteDomain: "<WEBSITE_DOMAIN>",
                                apiBasePath: "<API_BASE_PATH>",
                                websiteBasePath: "<WEBSITE_BASE_PATH>"
                            },
                            recipeList: [
                              // Don't forget to also include the other recipes that you are already using
                              supertokensUIOAuth2Provider.init()
                            ],
                        });
                    };
                    document.body.appendChild(script);
                };

                onMounted(() => {
                    loadScript('^{prebuiltUIVersion}');
                });

                onUnmounted(() => {
                    const script = document.getElementById('supertokens-script');
                    if (script) {
                        script.remove();
                    }
                });
            },
        });
    </script>

    <template>
        <div id="supertokensui" />
    </template>
```

</Tab>
    
</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>
The user interface that you are going to build should respect this flow:

<Steps>

## A user accesses your application and tries to login.

It's up to you how you want to handle this. 
They can click a button to login or you can directly start the login flow.

## They get redirected to the **Authorization Service Backend** 

A **OAuth2/OpenID Connect (OIDC)** library can execute this action.
Check the previous guides for information on what you could use.

## The **Authorization Service Backend** redirects them to the **Authorization Service Frontend** login page.

The page URL contains a `loginChallenge` parameter that keeps track of the login attempt.
Besides that, the URL can also include a `forceFreshAuth` parameter.
As the name suggests, this should force the login UI to be visible even though the user has an existing valid session.
This guide shows you how to handle this.

## The **Authorization Service Frontend** renders the login UI and the user performs the login action.

The login UI should render based on instructions that are specific to each authentication method which you are using.
The additional thing that you have to do here is to consider the `forceFreshAuth` parameter. 

## The **Authorization Service Frontend** redirects the user back to the **Authorization Service Backend** 

After the user submits the login form, you need to redirect them to a specific route that sends them to the original application.
From here, the authentication flow completes.

</Steps>

Let's see how you can actually implement this UI.

#### 4.1 Configure the redirection URLs

As it has hinted in the previous section, the **Authorization Service Backend** sends the user to different pages from the **Authorization Service Frontend**, based on the action that needs execution.

The default values for these routes are:

- The login page maps to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>` (this is also the place where a user ends up after logout)
- The token refresh page maps to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/try-refresh`
- The logout page maps to `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/logout`

If you want to change these routes, you need to add a custom override.

:::info
This override needs addition to the **Authorization Service Backend**.
:::

<Tabs>

<Tab value="nodejs">

```tsx

OAuth2Provider.init({
    override: {
        functions: (originalFunctions) => ({
            ...originalFunctions,
            getFrontendRedirectionURL: async (input) => {
                const websiteDomain = '<WEBSITE_DOMAIN>'; 
                const websiteBasePath = '<WEBSITE_BASE_PATH>';

                if (input.type === "login") {
                    const queryParams = new URLSearchParams({
                        loginChallenge: input.loginChallenge,
                    });
                    if (input.hint !== undefined) {
                        queryParams.set("hint", input.hint);
                    }
                    if (input.forceFreshAuth) {
                        queryParams.set("forceFreshAuth", "true");
                    }

                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>?${queryParams.toString()}`;
                } else if (input.type === "try-refresh") {
                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/try-refresh?loginChallenge=${input.loginChallenge}`;
                } else if (input.type === "post-logout-fallback") {
                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>`;
                } else if (input.type === "logout-confirmation") {
                    return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/oauth/logout?logoutChallenge=${input.logoutChallenge}`;
                }

                return `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>`;
            },
        }),
    },
})

```

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

<Tab value="python">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Python SDK.

:::

</Tab>

</Tabs>

#### 4.2 Handle the forceFreshAuth parameter

Sometimes, even though there is an existing valid session in the **Authorization Service Frontend**, the requesting **Client** might force a new login attempt.
The `forceFreshAuth` parameter shows this.

When the login page renders, you also need to check for this parameter. You are doing this to know if you need to show the login UI.

Here is an example of how you can evaluate this case.

```tsx

async function shouldLogin() {
  const urlParams = new URLSearchParams(window.location.search);
  const forceFreshAuth = urlParams.get('forceFreshAuth') as string;
  if(forceFreshAuth === "true") return true;

  return Session.doesSessionExist();
}

```

:::info Multi Tenancy

If you are using multi-tenancy, you also need to keep track of the `tenantId` query parameter and pass it between the **Authorization Service Frontend** pages.

:::

#### 4.3 Complete the login attempt
  

After the user submits the login form, you need to redirect them to a specific route to complete the **OAuth 2** flow.

The following code sample shows you how to determine which URL to use.

<Tabs uiType="custom">

<Tab value="web">

```tsx

async function getInitialRedirectionURL() {
  const urlParams = new URLSearchParams(window.location.search);
  const loginChallenge = urlParams.get('loginChallenge') as string;
  const redirectionResponse = await OAuth2Provider.getRedirectURLToContinueOAuthFlow({ loginChallenge });
  if (redirectionResponse.status === "OK") {
    return redirectionResponse.frontendRedirectTo;
  }
}

```

</Tab>

<Tab value="mobile">

:::caution

For mobile apps, you need to reuse the web authentication flow. Check this [guide](/docs/authentication/unified-login/reuse-website-login) for more information.

:::

</Tab>

</Tabs>

#### 4.4 Add the token refresh page

To have support for token refreshing, you need to add a new page to your application.
The path should correspond to the one outlined during the first step.

When the user ends up on this page, you need to use the `Session` recipe to perform the refresh action.
Then they need redirection to a page from your application.

Here's a code sample that shows you how to do this.

<Tabs uiType="custom">

<Tab value="web">

```tsx

async function refreshToken() {
  await Session.attemptRefreshingSession();
  const urlParams = new URLSearchParams(window.location.search);
  const loginChallenge = urlParams.get('loginChallenge') as string;
  const redirectionResponse = await OAuth2Provider.getRedirectURLToContinueOAuthFlow({ loginChallenge });
  if (redirectionResponse.status === "OK") {
    window.location.href = redirectionResponse.frontendRedirectTo;
  }
}

```

</Tab>

<Tab value="mobile">

:::caution

For mobile apps, you need to reuse the web authentication flow. Check this [guide](/docs/authentication/unified-login/reuse-website-login) for more information.

:::

</Tab>

</Tabs>

#### 4.5 Add the logout page 

You need to add a logout page that users access when they want to end their session.
The path should correspond to the one outlined during the first step.

The logout action should first ask the user for confirmation.
If the confirmation passes, then you can call the recipe function.
Based on the final response you can redirect the user to the provided redirection URL.

<Tabs uiType="custom">

<Tab value="web">

```tsx

async function logout() {
  const confirmation = confirm("Are you sure that you want to log out?");
  if(!confirmation) return;

  const urlParams = new URLSearchParams(window.location.search);
  const logoutChallenge = urlParams.get('logoutChallenge') as string;
  const redirectResponse = await OAuth2Provider.logOut({ logoutChallenge });
  window.location.href = redirectResponse.frontendRedirectTo;
}
```

</Tab>

<Tab value="mobile">

:::caution

For mobile apps, you need to reuse the web authentication flow. Check this [guide](/docs/authentication/unified-login/reuse-website-login) for more information.

:::

</Tab>

</Tabs>
</CustomUIInstructions>

### 5. Set up session handling in each application

In each of your individual `applications` you need to set up logic for handling the **OAuth 2.0** authentication flow.
You can use a generic **OIDC** or **OAuth2** library to do this.

<Tabs additionalValues={[{ value: "c#", label: "C#" }, { value: "java", label: "Java" }, { value: "php", label: "PHP" } ]}>

<Tab value="nodejs">

You can use the [passport-oauth2](https://www.passportjs.org/packages/passport-oauth2/) library. 
Follow the instructions on the library's page and set up your application `backend`.
You can determine the configuration parameters based on the response received in **step 2**, when creating the **OAuth2 Client**.

- `authorizationURL` corresponds to `authorizeUrl`
- `tokenURL` corresponds to `tokenFetchUrl`
- `clientID` corresponds to `clientId`
- `clientSecret` corresponds to `clientSecret`
- `callbackURL` corresponds to a value from `callbackUrls`
- `scope` corresponds to `scope` 

Make sure that you expose an endpoint that calls `passport.authenticate('oauth2')`.
This way the user ends up accessing the actual login page served by the **Authorization Service**.

</Tab>

<Tab value="go">

You can use the [OAuth2](https://pkg.go.dev/golang.org/x/oauth2) library.
Follow these [instructions](https://golang.org/pkg/golang.org/x/oauth2/#example-Config-RequestToken) and implement it in your `backend`.

You can determine the configuration parameters based on the response received in **step 2**.
- `ClientID` corresponds to `clientId`
- `ClientSecret` corresponds to `clientSecret`
- `Scopes` corresponds to `scope`
- `Endpoint.AuthURL` corresponds to `authorizeUrl`
- `Endpoint.TokenURL` corresponds to `tokenFetchUrl`

Make sure that you expose an endpoint that redirects to the authentication URL obtained from calling `AuthCodeURL`.
This way the user ends up accessing the actual login page served by the **Authorization Service**.

</Tab>

<Tab value="python"> 

You can use the [AuthLib](https://docs.authlib.org/) library.
Follow these [instructions](https://docs.authlib.org/en/latest/client/oauth2.html) and implement it in your `backend`.

You can determine the configuration parameters based on the response received in **step 2**.
- `client_id` corresponds to `clientId`
- `client_secret` corresponds to `clientSecret`
- `scope` corresponds to `scope` 
- `authorization_endpoint` corresponds to `authorizeUrl`
- `token_endpoint` corresponds to `tokenFetchUrl`

Make sure that you expose an endpoint that redirects to the authentication URL obtained from calling `create_authorization_url`.
This way the user ends up accessing the actual login page served by the **Authorization Service**.

</Tab>

<Tab value="php"> 

You can use the [League OAuth2 Client](https://github.com/thephpleague/oauth2-client) library.
Follow these [instructions](https://oauth2-client.thephpleague.com/usage/) and implement it in your `backend`.

You can determine the configuration parameters based on the response received in **step 2**.
- `clientId` corresponds to `clientId`
- `clientSecret` corresponds to `clientSecret`
- `redirectUri` corresponds to a value from `callbackUrls` 
- `urlAuthorize` corresponds to `authorizeUrl`
- `urlAccessToken` corresponds to `tokenFetchUrl`

Make sure that you expose an endpoint that redirects to the authentication URL obtained from calling `getAuthorizationUrl`.
This way the user ends up accessing the actual login page served by the **Authorization Service**.

</Tab>

<Tab value="java">

You can use the [Spring Security](https://github.com/spring-projects/spring-security) library.
Follow these [instructions](https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html#oauth2-client-log-users-in) and implement it in your `backend`.

You can determine the configuration parameters based on the response received in **step 2**.

- `client-id` corresponds to `clientId`
- `client-secret` corresponds to `clientSecret`
- `scope` corresponds to `scope` 
- `issuer-uri` corresponds to `<API_DOMAIN><API_BASE_PATH>` 

</Tab>

<Tab value="c#">

You can use the [IdentityModel](https://github.com/IdentityModel/IdentityModel) library.
Follow these [instructions](https://identitymodel.readthedocs.io/en/latest/client/token.html#requesting-a-token-using-the-authorization-code-grant-type) and implement it in your `backend`.

You can determine the configuration parameters based on the response received in **step 2**.

- `Address` corresponds to `<API_DOMAIN><API_BASE_PATH>` 
- `ClientId` corresponds to `clientId`
- `ClientSecret` corresponds to `clientSecret`
- `RedirectUri` corresponds to a value from `callbackUrls` 

Make sure that you expose an endpoint that redirects to the authentication URL obtained by using [this example](https://identitymodel.readthedocs.io/en/latest/misc/request_url.html#authorization-endpoint).
This way the user ends up accessing the actual login page served by the **Authorization Service**.

</Tab>

</Tabs>

:::info

If you want to use the [**OAuth2 Refresh Tokens**](/docs/authentication/unified-login/oauth2-basics#oauth2-refresh-token) make sure to include the `offline_access` scope during the initialization step.

:::

### 6. Update the login flow in your frontend applications

In your `frontend` applications you need to add a login action that directs the user to the authentication page.

The user should first redirect to the `backend` authentication endpoint defined during the previous step.
There the `backend` generates a safe `authorization` URL using the **OAuth2** library and then redirects the user there.
After the user has logged in from the [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) they redirect to the `backend` callback URL.
Then the `backend` creates the authentication session and sends it to the user agent as a cookie.

### 7. Test the new authentication flow

With everything set up, you can test your login flow.
Use the setup created in the previous step to check if the authentication flow completes without any issues.

# Authentication - Unified Login - Quickstart Guides -  Reuse website login for desktop and mobile apps
Source: https://supertokens.com/docs/authentication/unified-login/quickstart-guides/reuse-website-login

## Overview

This pattern is useful if you want to have the same web authentication experience for your desktop and mobile apps.
The implementation allows you to save development time but keep in mind that it does not involve a native authentication interface.
Users get directed to a separate browser page where they complete the authentication flow and then return to your application.

The authentication flow works in the following way:

<Steps>
## User accesses the native application
 - The user gets redirected to [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) authentication URL.
 - The [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) redirects the user to the login UI

## User completes the login attempt 
 - The [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) backend redirects the user to the `callback URL`.
 - This URL should be a deep link that your actual application can open.

## The application uses the callback URL information to request a **OAuth2 Access Token** from the [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server).
 - The application saves the returned token.
</Steps>

<img src="/img/oauth/reuse-web-ui-for-mobile.png" alt="Reuse website login for desktop and mobile apps"/>

## Before you start



These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page, please follow the tutorial and return here once you're done.

## Steps

### 1. Enable the Unified Login feature

Go to the [**SuperTokens.com SaaS Dashboard**](https://supertokens.com) and follow these instructions:
1. Click on the **Enabled Paid Features** button
2. Click on **Managed Service**
3. Check the **Unified Login / M2M** option
4. Click *Save* 

### 2. Create the OAuth2 Clients

For each of your applications you need to create a separate [**OAuth2 client**](/docs/authentication/unified-login/oauth2-basics#client).
You can do this by directly calling the **SuperTokens Core** API.

<HTTPRequestCard path="/recipe/oauth/clients" method="post" title="Create Client">
  <HTTPRequestCard.ShellExample>

```bash
curl --location --request POST '<CORE_URI>/recipe/oauth/clients' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '
    {
      "clientName": "<YOUR_CLIENT_NAME>",
      "responseTypes": ["code", "id_token"],
      "grantTypes": ["authorization_code", "refresh_token"],
      "tokenEndpointAuthMethod": "none",
      "scope": "offline_access <custom_scope_1> <custom_scope_2>",
      "redirectUris": ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
    }
'
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/recipe/oauth/clients`;
    const options = {
      method: 'POST',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
      body: JSON.stringify({
        clientName: "<YOUR_CLIENT_NAME>",
        responseTypes: ["code", "id_token"],
        grantTypes: ["authorization_code", "refresh_token"],
        tokenEndpointAuthMethod: "none",
        scope: "offline_access <custom_scope_1> <custom_scope_2>",
        redirectUris: ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
      })
    };

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

    BASE_URL = "<CORE_URI>"
    API_KEY = "^{coreInfo.key}"

    url = f"{BASE_URL}/recipe/oauth/clients"

    payload: Dict[str, Any] ={
      "clientName": "<YOUR_CLIENT_NAME>",
      "responseTypes": ["code", "id_token"],
      "grantTypes": ["authorization_code", "refresh_token"],
      "tokenEndpointAuthMethod": "none",
      "scope": "offline_access <custom_scope_1> <custom_scope_2>",
      "redirectUris": ["https://<YOUR_APPLICATION_DOMAIN>/oauth/callback"],
    } 

    headers = {
        "api-key": API_KEY,
        "Content-Type": "application/json",
    }

    response = requests.post(url, json=payload, headers=headers)

    print(response.json())
    ```

  </HTTPRequestCard.PythonExample>
  <HTTPRequestCard.DetailsModal>
<CreateOAuth2ClientRequestDetails />
  </HTTPRequestCard.DetailsModal>
</HTTPRequestCard>

:::caution
You have to save the create OAuth2 Client response because this is not persisted internally for security reasons.
The information is necessary for the next steps. 
:::

Based on the client creation process, you can infer two additional values that you need later on:
- `authorizeUrl` corresponds to `<API_DOMAIN><API_BASE_PATH>/oauth/auth`
- `tokenFetchUrl` corresponds to `<API_DOMAIN><API_BASE_PATH>/oauth/token`

### 3. Configure the Authorization Service

Check one of the previous guides that show you how to set up the **Authorization Service** and then return to this page.
Choose the tutorial based whether you use multiple backend services or not:
- [Single Backend Setup](/docs/authentication/unified-login/quickstart-guides/multiple-frontends-with-a-single-backend#3-set-up-the-authorization-service-backend)
- [Multiple Backends Setup](/docs/authentication/unified-login/quickstart-guides/multiple-frontends-with-a-single-backend#3-set-up-the-authorization-service-backend)

### 4. Update the login flow in your applications

In each of your individual `applications`, you need to set up logic for handling the **OAuth 2.0** authentication flow.
You can use a generic **OIDC** or **OAuth** library to do this.

<Tabs>

<Tab value="reactnative">

<Tabs.Section>

You can use the [react-native-app-auth](https://commerce.nearform.com/open-source/react-native-app-auth/) library. 
Follow [the instructions](https://commerce.nearform.com/open-source/react-native-app-auth/docs/usage/config) to set up your application. 

You can identify the configuration parameters based on the response received in **step 2**, when creating the **OAuth2 Client**.

- `issuer` corresponds to the endpoint of the **Authorization Service** `<API_DOMAIN><API_BASE_PATH>`
- `clientID` corresponds to `clientId`
- `redirectUrl` corresponds a value from `callbackUrls`
- `scopes` corresponds to `scopes` 

You also need to set the `additionalParameters` property with the following values:
- `max_age: 0` This forces a new authentication flow once the user ends up on the **Authorization Service** frontend.
- `tenant_id: <TENANT_ID>` Optional, in case you are using a multi tenant setup. Set this to the actual tenant ID.

</Tabs.Section>

</Tab>

<Tab value="android">

<Tabs.Section>

You can use the [AppAuth-Android](https://github.com/openid/AppAuth-Android) library. 
Follow [the instructions](https://github.com/openid/AppAuth-Android?tab=readme-ov-file#authorization-service-configuration) to set up your application. 

You can identify the configuration parameters based on the response received in **step 2**, when creating the **OAuth2 Client**.

For the `AuthorizationServiceConfiguration`, the parameters you need to provide are: `authorizeUrl` and `tokenFetchUrl`.
When calling the `AuthorizationRequest.Builder` function you can use `clientId` and a value from `callbackUrls` to replace the example values.

You need to set additional query parameters by calling the `setAdditionalParameters` function on the `AuthorizationRequest.Builder` object:
- `max_age: 0` This forces a new authentication flow once the user ends up on the **Authorization Service** frontend.
- `tenant_id: <TENANT_ID>` Optional, in case you are using a multi tenant setup. Set this to the actual tenant ID.

</Tabs.Section>

</Tab>

<Tab value="ios">

<Tabs.Section>

You can use the [AppAuth-iOS](https://github.com/openid/AppAuth-Android) library. 
Follow [the instructions](https://github.com/openid/AppAuth-iOS?tab=readme-ov-file#auth-flow) to set up your application. 

You can identify the configuration parameters based on the response received in **step 2**, when creating the **OAuth2 Client**.

- `clientID` corresponds to `clientId`
- `redirectUrl` corresponds a value from `callbackUrls`
- `scopes` corresponds to `scopes` 
- `authorizationEndpoint` corresponds to `authorizeUrl`
- `tokenEndpoint` corresponds to `tokenFetchUrl`

You also need to set extra query parameters, when instantiating the `OIDAuthorizationRequest` object, with the following values:
- `max_age: 0` This forces a new authentication flow once the user ends up on the **Authorization Service** frontend.
- `tenant_id: <TENANT_ID>` Optional, in case you are using a multi tenant setup. Set this to the actual tenant ID.

</Tabs.Section>

</Tab>

<Tab value="flutter"> 

<Tabs.Section>

You can use the [AppAuth](https://github.com/MaikuB/flutter_appauth) library. 
Follow [the instructions](https://github.com/MaikuB/flutter_appauth/tree/master/flutter_appauth) to set up your application. 

You can identify the configuration parameters based on the response received in **step 2**, when creating the **OAuth2 Client**.

- `<client_id>` corresponds to `clientId`
- `<issuer>` corresponds to the endpoint of the **Authorization Service** `<API_DOMAIN><API_BASE_PATH>`
- `<redirect_url>` corresponds a value from `callbackUrls`
- `scopes` corresponds to `scopes` 

You also need to set the `additionalParameters` property with the following values:
- `max_age: 0` This forces a new authentication flow once the user ends up on the **Authorization Service** frontend.
- `tenant_id: <TENANT_ID>` Optional, in case you are using a multi tenant setup. Set this to the actual tenant ID.

</Tabs.Section>

</Tab>

</Tabs>

:::info

If you want to use the [**OAuth2 Refresh Tokens**](/docs/authentication/unified-login/oauth2-basics#oauth2-refresh-token) make sure to include the `offline_access` scope during the initialization step.

:::

### 5. Test the new authentication flow

With everything set up, you can test your login flow.
Use the setup created in the previous step to check if the authentication flow completes without any issues.

# Authentication - Unified Login -  Work with scopes
Source: https://supertokens.com/docs/authentication/unified-login/work-with-scopes

## Overview

The creation process of an **OAuth2 Client** determines the allowed scopes.
By default, the **OAuth2** implementation adds the following built-in scopes:

| Scope | Claims Added | Notes |
|-------|-------------|--------|
| `email` | `email`, `emails`, `email_verified` | Added to ID Token and User Info |
| `phoneNumber` | `phoneNumber`, `phoneNumbers`, `phoneNumber_verified` | Added to ID Token and User Info |
| `roles` | The roles return by `getRolesForUser` | Added to ID Token and Access Token |
| `permissions` | The list of permissions obtained by concatenating the result of `getPermissionsForRole` for all roles returned by `getRolesForUser`  | Added to ID Token and Access Token |
 
---

## Request specific scopes

The client can request specific scopes by adding `scope` query parameter to the **Authorization URL**.
The requested scopes have to be a subset of what the client allows, otherwise the authentication request fails.
By default, the client receives all scopes.

---

## Override granted scopes

If you want to manually modify the list of scopes that the client receives during the authentication flow, you can do this by using overrides.

<Tabs>

<Tab value="nodejs">

```tsx

OAuth2Provider.init({
    override: {
        functions: (originalFunctions) => ({
            ...originalFunctions,
            getRequestedScopes: async (input) => {
                const originallyRequestedScopes = await originalFunctions.getRequestedScopes(input);
                const filteredScopes = originallyRequestedScopes.filter((scope) => scope !== "profile");
                return [...filteredScopes, "custom-scope"];
            },
        }),
    },
});
```

</Tab>

<Tab value="go">

:::caution
The Go SDK does not support creating OAuth2 providers.
:::

</Tab>

<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import oauth2provider 
from supertokens_python.recipe.oauth2provider.interfaces import RecipeInterface
from supertokens_python.types import RecipeUserId
from typing import Dict, List, Any, Optional 

def override_oauth2provider_functions(original_implementation: RecipeInterface):
  original_get_requested_scopes = original_implementation.get_requested_scopes

  async def get_requested_scopes(
        recipe_user_id: Optional[RecipeUserId],
        session_handle: Optional[str],
        scope_param: List[str],
        client_id: str,
        user_context: Dict[str, Any],
    ):
    originally_requested_scopes = await original_get_requested_scopes(
      recipe_user_id, session_handle, scope_param, client_id, user_context
    )
    filtered_scopes = [scope for scope in originally_requested_scopes if scope != "profile"]
    return [*filtered_scopes, "custom-scope"]

  original_implementation.get_requested_scopes = get_requested_scopes
  return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    framework="fastapi",
    supertokens_config=SupertokensConfig(
        connection_uri="...",
        api_key="..."
    ),
    recipe_list=[
        oauth2provider.init(
          override=oauth2provider.InputOverrideConfig(functions=override_oauth2provider_functions)
        )
    ],
)

```

</Tab>

</Tabs>

# Authentication - Unified Login -  Verify tokens
Source: https://supertokens.com/docs/authentication/unified-login/verify-tokens

## Overview 

You can verify an **OAuth2 Access Token** in two ways:
- By using a standard **JWT**, JSON Web Token, verification library
- By calling the special introspection endpoint that gets exposed through the core service

One thing to note is that, besides the standard **OAuth2** token claims, the **Unified Login** implementation includes an additional one called `stt`.
This stands for `SuperTokens Token Type`.
It ensures that the validation occurs for the correct token type:
- `0` represents a **SuperTokens Session Access Token** 
- `1` represents an **OAuth2 Access Token**
- `2` represents an **OAuth2 ID Token**.

:::caution no-title

The following guide covers only **OAuth2 Tokens** verification.
For information on how to verify **SuperTokens Session Tokens** please refer to the [following section](/docs/additional-verification/session-verification/protect-api-routes).

:::

---

## Using a JWT verification library

This is the standard validation method and you should use it for most of the operations that need protection.
It indicates that the token is valid from a cryptographic standpoint and that it has not expired.

The code samples show you a basic validation scenario where the token undergoes a check for the required scope for an action to occur.

:::info

If your scenario involves a common backend with multiple frontend clients you can drop the `client_id` check. 

:::



<Tabs additionalValues={[{ value: "c#", label: "C#" }, { value: "java", label: "Java" }, { value: "php", label: "PHP" } ]}>

<Tab value="nodejs">

For NodeJS you can use [`jose`](https://github.com/panva/jose) to verify the token.

```tsx

const JWKS = jose.createRemoteJWKSet(new URL('<API_DOMAIN><API_BASE_PATH>jwt/jwks.json'))

// Follow this example if you are using the Authorization Code Flow
async function validateToken(jwt: string) {
  const requiredScope = "<YOUR_REQUIRED_SCOPE>";
  const clientId = '<CLIENT_ID>';

  try {
    const { payload } = await jose.jwtVerify(jwt, JWKS, {
      requiredClaims: ['stt', 'scp', 'client_id'],
    });

    if(payload.stt !== 1) return false;
    if(payload.client_id !== clientId) return false;
    
    const scopes = payload.scp as string[];
    return scopes.includes(requiredScope);
  } catch (err) {
    return false;
  }
}
```

</Tab>

<Tab value="go">

You can use the [`jwx`](https://github.com/lestrrat-go/jwx) library to verify the token.

```go
        return true
      }
    }

    return false;
}
```

</Tab>

<Tab value="python">

You can use the [PyJWT](https://github.com/jpadilla/pyjwt) library to verify the token.

```python      
from typing import Optional, List

use Firebase\JWT\JWT;
use Firebase\JWT\Key;

function validateToken($jwt) {
    $apiDomain = "<API_DOMAIN>";
    $apiBasePath = "<API_BASE_PATH>";
    $jwksUrl = $apiDomain . $apiBasePath . '/jwt/jwks.json';
    $requiredScope = "<YOUR_REQUIRED_SCOPE>";
    $clientId = "<CLIENT_ID>";

    $jwks = json_decode(file_get_contents($jwksUrl), true);
    try {
        $decoded = JWT::decode($jwt, JWK::parseKeySet($jwks), 'RS256'));
        if ($decoded->sst !== 1) {
          return false;
        }
        if ($decoded->client_id !== $clientId) {
            return false;
        }
        return in_array($requiredScope, $decoded->scp);
    } catch (Exception $e) {
        return false;
    }
}
```

</Tab>

<Tab value="java">

You can use the [Auth0 JWT](https://github.com/auth0/java-jwt) library to verify the token.
Here is an example of how you can do that:

```java

public class JWTVerifier {

    private static final String JWKS_URL = "<API_DOMAIN><API_BASE_PATH>jwt/jwks.json";
    private static final String CLIENT_ID = "<CLIENT_ID>";

    private static Map<String, Object> fetchJWKS() throws Exception {
        URL url = new URL(JWKS_URL);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("GET");
        
        InputStream responseStream = connection.getInputStream();
        Scanner scanner = new Scanner(responseStream, StandardCharsets.UTF_8.name());
        String responseBody = scanner.useDelimiter("\\A").next();
        scanner.close();
        
        return JWT.decode(responseBody).getHeader();
    }

    public static boolean validateToken(String token) {
        try {
            Map<String, Object> jwks = fetchJWKS();
            
            Algorithm algorithm = Algorithm.RSA256(jwks.get("x5c"), null);
            JWTVerifier verifier = JWT.require(algorithm)
                    .build();
            
            DecodedJWT jwt = verifier.verify(token);
            if(jwt.getClaim("sst").asInt() != 1) {
              return false;
            }

            if(jwt.getClaim("client_id").asString() != CLIENT_ID) {
              return false;
            }

            List<String> scopes = jwt.getClaim("scp").asList();
            return scopes.contains(requiredScope);
        } catch (Exception e) {
            return false;
        }
    }
}
```

</Tab>

<Tab value="c#">

You can use the [IdentityModel](https://github.com/IdentityModel/IdentityModel) library to verify the token.

```csharp

using System;
using System.Linq;
using Microsoft.IdentityModel.Tokens;
using System.IdentityModel.Tokens.Jwt;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json.Linq;

class AuthorizationCodeTokenValidator
{
    static async Task<bool> ValidateToken(string jwtStr)
    {
        string apiDomain = "<API_DOMAIN>";
        string apiBasePath = "<API_BASE_PATH>";
        string clientId = "<CLIENT_ID>";
        string requiredScope = "<REQUIRED_SCOPE>";

        HttpClient client = new HttpClient();
        var response = await client.GetStringAsync($"<API_DOMAIN>/<API_BASE_PATH>/jwt/jwks.json");
        var jwks = new JsonWebKeySet(response);

        var tokenHandler = new JwtSecurityTokenHandler();
        var validationParameters = new TokenValidationParameters
        {
            IssuerSigningKeys = jwks.Keys
        };

        try
        {
            SecurityToken validatedToken;
            var principal = tokenHandler.ValidateToken(jwtStr, validationParameters, out validatedToken);
            var claims = principal.Claims.ToDictionary(c => c.Type, c => c.Value);

            if (!claims.ContainsKey("stt") || claims["stt"] != "1")
            {
                return false;
            }

            if (!claims.ContainsKey("client_id") || claims["client_id"] != clientId)
            {
                return false;
            }

            var scopes = claims["scp"].Split(" ");
            if (!scopes.Contains(requiredScope))
            {
                return false;
            }

            return true;
        }
        catch (Exception)
        {
            return false;
        }
    }
}
```

</Tab>

</Tabs>

### Email verification

If you are using email and password based authentication, and you want to validate if the user has verified their email, you must check if the `email_verified` claim is true.

---

## Using the token introspection API

When a user logs out, their token gets removed from the **SuperTokens Core** database. 
That change does not reflect in token validation process that uses a JWT verification library.
The token remains valid until its expiration time.

To ensure that the token remains valid, you can directly call the **SuperTokens Core** service.
It is advisable to perform this process for high security operations to avoid the risk of a malicious agent using a token.

Here is an example of how you can use this validation method:

<Tabs additionalValues={[{ label: "cURL", value: "curl" }]}>

<Tab value="nodejs">

```tsx

async function validateToken(token: string) {
  const { status } = await OAuth2Provider.validateOAuth2AccessToken(
    token,
    {
      clientId: "<CLIENT_ID>",
      scopes: ["<REQUIRED_SCOPE>"],
    },
    true
  );

  return status === "OK";
}
```

</Tab>

<Tab value="go">

:::caution

The Go SDK does not support creating OAuth2 providers.

:::

</Tab>

<Tab value="python">

```python
from supertokens_python.recipe.oauth2provider.interfaces import OAuth2TokenValidationRequirements

# Authentication - Unified Login -  Add custom claims in tokens
Source: https://supertokens.com/docs/authentication/unified-login/add-custom-claims-in-tokens

## Overview

If you want to add custom properties in the token payloads you can do this by using overrides.

---

## Add claims in the OAuth2 Access Token

<Tabs>

<Tab value="nodejs">

Override the `buildAccessTokenPayload` function to include the custom claims.

```tsx

OAuth2Provider.init({
    override: {
        functions: (originalImplementation) => ({
            ...originalImplementation,
            buildAccessTokenPayload: async (input) => {
                const addedInfo: Record<string, any> = {};
                if (input.scopes.includes("profile")) {
                    addedInfo.profile = "custom-value";
                }
                return {
                    ...(await originalImplementation.buildAccessTokenPayload(input)),
                    ...addedInfo,
                };
            },
        }),
    },
});

```

</Tab>

<Tab value="go">

:::caution
At the moment there is no support for creating OAuth2 providers in the Go SDK.
:::

</Tab>

<Tab value="python">

Override the `build_access_token_payload` function to include the custom claims.

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig 
from supertokens_python.recipe import oauth2provider 
from supertokens_python.recipe.oauth2provider.oauth2_client import OAuth2Client
from supertokens_python.recipe.oauth2provider.interfaces import RecipeInterface 
from supertokens_python.types import User 
from typing import Dict, List, Any, Optional 

def override_oauth2provider_functions(original_implementation: RecipeInterface):
  original_build_access_token_payload = original_implementation.build_access_token_payload

  async def build_access_token_payload(
        user: Optional[User],
        client: OAuth2Client,
        session_handle: Optional[str],
        scopes: List[str],
        user_context: Dict[str, Any],
    ) -> Dict[str, Any]:
    added_info = {}
    if "profile" in scopes:
        added_info['profile'] = "custom-value"
    
    original_payload = await original_build_access_token_payload(
      user, client, session_handle, scopes, user_context
    )
    return {**original_payload, **added_info}

  original_implementation.build_access_token_payload = build_access_token_payload
  return original_implementation

init(
    framework="...", # type: ignore
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
        api_key="..."
    ),
    recipe_list=[
        oauth2provider.init(
          override=oauth2provider.InputOverrideConfig(functions=override_oauth2provider_functions)
        )
    ],
)
```

</Tab>

</Tabs>

---

## Add claims in the ID Token

<Tabs>

<Tab value="nodejs">

Override the `buildIdTokenPayload` function to include the custom claims.

```tsx

OAuth2Provider.init({
    override: {
        functions: (originalImplementation) => ({
            ...originalImplementation,
            buildIdTokenPayload: async (input) => {
                const addedInfo: Record<string, any> = {};
                if (input.scopes.includes("profile")) {
                    addedInfo.profile = "custom-value";
                }
                return {
                    ...(await originalImplementation.buildIdTokenPayload(input)),
                    ...addedInfo,
                };
            },
        }),
    },
});

```

</Tab>

<Tab value="go">

:::caution
At the moment there is no support for creating OAuth2 providers in the Go SDK.
:::

</Tab>

<Tab value="python">

Override the `build_id_token_payload` function to include the custom claims.

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import oauth2provider 
from supertokens_python.recipe.oauth2provider.oauth2_client import OAuth2Client 
from supertokens_python.recipe.oauth2provider.interfaces import RecipeInterface 
from supertokens_python.types import User 
from typing import Dict, List, Any, Optional 

def override_oauth2provider_functions(original_implementation: RecipeInterface):
  original_build_id_token_payload = original_implementation.build_id_token_payload

  async def build_id_token_payload(
        user: Optional[User],
        client: OAuth2Client,
        session_handle: Optional[str],
        scopes: List[str],
        user_context: Dict[str, Any],
    ) -> Dict[str, Any]:
    added_info = {}
    if "profile" in scopes:
        added_info['profile'] = "custom-value"
    
    original_payload = await original_build_id_token_payload(
      user, client, session_handle, scopes, user_context
    )
    return {**original_payload, **added_info}

  original_implementation.build_id_token_payload = build_id_token_payload
  return original_implementation

init(
    framework="...", # type: ignore
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
        api_key="..."
    ),
    recipe_list=[
        oauth2provider.init(
          override=oauth2provider.InputOverrideConfig(functions=override_oauth2provider_functions)
        )
    ],
)
```

</Tab>

</Tabs>

# Authentication - Machine to Machine -  Client credentials authentication
Source: https://supertokens.com/docs/authentication/m2m/client-credentials

## Overview

In the **Client Credentials Flow** the authentication sequence works in the following way:

<Steps>

## `Service A` uses credentials to get an **OAuth2 Access Token**
## [**Authorization Service**](/docs/authentication/unified-login/oauth2-basics#authorization-server) returns the **OAuth2 Access Token**
## `Service A` uses the **OAuth2 Access Token** to communicate with `Service B`
## `Service B` validates the **OAuth2 Access Token**
## If the token is valid `Service B` returns the requested resource

</Steps>

<img src="/img/oauth/machine-to-machine.png" alt="Machine to Machine Authentication"/>

Before going into the actual instructions, start by imagining a real life example that you can reference along the way.
This makes it easier to understand what is happening.

We are going to configure authentication for the following setup:
- A **Calendar Service** that exposes these actions: `event.view`, `event.create`, `event.update` and `event.delete`
- A **File Service** that exposes these actions: `file.view`, `file.create`, `file.update` and `file.delete`
- A **Task Service** that interacts with the **Calendar Service** and the **File Service** in the process of scheduling a task 

The aim is to allow the **Task Service** to perform an authenticated action on the **Calendar Service**.
Proceed to the actual steps.

## Before you start



These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page, please follow the tutorial and return here once you're done.

## Steps

### 1. Enable the OAuth2 features from the Dashboard

You first have to enable the **OAuth2** features from the **SuperTokens.com Dashboard**.
1. Open the **SuperTokens.com Dashboard**
2. Click on the **Enabled Paid Features** button
3. Click on **Managed Service**
4. Check the **Unified Login / M2M** option
5. Click *Save* 

You should be able to use the OAuth2 recipes in your applications.

### 2. Create the OAuth2 Clients

For each of your **`microservices`** you need to create a separate [**OAuth2 client**](/docs/authentication/unified-login/oauth2-basics#client).
This can occur by directly calling the **SuperTokens Core** API.

<HTTPRequestCard path="/recipe/oauth/clients" method="post" title="Create Client">
  <HTTPRequestCard.ShellExample>

```bash
curl --location --request POST '<CORE_URI>/recipe/oauth/clients' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '
    {
      "clientName": "<YOUR_CLIENT_NAME>",
      "grantTypes": ["client_credentials"],
      "scope": "<custom_scope_1> <custom_scope_2>",
      "audience": ["<AUDIENCE_NAME>"],
    }
'
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/recipe/oauth/clients`;
    const options = {
      method: 'POST',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
      body: JSON.stringify({
        clientName: "<YOUR_CLIENT_NAME>",
        grantTypes: ["client_credentials"],
        scope: "<custom_scope_1> <custom_scope_2>",
        audience: ["<AUDIENCE_NAME>"],
      })
    };

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

    BASE_URL = "<CORE_URI>"
    API_KEY = "^{coreInfo.key}"

    url = f"{BASE_URL}/recipe/oauth/clients"

    payload: Dict[str, Any] ={
      "clientName": "<YOUR_CLIENT_NAME>",
      "grantTypes": ["client_credentials"],
      "scope": "custom_scope_1> <custom_scope_2>",
      "audience": ["<AUDIENCE_NAME>"],
    } 

    headers = {
        "api-key": API_KEY,
        "Content-Type": "application/json",
    }

    response = requests.post(url, json=payload, headers=headers)

    print(response.json())
    ```

  </HTTPRequestCard.PythonExample>
  <HTTPRequestCard.DetailsModal>
<CreateOAuth2ClientRequestDetails />
  </HTTPRequestCard.DetailsModal>
</HTTPRequestCard>

:::info Custom Example

To create a client for the **Task Service**, use the following attributes:

```json
  {
    "clientName": "Task Service",
    "grantTypes": ["client_credentials"],
    "scope": "event.view event.create event.edit event.delete file.view file.create file.edit file.delete",
    "audience": ["event", "file"]
  }
```

This allows the **Task Service** to perform all types of actions against both of the other services as long as it has a valid **OAuth2 Access Token**.

:::

:::caution
You have to save the create response because this is not persisted internally for security reasons.
The information is necessary for the next steps. 
:::

### 3. Set Up your Authorization Service 

In your [**Authorization Server**](/docs/authentication/unified-login/oauth2-basics#authorization-server) backend, initialize the **OAuth2Provider** recipe.

<Tabs>

<Tab value="nodejs">

Update the `supertokens.init` call to include the new recipe.

```tsx

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "...",
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      OAuth2Provider.init(),
    ]
});
```

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.
You can use the [legacy method](/docs/microservice_auth/legacy/implementation-guide) to authenticate microservices based on your language.

:::

</Tab>

<Tab value="python">

```python 
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import oauth2provider 

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    framework="fastapi",
    supertokens_config=SupertokensConfig(
        connection_uri="...",
        api_key="..."
    ),
    recipe_list=[
        oauth2provider.init()
    ],
)
```

</Tab>

</Tabs>

### 4. Generate access tokens



You can directly call the [**Authorization Server**](/docs/authentication/unified-login/oauth2-basics#authorization-server) to generate Access Tokens.
Check the following code snippet to see how you can do that:

```bash
curl -X POST <API_DOMAIN><API_BASE_PATH>/oauth/token \
-H "Content-Type: application/json" \
-d '{
  "clientId": "<CLIENT_ID>",
  "clientSecret": "<CLIENT_SECRET>",
  "grantType": "client_credentials",
  "scope": ["<RESOURCE_SCOPE>"],
  "audience": "<AUDIENCE>"
}'
```

You should limit the scopes that you are requesting to the ones necessary to perform the desired action.

:::info Custom Example

If the **Task Service** wants to create an event on the **Calendar Service**, a token with the following attributes needs generation:

```json
  {
    "clientId": "<TASK_SERVICE_CLIENT_ID>",
    "clientSecret": "<TASK_SERVICE_CLIENT_SECRET>",
    "grantType": "client_credentials",
    "scope": ["event.create"],
    "audience": "event"
  }
```

:::

The **Authorization Server** returns a response that looks like this:

```json
{
    "accessToken": "<TOKEN_VALUE>",
    "expiresIn": 3600
}
```

Save the `accessToken` in memory for use in the next step.
The `expiresIn` field indicates how long the token is valid for.

Each service that you communicate with needs its own token.

With an **OAuth2 Access Token**, it can facilitate communication with the other services.
Keep in mind to generate a new one when it expires.

### 5. Verify an OAuth2 Access Token

To check the validity of a token, use a generic **JWT** verification library.

Besides the standard **OAuth2** token claims, the implementation includes an additional one called `stt`.
This stands for `SuperTokens Token Type`.
It ensures that the validation occurs for the correct token type:
- `0` represents a **SuperTokens Session Access Token**
- `1` represents an **OAuth2 Access Token**
- `2` represents an **OAuth2 ID Token**.

<Tabs additionalValues={[{ value: "c#", label: "C#" }, { value: "java", label: "Java" }, { value: "php", label: "PHP" } ]}>

<Tab value="nodejs">

For NodeJS you can use [`jose`](https://github.com/panva/jose) to verify the token.

```tsx

const JWKS = jose.createRemoteJWKSet(new URL('<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'))

async function validateClientCredentialsToken(jwt: string) {
  const requiredScope = "<YOUR_REQUIRED_SCOPE>";
  const audience = '<AUDIENCE>';

  try {
    const { payload } = await jose.jwtVerify(jwt, JWKS, {
      audience,
      requiredClaims: ['stt', 'scp'],
    });

    if(payload.stt !== 1) return false;
    
    const scopes = payload.scp as string[];
    return scopes.includes(requiredScope);
  } catch (err) {
    return false;
  }
}
```

</Tab>

<Tab value="go">

You can use the [`jwx`](https://github.com/lestrrat-go/jwx) library to verify the token.

```go
        return true
      }
    }

    return false;
}
```

</Tab>

<Tab value="python">

You can use the [PyJWT](https://github.com/jpadilla/pyjwt) library to verify the token.

```python      
from typing import Optional, List

use Firebase\JWT\JWT;
use Firebase\JWT\Key;

function validateToken($jwt) {
    $apiDomain = "<API_DOMAIN>";
    $apiBasePath = "<API_BASE_PATH>";
    $jwksUrl = $apiDomain . $apiBasePath . '/jwt/jwks.json';
    $requiredScope = "<YOUR_REQUIRED_SCOPE>";
    $audience = "<AUDIENCE>";

    $jwks = json_decode(file_get_contents($jwksUrl), true);
    try {
        $decoded = JWT::decode($jwt, JWK::parseKeySet($jwks), 'RS256'));
        if ($decoded->aud !== $audience) {
            return false;
        }
        if ($decoded->sst !== 1) {
          return false;
        }
        return in_array($requiredScope, $decoded->scp);
    } catch (Exception $e) {
        return false;
    }
}
```

</Tab>

<Tab value="java">

You can use the [Auth0 JWT](https://github.com/auth0/java-jwt) library to verify the token.

```java

public class JWTVerifier {

    private static final String JWKS_URL = "<API_DOMAIN><API_BASE_PATH>jwt/jwks.json";
    private static final String AUDIENCE = "<AUDIENCE>";

    private static Map<String, Object> fetchJWKS() throws Exception {
        URL url = new URL(JWKS_URL);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("GET");
        
        InputStream responseStream = connection.getInputStream();
        Scanner scanner = new Scanner(responseStream, StandardCharsets.UTF_8.name());
        String responseBody = scanner.useDelimiter("\\A").next();
        scanner.close();
        
        return JWT.decode(responseBody).getHeader();
    }

    public static boolean validateToken(String token) {
        try {
            Map<String, Object> jwks = fetchJWKS();
            
            Algorithm algorithm = Algorithm.RSA256(jwks.get("x5c"), null);
            JWTVerifier verifier = JWT.require(algorithm)
                    .withAudience(AUDIENCE)
                    .build();
            
            DecodedJWT jwt = verifier.verify(token);
            if(jwt.getClaim("sst").asInt() != 1) {
              return false;
            }
            List<String> scopes = jwt.getClaim("scp").asList();
            return scopes.contains(requiredScope);
        } catch (Exception e) {
            return false;
        }
    }
}
```

</Tab>

<Tab value="c#">

You can use the [IdentityModel](https://github.com/IdentityModel/IdentityModel) library to verify the token.

```csharp
using System;
using System.Linq;
using Microsoft.IdentityModel.Tokens;
using System.IdentityModel.Tokens.Jwt;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json.Linq;

class ClientCredentialsTokenValidator 
{
    static async Task<bool> ValidateToken(string jwtStr)
    {
        string apiDomain = "<API_DOMAIN>";
        string apiBasePath = "<API_BASE_PATH>";
        string audience = "<AUDIENCE>";
        string requiredScope = "<REQUIRED_SCOPE>";

        HttpClient client = new HttpClient();
        var response = await client.GetStringAsync($"<API_DOMAIN>/<API_BASE_PATH>/jwt/jwks.json");
        var jwks = new JsonWebKeySet(response);

        var tokenHandler = new JwtSecurityTokenHandler();
        var validationParameters = new TokenValidationParameters
        {
            ValidAudience = audience,
            IssuerSigningKeys = jwks.Keys
        };

        try
        {
            SecurityToken validatedToken;
            var principal = tokenHandler.ValidateToken(jwtStr, validationParameters, out validatedToken);
            var claims = principal.Claims.ToDictionary(c => c.Type, c => c.Value);

            if (!claims.ContainsKey("stt") || claims["stt"] != "1")
            {
                return false;
            }

            var scopes = claims["scp"].Split(" ");
            if (!scopes.Contains(requiredScope))
            {
                return false;
            }

            return true;
        }
        catch (Exception)
        {
            return false;
        }
    }
}
```

</Tab>

</Tabs>

:::info Custom Example

If the **Task Service** uses the previously generated token to create a calendar event, the **Calendar Service** needs to check the following:
- Set the `stt` claim to `1`
- The `scp` claim contains `event.create`
- Set the `aud` claim to `event`

:::

#### Handle both SuperTokens session tokens and OAuth2 access tokens

If you are using your **Authorization Service** also as a **Resource Server**, account for this in the way you verify the sessions.

This is necessary because two types of tokens are in use:
- **SuperTokens Session Access Token**: Used during the login/logout flows. 
- **OAuth2 Access Token**: Used to access protected resources and perform actions that need authorization.

Hence, a way to distinguish between these two and prevent errors is necessary.

<Tabs>

<Tab value="nodejs">

```tsx

async function verifySession(req: Request, res: Response, next: NextFunction) {
  let session = undefined;
  try {
    session = await Session.getSession(req, res, { sessionRequired: false });
  } catch (err) {
    if (
      !Session.Error.isErrorFromSuperTokens(err) ||
      err.type !== Session.Error.TRY_REFRESH_TOKEN
    ) {
      return next(err);
    }
  }

  // In this case we are dealing with a SuperTokens Session that has been validated
  if (session !== undefined) {
    return next();
  }

  // The OAuth2 Access Token needs to be manually extracted and validated
  let jwt: string | undefined = undefined;
  if (req.headers["authorization"]) {
    jwt = req.headers["authorization"].split("Bearer ")[1];
  }
  if (jwt === undefined) {
    return next(new Error("No JWT found in the request"));
  }

  try {
    await validateToken(jwt);
    return next();
  } catch (err) {
    return next(err);
  }
}

const JWKS = jose.createRemoteJWKSet(
  new URL("<API_DOMAIN><API_BASE_PATH>jwt/jwks.json"),
);

// This is a basic example on how to validate an OAuth2 Token
// Use the previous example to extend it
async function validateToken(jwt: string) {
  const { payload } = await jose.jwtVerify(jwt, JWKS, {
    requiredClaims: ["stt", "scp", "sub"],
  });

  if (payload.stt !== 1) throw new Error("Invalid token");

  // If the Authorizaton Server will handle different types of Authorization Flows
  // You can differentiate between the different types of tokens by checking the `sessionHandle` claim
  const sessionHandle = payload['sessionHandle'] as string | undefined;
  if(sessionHandle === undefined) {
    // We are dealing with a Client Credentials Token
    // You can perform microservice authentication checks here 
  } else {
    // Here we are validating tokens that have been generated in the Authorization Code Flow
  }
}

// You can then use the function as a middleware for a protected route
const app = express();
app.get("/protected", verifySession, async (req, res) => {
    // Custom logic 
});
```

</Tab>

<Tab value="python">

```python
from supertokens_python.recipe.session.syncio import get_session
from supertokens_python.recipe.session.exceptions import SuperTokensSessionError, TryRefreshTokenError 
from fastapi.requests import Request
from typing import List, Optional 
   return True

def validate_token(token: str, required_scope: str) -> bool:
  api_domain = "<YOUR_API_DOMAIN>"
  api_base_path = "/auth"
  client_id = "<CLIENT_ID>"

  jwks_url = f"{api_domain}{api_base_path}jwt/jwks.json"
  jwks_client = PyJWKClient(jwks_url)

  try:
      signing_key = jwks_client.get_signing_key_from_jwt(token)
      decoded = jwt.decode(
          token,
          signing_key.key,
          algorithms=['RS256'],
          options={"require": ["stt", "client_id", "scp"]}
      )

      stt: Optional[int] = decoded.get('stt')
      if stt != 1:
          return False

      token_client_id: Optional[str] = decoded.get('client_id', None)
      if client_id != token_client_id:
          return False

      scopes: List[str] = decoded.get('scp', [])
      if required_scope not in scopes:
          return False

      return True
  except Exception: 
      return False
  #

```

</Tab>

<Tab value="go">

:::caution

At the moment, there is no support for creating OAuth2 providers in the Go SDK.

:::

</Tab>

</Tabs>

# Authentication - Machine to Machine -  Legacy flow
Source: https://supertokens.com/docs/authentication/m2m/legacy-flow

## Overview

This custom flow makes use of the **SuperTokens Core** without adhering to the **OAuth2** standard.
It involves creating private access tokens and passing them to the microservices.

The authentication sequence works in the following way:

<Steps>
  ## Microservice `M1` requests a JWT (JSON Web Token) from the **SuperTokens Core**
  ## Microservice `M1` sends the JWT to `M2`
  ## Microservice `M2` verifies the JWT and completes the action if the JWT is valid
</Steps>

<img src="/img/microservice_auth/architecture.png" alt="Microservice auth flow diagram" />

The first step is to create a JWT from the microservice that sends the request (refer to this microservice as `M1`).
Other microservices verify this JWT when `M1` sends them a request.
Since this JWT remains static per microservice, the best time to create this is on process starts - that is when `M1` starts.

The JWT can contain any information you like. At a minimum, it needs to contain information proving that it is a microservice allowed to query other microservices in your infrastructure.
This is necessary since you may issue a JWT to an end user as well, and they should not be able to query any microservice directly.
Add the following claim in the JWT to "mark" the JWT as one meant for microservice auth only:
```json
{..., "source": "microservice", ...}
```
In the receiving microservice (`M2`), verify the JWT and check that this claim is present before serving the request.

### Security considerations

#### Who can query the microservices?
Anyone or any service that has direct access to the SuperTokens core can produce a valid JWT and query your microservices.
If the core is open to the internet, you *must* add an API key to protect it.
Even though end users may receive a JWT for their session (that the core signs), they cannot query a microservice directly. Their JWT *should* not have the `source: "microservice"` claim in it.

#### What happens if someone compromises the core's API key?

Then the attacker can issue their own JWTs to be able to query your microservices. To limit this protection, you may want to add firewall rules to allow access to the core only from services on your backend.
You can also provide multiple API keys to the core and give a unique key to each microservice in your infrastructure. This way, it would be easier to track where a leak came from.

#### What happens if someone compromises the JWT signing key?

In this case, the attacker could fabricate their own JWT to be able to query your microservices.
To limit this risk, a JWT signing key rotation methodology is in place. Until then, you can limit the reachability of your microservices based on the request's IP address.

#### How to limit which microservice can query another one?

If an organisation has multiple teams and microservices, it is common to limit which other services a given microservice can query.
For example, if there exists `M1`, `M2` and `M3` microservices, there may be a situation in which `M1` should only be able to query `M2` and not `M3`.
With one SuperTokens core deployment, having this type of restriction is impossible. All the microservices create and verify their JWTs using the same public/private keys. Therefore `M3` receives a request, it has no way of reliably knowing if the request is from `M1` or `M2` (assuming that IP-based access control is not implemented).
This type of restriction can occur by deploying multiple cores connected to their own databases. In this example, a dedicated SuperTokens core can handle `M3`'s auth, such that only `M3` uses that to verify the incoming JWTs. Then, only other services that have access to that core can create JWTs that `M3` accepts. If `M1` doesn't have access to `M3`'s core's API key, it can be assured that successful requests to `M3` are not from `M1`.

## Steps

### 1. Create a JWT

<Question question="Are you using the SuperTokens SDK?" defaultAnswer="Yes">

<Answer title="Yes">

First, initialize the `JWT` recipe in the `supertokens.init` function call:

<Tabs>

<Tab value="nodejs">

```tsx

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...", // location of the core
        apiKey: "..." // provide the core's API key if configured
    },
    recipeList: [
        // highlight-next-line
        jwt.init()
    ]
})
```

</Tab>
<Tab value="go">

```go

async function createJWT(payload: any) {
    let jwtResponse = await jwt.createJWT({
        ...payload,
        source: "microservice"
    });
    if (jwtResponse.status === "OK") {
        // Send JWT as Authorization header to M2
        return jwtResponse.jwt;
    }
    throw new Error("Unable to create JWT. Should never come here.")
}
```

</Tab>
<Tab value="go">

```go
--data-raw '{
  "payload": {
    "source": "microservice",
    ...
  },
  "useStaticSigningKey": true,
  "algorithm": "RS256",
  "jwksDomain": "${apiDomain}",
  "validity": ${validityInSeconds}
}'
```
- The value of `${connectionURI}` is the core's location
- `${APIKey}` is the API key to query the core. This is only needed if an API key exists on the core.
- The value of `${apiDomain}` is the domain on which the JWKs URLs are available from
- `${validityInSeconds}` is the lifetime of the JWT

An example response is as follows:
```json
{
    "status": "OK",
    "jwt": "eyJraWQiOiI0YTE...rCFPcIRgzu_bChIIpFdA"
}

```

</Answer>

</Question>

### 2. Store the JWT

Once you create the JWT, you can store it in a (globally accessible) variable and access it when you want to talk to a microservice.
Add the JWT as an `Authorization: Bearer` token like this:

```bash
curl --location --request POST 'https://microservice_location/path' \
--header 'Authorization: Bearer eyJraWQiOiI0YTE...rCFPcIRgzu_bChIIpFdA' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "request": "payload"
}'
```

### 3. Verify JWTs



When a target microservice receives a JWT, it must first verify it before proceeding to serve the request. The process involves two steps:
- A standard verification of the JWT
- Checking the JWT claim to make sure that another microservice has queried it.

#### Using JWKS endpoint

<Tabs disableOtherFrameworks={true}>
<Tab value="nodejs">

##### Get JWKS endpoint

The JWKS endpoint is `<API_DOMAIN>/<API_BASE_PATH>/jwt/jwks.json`. Here the `apiDomain` and `apiBasePath` are values pointing to the server in which you have initialized SuperTokens using the backend SDK.

##### Verify the JWT

Some libraries let you provide a JWKS endpoint to verify a JWT. For example for NodeJS you can use `jsonwebtoken` and `jwks-rsa` together to achieve this.

```ts

var client = jwksClient({
  jwksUri: '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
});

function getKey(header: JwtHeader, callback: SigningKeyCallback) {
  client.getSigningKey(header.kid, function (err, key) {
    var signingKey = key!.getPublicKey();
    callback(err, signingKey);
  });
}

let jwt = "...";
JsonWebToken.verify(jwt, getKey, {}, function (err, decoded) {
  let decodedJWT = decoded;
  // Use JWT
});
```

</Tab>
<Tab value="python">

Refer to this [GitHub gist](https://gist.github.com/rishabhpoddar/ea31502923ec9a53136371f2b6317ffa) for a code reference of how use `PyJWK` to do JWT verification. The gist contains two files:
- `jwt_verification.py` (which you can copy/paste into your application). You have to modify the `JWKS_URI` in this file to point to your SuperTokens core instance (replacing the `try.supertokens.com` part of the URL). This file is for `sync` python apps, and you can modify it to work with `async` apps as well.
  - This file essentially exposes a function called `verify_jwt` which takes an input JWT string.
  - This function takes care of caching public keys in memory + auto `refetching` if the public keys have changed (which happens automatically every 24 hours with SuperTokens). This does not cause any user logouts, and is just a security feature.
- `views.py`: This is an example `GET` API which extracts the JWT token from the authorization header in the request and calls the `verify_jwt` function from the other file.

</Tab>
<Tab value="go">

Refer to this [GitHub gist](https://gist.github.com/rishabhpoddar/8c26ed237add1a5b86481e72032abf8d) for a code reference of how use the Golang `jwt` lib to do session verification. The gist contains two files:
- `verifyToken.go` (which you can copy/paste into your application). You have to modify the `coreUrl` in this file to point to your SuperTokens core instance (replacing the `try.supertokens.com` part of the URL).
  - This file essentially exposes a function called `GetJWKS` which returns a reference to the JWKS public keys useful for JWT verification.
  - This function takes care of caching public keys in memory + auto `refetching` if the public keys have changed (which happens automatically every 24 hours with SuperTokens). This does not cause any user logouts, and is just a security feature.
- `main.go`: This is an example of how to verify a JWT using the golang JWT verification lib along with a helper function to get the JWKs keys.

</Tab>
</Tabs>

#### Using public key string

<Tabs disableOtherFrameworks={true}>
<Tab value="nodejs">

Some JWT verification libraries require you to provide the JWT secret / public key for verification. You can obtain the JWT secret from SuperTokens in the following way:

- First, query the `JWKS.json` endpoint:
  ```bash
  curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'

  {
    "keys": [
      {
        "kty": "RSA",
        "kid": "s-2de612a5-a5ba-413e-9216-4c43e2e78c86",
        "n": "AMZruthvYz7Ft-Dp0BC_SEEJaWK91s_YA-RR81iLJ6BTT6gJp0CcV4DfBynFU_59dRGOZyVQpAW6Drnc_6LyZpVWHROzqt-Fjh8TAqodayhPJVuZt25eQiYrqcaK_dnuHrm8qwUq-hko6q1o9NIIZWNfUBEVWmNhyAJFk5bi3pLwtKPYrUQzVLcTdDUe4SIltvvfpYHbVFnYtxkBVmqO68j7sI8ktmTXM_heals-W6WmozabDkC9_ITCeRat2f7A2l0t4QzO0ZCzZcJfhusF4X1niKgY6yYXpbX6is4HCfhYfdabcE52xYMNl-gw9XDjsIxfBMUDvOFRHWlx0rU8c=",
        "e": "AQAB",
        "alg": "RS256",
        "use": "sig"
      },
      {
        "kty": "RSA",
        "kid": "d-230...802340",
        "n": "AMZruthvYz7...lx0rU8c=",
        "e": "...",
        "alg": "RS256",
        "use": "sig"
      }
    ]
  }
  ```

  :::important
  The above shows an example output which returns two keys. There could be more keys returned based on the configured key rotation setting in the core. If you notice, each key's `kid` starts with a `s-..` or a `d-..`. The `s-..` key is a static key that never changes, whereas `d-...` keys are dynamic keys that keep changing. If you are `hardcoding` public keys somewhere, you always want to pick the `s-..` key.
  :::

- Next, run the NodeJS script below to convert the above output to a `PEM` file format.
  ```tsx

  // This JWK is copied from the result of the above SuperTokens core request
  let jwk = {
    "kty": "RSA",
    "kid": "s-2de612a5-a5ba-413e-9216-4c43e2e78c86",
    "n": "AMZruthvYz7Ft-Dp0BC_SEEJaWK91s_YA-RR81iLJ6BTT6gJp0CcV4DfBynFU_59dRGOZyVQpAW6Drnc_6LyZpVWHROzqt-Fjh8TAqodayhPJVuZt25eQiYrqcaK_dnuHrm8qwUq-hko6q1o9NIIZWNfUBEVWmNhyAJFk5bi3pLwtKPYrUQzVLcTdDUe4SIltvvfpYHbVFnYtxkBVmqO68j7sI8ktmTXM_heals-W6WmozabDkC9_ITCeRat2f7A2l0t4QzO0ZCzZcJfhusF4X1niKgY6yYXpbX6is4HCfhYfdabcE52xYMNl-gw9XDjsIxfBMUDvOFRHWlx0rU8c=",
    "e": "AQAB",
    "alg": "RS256",
    "use": "sig"
  };

  // @ts-ignore
  let certString = jwkToPem(jwk);
  ```

  The above snippet would generate the following certificate string:

  ```text
  -----BEGIN PUBLIC KEY-----
  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxmu62G9jPsW34OnQEL9I
  QQlpYr3Wz9gD5FHzWIsnoFNPqAmnQJxXgN8HKcVT/n11EY5nJVCkBboOudz/ovJm
  ... (truncated for display)
  XhfWeIqBjrJheltfqKzgcJ+Fh91ptwTnbFgw2X6DD1cOOwjF8ExQO84VEdaXHStT
  xwIDAQAB
  -----END PUBLIC KEY-----
  ```

- You can use the generated PEM string in your code like shown below:
  ```ts

  // Truncated for display
  let certificate = "-----BEGIN PUBLIC KEY-----\nnMIIBIjANBgkqhki...\n-----END PUBLIC KEY-----";
  let jwt = "..."; // fetch the JWT from sAccessToken cookie or Authorization Bearer header
  JsonWebToken.verify(jwt, certificate, function (err, decoded) {
      let decodedJWT = decoded;
      // Use JWT
  });
  ```

</Tab>
<Tab value="python">

:::caution
Not applicable. Please use method 1 instead.
:::

</Tab>
<Tab value="go">

:::caution
Not applicable. Please use method 1 instead.
:::

</Tab>
</Tabs>

#### Claim verification

The second step is to get the JWT payload and check that it has the `"source": "microservice"` claim:

<Tabs disableOtherFrameworks={true}>
<Tab value="nodejs">

```tsx

var client = jwksClient({
  jwksUri: '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
});

function getKey(header: JwtHeader, callback: SigningKeyCallback) {
  client.getSigningKey(header.kid, function (err, key) {
    var signingKey = key!.getPublicKey();
    callback(err, signingKey);
  });
}

let jwt = "...";
JsonWebToken.verify(jwt, getKey, {}, function (err, decoded) {
  // highlight-start
  let decodedJWT = decoded;
  if (decodedJWT === undefined || typeof decodedJWT === "string" || decodedJWT.source === undefined || decodedJWT.source !== "microservice") {
    // return a 401 unauthorised error
  } else {
    // handle API request...
  }
  // highlight-end
});
```

</Tab>
<Tab value="python">

Referring once again to this [GitHub gist](https://gist.github.com/rishabhpoddar/ea31502923ec9a53136371f2b6317ffa), in `views.py`, between lines 20 and 28, the value of a certain claim in the decoded JWT payload undergoes a check. You can do something similar and check for the `source` claim whose value must be `microservice`. If it is, then all's good, else you can return a 401.

</Tab>
<Tab value="go">

Referring once again to this [GitHub gist](https://gist.github.com/rishabhpoddar/8c26ed237add1a5b86481e72032abf8d), in `main.go`, between lines 32 and 44, the value of a certain claim in the decoded JWT payload undergoes a check. You can do something similar and check for the `source` claim whose value must be `microservice`. If it is, then all's good, else you can return a 401.

</Tab>
</Tabs>

#### M2M and frontend session verification for the same API
You may have a setup wherein the same API receives calls from the frontend as well as from other microservices. The frontend session works differently than m2m sessions, therefore both forms of token inputs must be accounted for.

The approach here would be to first attempt frontend session verification, and if that fails, then attempt m2m JWT verification (using the above method). If both fail, then send back a `401` response.

The [`getSession` function](https://supertokens.com/docs/session/common-customizations/sessions/session-verification-in-api/get-session) serves for frontend session verification.

<Tabs disableOtherFrameworks={true}>
<Tab value="nodejs">

```tsx

let app = express();

var client = jwksClient({
  jwksUri: '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
});

function getKey(header: JwtHeader, callback: SigningKeyCallback) {
  client.getSigningKey(header.kid, function (err, key) {
    var signingKey = key!.getPublicKey();
    callback(err, signingKey);
  });
}

app.post("/like-comment", async (req, res, next) => {
  // highlight-start
    try {
        let session = await Session.getSession(req, res, { sessionRequired: false })

        if (session !== undefined) {
            // API call from the frontend and session verification is successful..
            let userId = session.getUserId();
        } else {
            // maybe this API is called from a microservice, so we attempt JWT verification as
            // shown above.
            let jwt = req.headers["authorization"];
            jwt = jwt === undefined ? undefined : jwt.split('Bearer ')[1];
            if (jwt === undefined) {
                // return a 401 unauthorised error...
            } else {
                JsonWebToken.verify(jwt, getKey, {}, function (err, decoded) {
                  let decodedJWT = decoded;
                  // microservices auth is successful..
                });
            }
        }
    } catch (err) {
        next(err);
    }
  // highlight-end
});
```

- Notice that the `sessionRequired: false` option appears when calling `getSession`. This is because in case the input tokens are from another microservice, then instead of throwing an unauthorised error, the `getSession` function returns `undefined`. It's important to note that if the session does exist, but the access token has expired, the `getSession` function throws a try refresh token error, sending a 401 to the frontend. This triggers a session refresh flow as expected.
- If the `getSession` function returns `undefined`, it means that the session is not from the frontend and a microservice auth verification can occur using the JWT verification method shown previously in this page.
- If that fails too, send back a `401` response.

</Tab>
<Tab value="python">

```python
from typing import Optional, cast

from django.http import HttpRequest

from supertokens_python.recipe.session.asyncio import get_session

async def like_comment(request: HttpRequest):
    session = await get_session(request, session_required=False)
    user_id = ""
    if session is not None:
        user_id = session.get_user_id()
    else:
        jwt: Optional[str] = cast(Optional[str], request.headers.get("Authorization")) # type: ignore
        if jwt is None:
            # return a 401 unauthorised error...
            pass
        else:
            jwt = jwt.split("Bearer ")[1]
            # JWT verification (see previous step)
            pass

    print(user_id)  # TODO
```

- Notice that the `sessionRequired: false` option appears when calling `getSession`. This is because in case the input tokens are from another microservice, then instead of throwing an unauthorised error, the `getSession` function returns `None`. It's important to note that if the session does exist, but the access token has expired, the `getSession` function throws a try refresh token error, sending a 401 to the frontend. This triggers a session refresh flow as expected.
- If the `getSession` function returns `None`, it means that the session is not from the frontend and a microservice auth verification can occur using the JWT verification method shown previously in this page.
- If that fails too, send back a `401` response.

</Tab>
<Tab value="go">

```go
- If the `getSession` function returns `nil`, it means that the session is not from the frontend and a microservice auth verification can occur using the JWT verification method shown previously in this page.
- If that fails too, send back a `401` response.

</Tab>
</Tabs>

# Authentication - Passkeys -  Important concepts
Source: https://supertokens.com/docs/authentication/passkeys/important-concepts

## Overview

Use this page to get a high-level overview of the key concepts involved in the WebAuthn documentation.
The reference goes over each term and describes how the **WebAuthn** flows work within **SuperTokens**.

## Terminology

### WebAuthn

Web Authentication, **WebAuthn**, is an open web standard that enables secure, passwordless authentication for web applications.
**WebAuthn** allows users to log in using biometrics, security keys, or device-based credentials, replacing traditional username and password combinations.
Under the hood, the standard relies on [asymmetric (public-key) cryptography](https://en.wikipedia.org/wiki/Public-key_cryptography) to confirm the identity of a user.

For a more detailed explanation of WebAuthn, you can refer to the [actual specification](https://www.w3.org/TR/webauthn/).

### Passkeys

A **passkey** is a type of credential that implements the WebAuthn standard.
It uses cryptographic keys that users can share across multiple devices.
This makes it convenient and recoverable in case of device loss.

Aside from the ease of use, passkeys are integrated into operating systems and browsers, and, support a wide range of devices.

### Additional terms

<Accordion px="4">

## Credentials

The technical term for the cryptographic key pairs used in **WebAuthn**.
They represent the raw cryptographic material and, unlike **passkeys**, are device-specific and not synced.
Additionally, sometimes, multiple credentials can be part of a single passkey.

:::info Note
This documentation uses **passkey** and **credential** interchangeably, even though subtle technical differences exist.
:::

## Authenticator

A device or software that implements the **WebAuthn** authentication. This can be:
  - **Platform Authenticator**: Built-in biometric sensors like TouchID, FaceID, or Windows Hello.
  - **Roaming Authenticator**: External security devices like YubiKeys or Google Titan keys.

## Registration

The process where a user registers their **authenticator** with your application. During this process:
  1. The server generates a challenge for the **authenticator** to sign.
  2. The **authenticator** creates a new credential.
  3. The system saves the public key and any additional metadata for future authentication.

## Authentication

The process where a user proves their identity, using their **authenticator**, by responding to a **server challenge**.
Using their private key, they sign the **challenge** and then send the result to the server.
The server then verifies the signature with the stored public key.

<br />

## Attestation

**Attestation** represents information about the **authenticator device** itself.
You can use it to verify the authenticity and the security level of the **authenticator**.

<br />

## User verification

**User verification** is the method used to verify the user's presence. This can be:
  - Biometric verification (fingerprint, face scan).
  - `PIN` entry.
  - Physical button press on a security key.

</Accordion>

## Authentication flows

This section explains how each component communicates during different authentication flows.

### Login

<Steps>

## The frontend SDK requests registration options from the backend.
The options are then returned based on the response from the **SuperTokens** core service.
## The **authenticator** uses the response to sign a challenge with your **passkey**.
## The result of the **authenticator** operation gets validated by the **SuperTokens** core service.
## The authentication UI updates, based on the result of the validation process.

</Steps>

![Sign in form UI for passkeys login](/img/webauthn-signin.png)

### Sign up

<Steps>

## The user enters their email address in frontend authentication UI 
## The frontend SDK uses the email to request **registration** options from the backend.
The options are then returned based on the response from the **SuperTokens** core service.
## The **authenticator** uses the response to sign a **challenge** with your **passkey**.
## The result of the **authenticator** operation gets validated on by the **SuperTokens** core service.
## The authentication UI updates, based on the result of the validation process.

</Steps>

![Passkeys sign up flow](/img/webauthn-signup.png)

### Account recovery

Account recovery should use an email.
In it, the user receives a link that directs them to a page where they can register a new credential.

<Steps>

## The frontend initiates the recovery flow by communicating with the backend SDK
## The backend checks if the email exists and then sends a recovery email.
The email includes a security token obtained from the **SuperTokens** core.
## When the user accesses the recovery link, they get directed to the frontend application. 
The security token gets validated by the backend SDK.
If successful, the SDK begins the process of registering a new credential.
From here, the flow matches the one described in the previous sections.

</Steps>

![Sign in form UI for passkeys login](/img/webauthn-recover-account.png)

# Authentication - Passkeys -  Quickstart
Source: https://supertokens.com/docs/authentication/passkeys/initial-setup

## Overview

This page shows you how to add the **Passkeys** authentication method to your project.
The tutorial creates a login flow, rendered by either the **Prebuilt UI** components or by your own **Custom UI**.

## Before you start

These instructions assume that you already have gone through the main [quickstart guide](/docs/quickstart/introduction).
If you have skipped that page please follow the tutorial and return here once you're done.

:::info SDK Support
WebAuthn (Passkeys) authentication is available in the **Node.js SDK** and **Python SDK**.
:::

## Steps 

### 1. Initialize the frontend SDK



<PrebuiltUIInstructions>

<Tabs>
    <Tab value="reactjs">

#### 1.1 Add the `WebAuthn` recipe in your main configuration file.

```tsx

// highlight-next-line

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        websiteDomain: "...",
        appName: "...",
    },
    recipeList: [
        // highlight-start
        WebAuthn.init(),
        // highlight-end
        Session.init()
    ]
});
```

#### 1.2 Include the pre-built UI components in your application.

In order for the **pre-built UI** to render inside your application, you have to specify which routes show the authentication components.
The **React SDK** uses [**React Router**](https://reactrouter.com/en/main) under the hood to achieve this.
Based on whether you already use this package or not in your project, there are two different ways of configuring the routes.

        <Question question="Do you use react-router-dom?" defaultAnswer="Yes">
            <Answer title="Yes">
```tsx

// highlight-next-line

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        {/*This renders the login UI on the <WEBSITE_BASE_PATH> route*/}
                        // highlight-next-line
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [WebauthnPreBuiltUI])}
                        {/*Your app routes*/}
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```

                :::important
If you are using `useRoutes`, `createBrowserRouter` or have routes defined in a different file, you need to adjust the code sample.
Please see [this issue](https://github.com/supertokens/supertokens-auth-react/issues/581#issuecomment-1246998493) for further details.
```tsx

function AppRoutes() {
  const authRoutes = getSuperTokensRoutesForReactRouterDom(
    reactRouterDom,
    [/* Add your UI recipes here e.g. EmailPasswordPrebuiltUI, PasswordlessPrebuiltUI, ThirdPartyPrebuiltUI */]
  );

  const routes = useRoutes([
    ...authRoutes.map(route => route.props),
    // Include the rest of your app routes 
  ]);

  return routes;
}

function App() {
  return (
    <SuperTokensWrapper>
      <BrowserRouter>
          <AppRoutes />
      </BrowserRouter>
    </SuperTokensWrapper>
  );
}
```
:::
            </Answer>
            <Answer title="No">

```tsx
// highlight-next-line

class App extends React.Component {
    render() {
        // highlight-start
        if (canHandleRoute([WebauthnPreBuiltUI])) {
            // This renders the login UI on the <WEBSITE_BASE_PATH> route
            return getRoutingComponent([WebauthnPreBuiltUI])
        }

        // highlight-end

        return (
            <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
        );
    }
}
```
            </Answer>
        </Question>
    </Tab>
  <Tab value="angular">

Add the `WebAuthn` recipe in your `AuthComponent`.

    ```tsx title="/app/auth/auth.component.ts"

    @Component({
        selector: "app-auth",
        template: '<div id="supertokensui"></div>',
    })
    export class AuthComponent implements OnDestroy, AfterViewInit {

        constructor(
            private renderer: Renderer2,
            @Inject(DOCUMENT) private document: Document
        ) { }

        ngAfterViewInit() {
            this.loadScript('^{prebuiltUIVersion}');
        }

        ngOnDestroy() {
            // Remove the script when the component is destroyed
            const script = this.document.getElementById('supertokens-script');
            if (script) {
                script.remove();
            }
        }

        private loadScript(src: string) {
            const script = this.renderer.createElement('script');
            script.type = 'text/javascript';
            script.src = src;
            script.id = 'supertokens-script';
            script.onload = () => {
                supertokensUIInit({
                    appInfo: {
                        appName: "<APP_NAME>",
                        apiDomain: "<API_DOMAIN>",
                        websiteDomain: "<WEBSITE_DOMAIN>",
                        apiBasePath: "<API_BASE_PATH>",
                        websiteBasePath: "<WEBSITE_BASE_PATH>",
                    },
                    recipeList: [
// highlight-start
                        supertokensUIWebAuthn.init(),
// highlight-end
                        supertokensUISession.init(),
                    ],
                });
            }
            this.renderer.appendChild(this.document.body, script);
        }
    }
    ```

  </Tab>
  <Tab value="vue">

Add the `WebAuthn` recipe in your `AuthView` file.

    ```tsx
    <script lang="ts">
        export default defineComponent({
            setup() {
                const loadScript = (src: string) => {
                    const script = document.createElement('script');
                    script.type = 'text/javascript';
                    script.src = src;
                    script.id = 'supertokens-script';
                    script.onload = () => {
                        supertokensUIInit({
                            appInfo: {
                                appName: "<APP_NAME>",
                                apiDomain: "<API_DOMAIN>",
                                websiteDomain: "<WEBSITE_DOMAIN>",
                                apiBasePath: "<API_BASE_PATH>",
                                websiteBasePath: "<WEBSITE_BASE_PATH>",
                            },
                            recipeList: [
// highlight-start
                                supertokensUIWebAuthn.init(),
// highlight-end
                                supertokensUISession.init(),
                            ],
                        });
                    };
                    document.body.appendChild(script);
                };

                onMounted(() => {
                    loadScript('^{prebuiltUIVersion}');
                });

                onUnmounted(() => {
                    const script = document.getElementById('supertokens-script');
                    if (script) {
                        script.remove();
                    }
                });
            },
        });
    </script>

    <template>
        <div id="supertokensui" />
    </template>
    ```

  </Tab>

    
</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

Call the SDK init function at the start of your application.
The invocation includes the [main configuration details](/docs/references/frontend-sdks/reference#sdk-configuration), as well as the **recipes** that you use in your setup.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        WebAuthn.init(),
    ],
});
```

</Tab>

<Tab value="scripts">

<Tabs.Section>

First, you need to add the recipe script tag.

```html
<script src="^{webJsVersions.webauthn}"></script>
```

You can initialize the SDK.

```tsx

supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init(),
        supertokensWebAuthn.init(),
    ],
});
```

</Tabs.Section>

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

SuperTokens.init({
    apiDomain: "<API_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
});
```

</Tab>

<Tab value="android">

```kotlin

void main() {
    SuperTokens.init(
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
    );
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

### 2. Add the passkeys UI 

#### 2.1 Add the sign up form

<Tabs>

<Tab value="web">

Create a form in which the user can input their email address.
When the user submits the form, call the `registerCredentialWithSignUp` method like in the next code snippet.

Under the hood, the method communicates with the backend SDK to fetch the registration options.
Once the backend responds, it uses the browser's APIs to begin the registration process.
For a more detailed overview of the sign up flow check the [Important Concepts page](/docs/authentication/passkeys/important-concepts#signup).

```ts

async function signUp(email: string) {
    try {
        let response = await registerCredentialWithSignUp({
            email
        });

        if (
            response.status === "SIGN_UP_NOT_ALLOWED" ||
            response.status === "INVALID_AUTHENTICATOR_ERROR"
        ) {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else if (
            response.status === "INVALID_EMAIL_ERROR" ||
            response.status === "EMAIL_ALREADY_EXISTS_ERROR" 
        ) {
            window.alert("Invalid email");
        } else if (
            response.status === "INVALID_CREDENTIALS_ERROR" ||
            response.status === "OPTIONS_NOT_FOUND_ERROR" ||
            response.status === "INVALID_OPTIONS_ERROR" ||
            response.status === "INVALID_AUTHENTICATOR_ERROR" ||
            response.status === "EMAIL_ALREADY_EXISTS_ERROR" ||
            response.status === "AUTHENTICATOR_ALREADY_REGISTERED" ||
            response.status === "FAILED_TO_REGISTER_USER" ||
            response.status === "WEBAUTHN_NOT_SUPPORTED"
        ) {
            // These errors represent various issues with the authenticator, credential or the flow itself.
            // These should be handled individually by you. 
            // The user should be informed that they should retry the sign up process or get in touch with you.
            window.alert("Please try again");
        } else {
            // User signed up successfully.
            window.alert("You have been signed up successfully");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you,
            // or if the input email / phone number is not valid.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>

<Tab value="mobile">

<Steps>

   ## Get the email address from the user
     Add a form where the user can input their email address.

   ## Fetch the registration options from the backend SDK
    
    When the user submits the form, call the `register options` API.
    Save the response to use it in the next step.

    ```bash
    curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/webauthn/register/options' \
    --header 'Content-Type: application/json; charset=utf-8' \
    --data-raw '{
      "email": "johndoe@gmail.com",
      "displayName": "John Doe"
    }'
    ```

    :::caution
      The returned result matches the format required by the **browser's WebAuthn API**.
      You will have to map the properties to the correct format based on the requirements of your platform.
    :::

   ## Register a new credential authenticator API
      
    Use the received options generate a new credential.
    The implementation will vary based on the platform you are using.
    - **React Native**: You can use the [`react-native-passkey`](https://github.com/f-23/react-native-passkey) library.
    - **iOS**: Use the [`Authentication Services`](https://developer.apple.com/documentation/authenticationservices) framework.
    - **Android**: Use the [`Android Credential Manager API`](https://developer.android.com/identity/sign-in/credential-manager).
    - **Flutter**: Use [platform channels](https://docs.flutter.dev/platform-integration/platform-channels#architecture) to access the native APIs.

   ## Call the sign up API
     
    Using the newly generate credential, call the sign up API to save the new authentication method.

    ```bash
    curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/webauthn/signup' \
    --header 'Content-Type: application/json; charset=utf-8' \
    --data-raw '{
      "webauthnGeneratedOptionsId": "opt_123...",
      "credential": {
        "id": "credential_id",
        "rawId": "raw_credential_id",
        "response": {
          "clientDataJSON": "base64_client_data_json",
          "attestationObject": "base64_attestation_object"
        },
        "type": "public-key"
      },
      "shouldTryLinkingWithSessionUser": true
    }'
    ```

</Steps>

</Tab>

</Tabs>

#### 2.2 Add the login form

<Tabs>

<Tab value="web">

Add a button that can trigger the sign in flow.
This is all that you need in terms of UI.
When the user clicks it, call the `authenticateCredentialWithSignIn` method to handle the whole process.

The function uses the backend registration options to trigger the challenge signing action through the browser API.
Then, it forwards the result to the backend for validation.
For a more detailed overview of the login flow check the [Important Concepts page](/docs/authentication/passkeys/important-concepts#login).

```ts

async function signIn(email: string) {
    try {
        let response = await authenticateCredentialWithSignIn();

        if (
            response.status === "SIGN_IN_NOT_ALLOWED"
        ) {
            // the reason string is a user friendly message
            // about what went wrong. It can also contain a support code which users
            // can tell you so you know why their sign in / up was not allowed.
            window.alert(response.reason)
        } else if (response.status === "WEBAUTHN_NOT_SUPPORTED") {
            // the user's browser does not support the WebAuthn standard
            window.alert("Login method not supported");
        } else if (
            response.status === "INVALID_CREDENTIALS_ERROR" || 
            response.status === "FAILED_TO_AUTHENTICATE_USER"
        ) {
            // These errors represent various issues with the authenticator, credential or the flow itself.
            // These should be handled individually by you. 
            // The user should be informed that they should retry the sign in process or get in touch with you.
            window.alert("Please try again");
        } else {
            // User signed in successfully.
            window.alert("You have been signed in successfully");
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you,
            // or if the input email / phone number is not valid.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```
</Tab>

<Tab value="mobile">

<Steps>

  ## Add a button that can trigger the sign in flow

  ## Get the sign in options from the backend SDK
    When the user taps the sign in button, call the backend API to fetch the sign in options.

    ```bash
    curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/webauthn/signin/options' \
    --header 'Content-Type: application/json; charset=utf-8' 
    ```

  ## Use the authenticator to sign the challenge

    With the received options, invoke the authenticator to sign the challenge.
    The implementation will vary based on the platform you are using.

  ## Call the sign in API

    Send the signed challenge to the backend for validation.

    ```bash
    curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/webauthn/signin' \
    --header 'Content-Type: application/json; charset=utf-8' \
    --data-raw '{
      "webauthnGeneratedOptionsId": "opt_123...",
      "credential": {
        "id": "credential_id",
        "rawId": "raw_credential_id",
        "response": {
          "clientDataJSON": "base64_client_data_json",
          "attestationObject": "base64_attestation_object"
        },
        "type": "public-key"
      },
      "shouldTryLinkingWithSessionUser": true
    }'
    ```

</Steps>

</Tab>

</Tabs>

</CustomUIInstructions>

<PrebuiltUIInstructions>

### 2. Initialize the backend SDK

</PrebuiltUIInstructions>

<CustomUIInstructions>

### 3. Initialize the backend SDK

</CustomUIInstructions>

Initialize the backend SDK and include the **WebAuthn** `recipe`.
The init call includes [configuration details](/docs/references/backend-sdks/reference#sdk-configuration) for your app.
It specifies how the backend connects to the **SuperTokens Core**, as well as the **Recipes** used in your setup.

The recipe exposes the required endpoints that get accessed by the frontend code, and communicates with the **SuperTokens Core** to complete the authentication flow.
You can [configure different aspects](/docs/authentication/passkeys/customization) of the recipe's behavior but, for the completion of this guide, use the default values.
After you confirm that the flow works as expected you can explore more advanced customisations options.

<Tabs>

<Tab value="nodejs">

```ts

supertokens.init({
    // Replace this with the framework you are using
    framework: "express",
    supertokens: {
        // We use try.supertokens for demo purposes.
        // At the end of the tutorial we will show you how to create
        // your own SuperTokens core instance and then update your config.
        connectionURI: "https://try.supertokens.io",
        // apiKey: <YOUR_API_KEY>
    },
    appInfo: {
        appName: "<YOUR_APP_NAME>",
        apiDomain: "<YOUR_API_DOMAIN>",
        websiteDomain: "<YOUR_WEBSITE_DOMAIN>",
        apiBasePath: "/auth",
        websiteBasePath: "/auth",
    },
    recipeList: [
        WebAuthN.init(),
        Session.init()
    ]
});
```
</Tab>

<Tab value="go">

:::caution

At the moment there is no support for using passkeys authentication in the Go SDK.

:::

</Tab>

<Tab value="python">

```python
from supertokens_python import InputAppInfo, SupertokensConfig, init
from supertokens_python.recipe import session, webauthn

init(
    app_info=InputAppInfo(
        app_name="<YOUR_APP_NAME>",
        api_domain="<YOUR_API_DOMAIN>",
        website_domain="<YOUR_WEBSITE_DOMAIN>",
        api_base_path="/auth",
        website_base_path="/auth"
    ),
    supertokens_config=SupertokensConfig(
        # We use try.supertokens for demo purposes.
        # At the end of the tutorial we will show you how to create
        # your own SuperTokens core instance and then update your config.
        connection_uri="https://try.supertokens.io",
        # api_key="<YOUR_API_KEY>"
    ),
    framework='flask',  # Replace this with the framework you are using
    recipe_list=[
        webauthn.init(),
        session.init()
    ]
)
```

</Tab>

</Tabs>

# Authentication - Passkeys -  Customization
Source: https://supertokens.com/docs/authentication/passkeys/customization

## Overview

Like the other **SuperTokens** authentication recipes, you can customize the `WebAuthn` flow through different configuration options and overrides.
The following page describes the options that you can change and the different scenarios enabled through customization.

---

## Backend recipe configuration

<Tabs>

<Tab value="nodejs">

```ts

supertokens.init({
    framework: "express",
    supertokens: {
        // https://try.supertokens.com is for demo purposes. Replace this with the address of your core instance (sign up on supertokens.com), or self host a core.
        connectionURI: "https://try.supertokens.com",
        // apiKey: <API_KEY(if configured)>,
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<YOUR_APP_NAME>",
        apiDomain: "<YOUR_API_DOMAIN>",
        websiteDomain: "<YOUR_WEBSITE_DOMAIN>",
        apiBasePath: "/auth",
        websiteBasePath: "/auth"
    },
    recipeList: [
        WebAuthn.init({
            getOrigin: () => {
                return "https://example.com";
            },
            getRelyingPartyId: () => {
                return "example.com";
            },
            getRelyingPartyName: () => {
                return "example";
            },
        }),
        Session.init() // initializes session features
    ]
});
```

The backend recipe accepts the following properties during initialization:

| Option | Description | Default |
|--------|-------------|---------|
| `getRelyingPartyId` | Sets the domain name associated with the WebAuthn credentials. This helps ensure that only your domain uses the credentials. | The `apiDomain` value that you have set in `appConfig` |
| `getRelyingPartyName` | Sets a human-readable name for your application. The name appears to users during the WebAuthn registration process. | The `appName` value that you have set in `appConfig` |
| `getOrigin` | Configures the origin URL that WebAuthn credentials bind to. This should match your application's domain and protocol. | Origin of the request |
| `emailDelivery` | Configures how the system builds and sends verification emails to users. Read the [email delivery page](/docs/platform-configuration/email-delivery) for more information. | Default email service |
| `validateEmailAddress` | Adds custom validation logic for email addresses. | Basic email format validation |

All the properties are optional.

</Tab>

<Tab value="go">

:::caution

At the moment there is no support for using passkeys authentication in the Go SDK.

:::

</Tab>

<Tab value="python">

```python
from typing import Optional

from supertokens_python import InputAppInfo, SupertokensConfig, init
from supertokens_python.framework import BaseRequest
from supertokens_python.recipe import session, webauthn
from supertokens_python.recipe.webauthn import WebauthnConfig
from supertokens_python.types.base import UserContext

async def get_origin(*, tenant_id: str, request: Optional[BaseRequest], user_context: UserContext):
    return "https://example.com"

async def get_relying_party_id(*, tenant_id: str, request: Optional[BaseRequest], user_context: UserContext):
    return "example.com"

async def get_relying_party_name(*, tenant_id: str, user_context: UserContext):
    return "example"

init(
    app_info=InputAppInfo(
        app_name="<YOUR_APP_NAME>",
        api_domain="<YOUR_API_DOMAIN>",
        website_domain="<YOUR_WEBSITE_DOMAIN>",
        api_base_path="/auth",
        website_base_path="/auth"
    ),
    supertokens_config=SupertokensConfig(
        # https://try.supertokens.com is for demo purposes. Replace this with the address of your core instance (sign up on supertokens.com), or self host a core.
        connection_uri="https://try.supertokens.com",
        # api_key="<API_KEY(if configured)>"
    ),
    framework='flask',  # Replace this with the framework you are using
    recipe_list=[
        webauthn.init(
            config=WebauthnConfig(
                get_origin=get_origin,
                get_relying_party_id=get_relying_party_id,
                get_relying_party_name=get_relying_party_name,
            )
        ),
        session.init()  # initializes session features
    ]
)
```

The backend recipe accepts the following properties during initialization:

| Option | Description | Default |
|--------|-------------|---------|
| `get_relying_party_id` | Sets the domain name associated with the WebAuthn credentials. This helps ensure that only your domain uses the credentials. | The `api_domain` value that you have set in `app_config` |
| `get_relying_party_name` | Sets a human-readable name for your application. The name appears to users during the WebAuthn registration process. | The `app_name` value that you have set in `app_config` |
| `get_origin` | Configures the origin URL that WebAuthn credentials bind to. This should match your application's domain and protocol. | Origin of the request |
| `email_delivery` | Configures how the system builds and sends verification emails to users. Read the [email delivery page](/docs/platform-configuration/email-delivery) for more information. | Default email service |
| `validate_email_address` | Adds custom validation logic for email addresses. | Basic email format validation |

All the properties are optional.

</Tab>

</Tabs>

---

## Credential generation

The client generates the credentials based on the options provided by the backend SDK.
The frontend SDK uses the [`navigator.credentials.created`](https://developer.mozilla.org/en-US/docs/Web/API/CredentialsContainer/create) function to resolve this.

To change the options used to generate credentials, you need to override the `registerOptions` function.

<Tabs>

<Tab value="nodejs">

```ts

supertokens.init({
    framework: "express",
    supertokens: {
        // https://try.supertokens.com is for demo purposes. Replace this with the address of your core instance (sign up on supertokens.com), or self host a core.
        connectionURI: "https://try.supertokens.com",
        // apiKey: <API_KEY(if configured)>,
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<YOUR_APP_NAME>",
        apiDomain: "<YOUR_API_DOMAIN>",
        websiteDomain: "<YOUR_WEBSITE_DOMAIN>",
        apiBasePath: "/auth",
        websiteBasePath: "/auth"
    },
    recipeList: [
        WebAuthn.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        registerOptions: (input) => {
                            return originalImplementation.registerOptions({
                                ...input,
                                attestation: "direct",
                                residentKey: "required",
                                timeout: 10 * 1000,
                                userVerification: "required",
                                displayName: "John Doe",
                                supportedAlgorithms: [-257],
                                relyingPartyId: 'example.com',
                                relyingPartyName: 'example',
                                origin: 'https://example.com',
                            });
                        },
                    };
                },
            },
        }),
        Session.init() // initializes session features
    ]
});
```

<br />

#### Input properties

| Name | Type | Description | Default Value |
|----------|----------|-------------|---------------|
| `relyingPartyId` | `string` | The domain name of your application that the system uses for validating the credential. | Uses `getRelyingPartyId` from the recipe configuration which defaults to the `apiDomain` |
| `relyingPartyName` | `string` | The human-readable name of your application. | Uses `getRelyingPartyName` from the recipe configuration which defaults to the `apiName` |
| `origin` | `string` | The origin URL where the credential is generated. | Uses `getOrigin` from the recipe configuration which defaults to the origin of the request |
| `timeout` | `number` | The time in milliseconds that the user has to complete the credential generation process. | `6000` |
| `attestation` | `"none" \| "indirect" \| "direct" \| "enterprise"`  | The amount of information about the authenticator that gets included in the attestation statement. This controls what authenticators support. | `none` |
| `supportedAlgorithms` | `number[]` | The cryptographic algorithms that can generate credentials. Different authenticators support different algorithms. | `[-8, -7, -257]` |
| `residentKey` | `"discouraged" \| "preferred" \| "required"` | Whether the credential gest stored on the authenticator device. | `required` |
| `userVerification` | `"discouraged" \| "preferred" \| "required"` | Whether user verification (like `PIN` or biometrics) is necessary. | `preferred` |
| `displayName` | `string` | The display name of the user. | The user's `email` property |

</Tab>

<Tab value="go">

:::caution

At the moment there is no support for using passkeys authentication in the Go SDK.

:::

</Tab>

<Tab value="python">

```python
from typing import List, Optional, cast

from typing_extensions import Unpack

from supertokens_python import InputAppInfo, SupertokensConfig, init
from supertokens_python.recipe import session, webauthn
from supertokens_python.recipe.webauthn import RecipeInterface, WebauthnConfig
from supertokens_python.recipe.webauthn.interfaces.recipe import (
    Attestation,
    RegisterOptionsKwargsInput,
    ResidentKey,
    UserVerification,
)
from supertokens_python.recipe.webauthn.types.config import OverrideConfig
from supertokens_python.types.base import UserContext

def override_webauthn_functions(original_implementation: RecipeInterface):
    original_register_options = original_implementation.register_options

    async def register_options(
        *,
        relying_party_id: str,
        relying_party_name: str,
        origin: str,
        resident_key: Optional[ResidentKey] = None,
        user_verification: Optional[UserVerification] = None,
        user_presence: Optional[bool] = None,
        attestation: Optional[Attestation] = None,
        supported_algorithm_ids: Optional[List[int]] = None,
        timeout: Optional[int] = None,
        tenant_id: str,
        user_context: UserContext,
        **kwargs: Unpack[RegisterOptionsKwargsInput],
    ):
        return await original_register_options(
            relying_party_id="example.com",
            relying_party_name="example",
            origin="https://example.com",
            resident_key="required",
            user_verification="required",
            user_presence=True,
            attestation="direct",
            timeout=10 * 1000,
            tenant_id=tenant_id,
            user_context=user_context,
            email=cast(str, kwargs.get("email")),
            recover_account_token=cast(str, kwargs.get("recover_account_token")),
            display_name="John Doe",
        )

    original_implementation.register_options = register_options
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="<YOUR_APP_NAME>",
        api_domain="<YOUR_API_DOMAIN>",
        website_domain="<YOUR_WEBSITE_DOMAIN>",
        api_base_path="/auth",
        website_base_path="/auth",
    ),
    supertokens_config=SupertokensConfig(
        # https://try.supertokens.com is for demo purposes. Replace this with the address of your core instance (sign up on supertokens.com), or self host a core.
        connection_uri="https://try.supertokens.com",
        # api_key="<API_KEY(if configured)>"
    ),
    framework="flask",  # Replace this with the framework you are using
    recipe_list=[
        webauthn.init(
            config=WebauthnConfig(
                override=OverrideConfig(functions=override_webauthn_functions)
            )
        ),
        session.init(),  # initializes session features
    ],
)
```

<br />

#### Input properties

| Name | Type | Description | Default Value |
|----------|----------|-------------|---------------|
| `relying_party_id` | `str` | The domain name of your application that the system uses for validating the credential. | Uses `get_relying_party_id` from the recipe configuration which defaults to the `api_domain` |
| `relying_party_name` | `str` | The human-readable name of your application. | Uses `get_relying_party_name` from the recipe configuration which defaults to the `app_name` |
| `origin` | `str` | The origin URL where the credential is generated. | Uses `get_origin` from the recipe configuration which defaults to the origin of the request |
| `timeout` | `int` | The time in milliseconds that the user has to complete the credential generation process. | `6000` |
| `attestation` | `"none" \| "indirect" \| "direct" \| "enterprise"`  | The amount of information about the authenticator that gets included in the attestation statement. This controls what authenticators support. | `none` |
| `supported_algorithms` | `List[int]` | The cryptographic algorithms that can generate credentials. Different authenticators support different algorithms. | `[-8, -7, -257]` |
| `resident_key` | `"discouraged" \| "preferred" \| "required"` | Whether the credential gest stored on the authenticator device. | `required` |
| `user_verification` | `"discouraged" \| "preferred" \| "required"` | Whether user verification (like `PIN` or biometrics) is necessary. | `preferred` |
| `display_name` | `str` | The display name of the user. | The user's `email` property |

</Tab>

</Tabs>

---

## Credential validation

When a user attempts to login, the authenticator uses their credential to sign a challenge on the client.
The frontend SDK uses the [`navigator.credentials.get`](https://developer.mozilla.org/en-US/docs/Web/API/CredentialsContainer/get) function to resolve this.

The server generates the options for signing the challenge through the backend SDK, and then sends them to the client. 
To change those, you need to override the `signInOptions` function.

<Tabs>

<Tab value="nodejs">

```ts

supertokens.init({
    framework: "express",
    supertokens: {
        // https://try.supertokens.com is for demo purposes. Replace this with the address of your core instance (sign up on supertokens.com), or self host a core.
        connectionURI: "https://try.supertokens.com",
        // apiKey: <API_KEY(if configured)>,
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<YOUR_APP_NAME>",
        apiDomain: "<YOUR_API_DOMAIN>",
        websiteDomain: "<YOUR_WEBSITE_DOMAIN>",
        apiBasePath: "/auth",
        websiteBasePath: "/auth"
    },
    recipeList: [
        WebAuthn.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signInOptions: (input) => {
                            return originalImplementation.signInOptions({
                                ...input,
                                timeout: 10 * 1000,
                                userVerification: "required",
                                relyingPartyId: 'example.com',
                                origin: 'https://example.com',
                            });
                        },
                    };
                },
            },
        }),
        Session.init() // initializes session features
    ]
});
```

#### Input properties

| Name | Type | Description | Default |
|----------|----------|-------------|---------|
| `relyingPartyId` | `string` | The domain name of your application that the system uses for validating the credential. | Uses `getRelyingPartyId` from the recipe configuration which defaults to the `apiDomain` |
| `relyingPartyName` | `string` | The human-readable name of your application. | Uses `getRelyingPartyName` from the recipe configuration which defaults to the `apiName` |
| `origin` | `string` | The origin URL where the credential is generated. | Uses `getOrigin` from the recipe configuration which defaults to the origin of the request |
| `timeout` | `number` | The time in milliseconds that the user has to complete the credential validation process. | `6000` |
| `userVerification` | `"discouraged" \| "preferred" \| "required"` | The parameter controls whether user verification (like `PIN` or biometrics) is necessary. | `preferred` |

</Tab>

<Tab value="go">

:::caution

At the moment there is no support for using passkeys authentication in the Go SDK.

:::

</Tab>

<Tab value="python">

```python
from typing import Any

from supertokens_python import InputAppInfo, SupertokensConfig, init
from supertokens_python.recipe import session, webauthn
from supertokens_python.recipe.webauthn import RecipeInterface, WebauthnConfig
from supertokens_python.recipe.webauthn.types.config import OverrideConfig
from supertokens_python.types.base import UserContext

def override_webauthn_functions(original_implementation: RecipeInterface):
    original_sign_in_options = original_implementation.sign_in_options

    async def sign_in_options(
        *,
        tenant_id: str,
        user_context: UserContext,
        **kwargs: Any
    ):
        return await original_sign_in_options(
            tenant_id=tenant_id,
            user_context=user_context,
            timeout=10 * 1000,
            user_verification="required",
            relying_party_id='example.com',
            relying_party_name='Example',
            origin='https://example.com',
        )

    original_implementation.sign_in_options = sign_in_options
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="<YOUR_APP_NAME>",
        api_domain="<YOUR_API_DOMAIN>",
        website_domain="<YOUR_WEBSITE_DOMAIN>",
        api_base_path="/auth",
        website_base_path="/auth"
    ),
    supertokens_config=SupertokensConfig(
        # https://try.supertokens.com is for demo purposes. Replace this with the address of your core instance (sign up on supertokens.com), or self host a core.
        connection_uri="https://try.supertokens.com",
        # api_key="<API_KEY(if configured)>"
    ),
    framework='flask',  # Replace this with the framework you are using
    recipe_list=[
        webauthn.init(
            config=WebauthnConfig(
                override=OverrideConfig(
                    functions=override_webauthn_functions
                )
            )
        ),
        session.init()  # initializes session features
    ]
)
```

#### Input properties

| Name | Type | Description | Default |
|----------|----------|-------------|---------|
| `relying_party_id` | `str` | The domain name of your application that the system uses for validating the credential. | Uses `get_relying_party_id` from the recipe configuration which defaults to the `api_domain` |
| `relying_party_name` | `str` | The human-readable name of your application. | Uses `get_relying_party_name` from the recipe configuration which defaults to the `app_name` |
| `origin` | `str` | The origin URL where the credential is generated. | Uses `get_origin` from the recipe configuration which defaults to the origin of the request |
| `timeout` | `int` | The time in milliseconds that the user has to complete the credential validation process. | `6000` |
| `user_verification` | `"discouraged" \| "preferred" \| "required"` | The parameter controls whether user verification (like `PIN` or biometrics) is necessary. | `preferred` |

</Tab>

</Tabs>

# Authentication -  Authenticate MCP Servers
Source: https://supertokens.com/docs/authentication/ai-authentication

## Overview

This guide explains how to authenticate Model Context Protocol (MCP) Servers using **SuperTokens**.
The instructions make use of the `plugins` functionality.
It is a new way to abstract common functionalities into a reusable package.

## Before you start



The [MCP authentication flow](https://modelcontextprotocol.io/specification/2025-03-26/basic/authorization) complies with the OAuth2 specifications.
This means that you will have to use the `OAuth2` recipe in your configuration which is a paid feature.

The functionality is only available alongside the `node` SDK at the moment.
Keep in mind that the feature is currently in beta and might be subject to breaking changes.

## Steps

### 1. Install the plugin

Add the `supertokens-mcp-plugin` package to your project.

<Tabs>
  <Tab value="npm" label="npm">
    ```bash 
    npm i -s supertokens-mcp-plugin
    ```
  </Tab>
  <Tab value="yarn" label="yarn">
    ```bash 
    yarn add supertokens-mcp-plugin
    ```
  </Tab>
  <Tab value="pnpm" label="pnpm">
    ```bash
    pnpm add supertokens-auth-react supertokens-web-js
    ```
  </Tab>
</Tabs>

### 2. Add the MCP server

Use the `SuperTokensMcpServer` class when in your implementation.
The class extends the base MCP server exposed by the `@modelcontextprotocol/sdk`, and adds custom authentication logic on top of it.

You can authorize the client requests in two different ways. 
By using the standard [claim validators](/docs/additional-verification/session-verification/claim-validation).
Or you can write your own custom validation logic in the `validateTokenPayload` function. 

The authentication state can be accessed inside a tool call through the second function argument, `extra.authInfo`.

```ts

const server = new SuperTokensMcpServer({
  name: "example-mcp",
  version: "1.0.0",
  path: "/mcp",
  validateTokenPayload: async (_accessTokenPayload, _userContext) => {
    // You can check the acccess token payload for any specific values
    return {
      status: "OK",
    };
  },
  // By default, you can use calim validators to determine who can access the MCP server
  claimValidators: [UserRoleClaim.validators.includes("admin")],
});

server.registerTool(
  "session-info",
  {
    inputSchema: {},
    description: "Get session information",
  },
  async (_args, extra) => {
    return {
      content: [
        {
          type: "text",
          text: JSON.stringify(extra.authInfo),
        },
      ],
    };
  }
);

```

### 3. Update the SDK initialization code

Now that you have created your server include it in the SuperTokens SDK configuration.
This way, the SDK middleware will expose your new endpoint and authenticate each request.

```ts

// The server that you have previously created
const server = new SuperTokensMcpServer({});

supertokens.init({
  supertokens: {
    connectionURI: "<SUPERTOKENS_CONNECTION_URI>",
    apiKey: "<SUPERTOKENS_API_KEY>",
  },
  appInfo: {
    appName: "<APP_NAME>",
    apiDomain: "<API_DOMAIN>",
    websiteDomain: "<WEBSITE_DOMAIN>",
    apiBasePath: "<API_BASE_PATH>",
    websiteBasePath: "<WEBSITE_BASE_PATH>",
  },
  recipeList: [
    // Include your existing recipes here
    // The OAuth2Provider recipe is required for the MCP authorization process
    OAuth2Provider.init(),
  ],
  experimental: {
    plugins: [
      SuperTokensMcpPlugin.init({
        mcpServers: [server],
      }),
    ],
  },
});
```

# Additional Verification - Session Verification -  Protect API routes
Source: https://supertokens.com/docs/additional-verification/session-verification/protect-api-routes

## Overview

You can choose between three different methods to check for a session inside an API route handler.
The easiest way to do it is to use the `Verify Session` middleware.
Also, depending on your use case, you can directly fetch the session or manually verify the JWT.
Check each method to see which one works for you.

## Before you start



---

## Using `Verify Session`

This function acts as a middleware inside your API endpoints.
Hence, it requires that your backend framework supports the concept of middlewares.
Besides checking for a session, it also writes responses to the client on its own, based on the session's validity and the provided configuration.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

// highlight-start
app.post("/like-comment", verifySession(), (req: SessionRequest, res) => {
    let userId = req.session!.getUserId();
    // highlight-end
    //....
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",
    //highlight-start
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let userId = req.session!.getUserId();
        //highlight-end
        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post("/like-comment", {
    preHandler: verifySession(),
}, (req: SessionRequest, res) => {
    let userId = req.session!.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function likeComment(awsEvent: SessionEventV2) {
    let userId = awsEvent.session!.getUserId();
    //....
};

//highlight-next-line
exports.handler = verifySession(likeComment);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/like-comment", verifySession(), (ctx: SessionContext, next) => {
    let userId = ctx.session!.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    //highlight-start
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/like-comment")
    @intercept(verifySession())
    @response(200)
    handler() {
        let userId = (this.ctx as SessionContext).session!.getUserId();
        //highlight-end
        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
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();
    // highlight-end
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        let userId = session!.getUserId();
        //....
        return NextResponse.json({})
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@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> {
    //highlight-start
    let userId = session.getUserId();

    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go

let app = express();

app.post("/like-comment", 
    // highlight-next-line
    verifySession({sessionRequired: false}), 
    (req: SessionRequest, res) => {
        if (req.session !== undefined) {
            let userId = req.session.getUserId();
        } else {
            // user is not logged in...
        }
    }
);
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",
    options: {
        pre: [
            {
                // highlight-next-line
                method: verifySession({ sessionRequired: false })
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        if (req.session !== undefined) {
            let userId = req.session.getUserId();
        } else {
            // user is not logged in...
        }
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/like-comment", {
    // highlight-next-line
    preHandler: verifySession({ sessionRequired: false }),
}, (req: SessionRequest, res) => {
    if (req.session !== undefined) {
        let userId = req.session.getUserId();
    } else {
        // user is not logged in...
    }
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function likeComment(awsEvent: SessionEventV2) {
    if (awsEvent.session !== undefined) {
        let userId = awsEvent.session.getUserId();
    } else {
        // user is not logged in...
    }
};

// highlight-next-line
exports.handler = verifySession(likeComment, { sessionRequired: false });
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/like-comment",
    // highlight-next-line
    verifySession({ sessionRequired: false }),
    (ctx: SessionContext, next) => {
        if (ctx.session !== undefined) {
            let userId = ctx.session.getUserId();
        } else {
            // user is not logged in...
        }
    }
);
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/like-comment")
    // highlight-next-line
    @intercept(verifySession({ sessionRequired: false }))
    @response(200)
    handler() {
        let session = (this.ctx as SessionContext).session;
        if (session !== undefined) {
            let userId = session.getUserId();
        } else {
            // user is not logged in...
        }
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function likeComment(req: any, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({ sessionRequired: false })(req, res, next);
        },
        req,
        res
    )

    let session = (req as SessionRequest).session;

    if (session !== undefined) {
        let userId = session.getUserId();
        // session exists
    } else {
        // session doesn't exist
    }
    // highlight-end
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }

        if (session !== undefined) {
            let userId = session.getUserId();
            // session exists
        } else {
            // session doesn't exist
        }
        //....
        return NextResponse.json({});
    },
    { sessionRequired: false });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new OptionalAuthGuard()) // For more information about this guard please read our NestJS guide.
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    //highlight-start
    if (session !== undefined) {
        let userId = session.getUserId();
        // session exists
    } else {
        // session doesn't exist
    }

    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go

let app = express();

app.post(
    "/update-blog",
    verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ],
    }),
    async (req: SessionRequest, res) => {
        // All validator checks have passed and the user is an admin.
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    overrideGlobalClaimValidators: async (globalValidators) => [
                        ...globalValidators,
                        UserRoles.UserRoleClaim.validators.includes("admin"),
                        // UserRoles.PermissionClaim.validators.includes("edit")
                    ],
                }),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // All validator checks have passed and the user is an admin.
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ],
    }),
}, async (req: SessionRequest, res) => {
    // All validator checks have passed and the user is an admin.
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    // All validator checks have passed and the user is an admin.
};

exports.handler = verifySession(updateBlog, {
    overrideGlobalClaimValidators: async (globalValidators) => ([
        ...globalValidators, 
        UserRoles.UserRoleClaim.validators.includes("admin"),
        // UserRoles.PermissionClaim.validators.includes("edit")
    ])
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => ([
            ...globalValidators, 
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ])
    }), async (ctx: SessionContext, next) => {
    // All validator checks have passed and the user is an admin.
});
```

</Tab>
<Tab value="loopback">

```tsx

class SetRole {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => ([
            ...globalValidators, 
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ])
    }))
    @response(200)
    async handler() {
        // All validator checks have passed and the user is an admin.
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function setRole(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                overrideGlobalClaimValidators: async (globalValidators) => ([
                    ...globalValidators, 
                    UserRoles.UserRoleClaim.validators.includes("admin"),
                    // UserRoles.PermissionClaim.validators.includes("edit")
                ])
            })(req, res, next);
        },
        req,
        res
    )
    // All validator checks have passed and the user is an admin.
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        // All validator checks have passed and the user is an admin.
        return NextResponse.json({})
    },
    {
        // highlight-start
        overrideGlobalClaimValidators: async function (globalClaimValidators) {
            return [...globalClaimValidators, UserRoles.UserRoleClaim.validators.includes("admin")]
        }
        // highlight-end
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard({
    overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => ([
        ...globalValidators, 
        UserRoles.UserRoleClaim.validators.includes("admin"),
        // UserRoles.PermissionClaim.validators.includes("edit")
    ])
  }))
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    // All validator checks have passed and the user is an admin.
    return true;
  }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="http">

```go

let app = express();

// highlight-start
app.post("/like-comment", async (req, res, next) => {
    try {
        let session = await Session.getSession(req, res);

        let userId = session.getUserId();
        // highlight-end
        //....
    } catch (err) {
        next(err);
    }
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",
    //highlight-start
    handler: async (req, res) => {
        let session = await Session.getSession(req, res);

        let userId = session.getUserId();
        //highlight-end
        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post("/like-comment", async (req, res) => {
    let session = await Session.getSession(req, res);

    let userId = session.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

//highlight-start
async function likeComment(awsEvent: SessionEvent) {
    let session = await Session.getSession(awsEvent, awsEvent);

    let userId = session.getUserId();
    //highlight-end
    //....
};

//highlight-next-line
exports.handler = middleware(likeComment);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/like-comment", async (ctx, next) => {
    let session = await Session.getSession(ctx, ctx);

    let userId = session.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    //highlight-start
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/like-comment")
    @response(200)
    async handler() {
        let session = await Session.getSession(this.ctx, this.ctx);

        let userId = session.getUserId();
        //highlight-end
        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function likeComment(req: SessionRequest, res: any) {
    let session = await superTokensNextWrapper(
        async (next) => {
            return await Session.getSession(req, res);
        },
        req,
        res
    )

    let userId = session.getUserId();
    // highlight-end
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withPreParsedRequestResponse(request, async (baseRequest: PreParsedRequest, baseResponse: CollectingResponse) => {
        const session = await Session.getSession(baseRequest, baseResponse);
        let userId = session.getUserId();
        return NextResponse.json({});
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx

@Controller()
export class ExampleController {
  @Post('example')
  async postExample(@Req() req: Request, @Res({passthrough: true}) res: Response): Promise<boolean> {
    //highlight-start
    // This should be done inside a parameter decorator, for more information please read our NestJS guide.
    const session = await Session.getSession(req, res);

    const userId = session.getUserId();
    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

let app = express();

app.post("/like-comment", async (req, res, next) => {
    try {
        let session = await Session.getSession(req, res, { sessionRequired: false })

        if (session !== undefined) {
            let userId = session.getUserId();
        } else {
            // user is not logged in...
        }
        //....
    } catch (err) {
        next(err);
    }
});
```

</Tab>
<Tab value="hapi">

```tsx

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...
        }

        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

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...
    }
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

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...
    }

    //....
};

//highlight-next-line
exports.handler = middleware(likeComment);
```

</Tab>
<Tab value="koa">

```tsx

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...
    }

    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

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...
        }

        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

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...
    }
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withPreParsedRequestResponse(request, async (baseRequest: PreParsedRequest, baseResponse: CollectingResponse) => {
        const session = await Session.getSession(baseRequest, baseResponse, { sessionRequired: false });
        if (session !== undefined) {
            let userId = session.getUserId();
        } else {
            // user is not logged in...
        }
        return NextResponse.json({});
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx

@Controller()
export class ExampleController {
  @Post('example')
  async postExample(@Req() req: Request, @Res({ passthrough: true }) res: Response): Promise<boolean> {
    //highlight-start
    // 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...
    }
    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

let app = express();

// highlight-start
app.post("/like-comment", async (req, res, next) => {
    try {
        let session = await Session.getSession(req, res, {
            overrideGlobalClaimValidators: async (globalValidators) => [
                ...globalValidators,
                UserRoles.UserRoleClaim.validators.includes("admin"),
                // UserRoles.PermissionClaim.validators.includes("edit")
            ]
        });

        let userId = session.getUserId();
        // highlight-end
        //....
    } catch (err) {
        next(err)
    }
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",
    //highlight-start
    handler: async (req, res) => {
        let session = await Session.getSession(req, res, {
            overrideGlobalClaimValidators: async (globalValidators) => [
                ...globalValidators,
                UserRoles.UserRoleClaim.validators.includes("admin"),
                // UserRoles.PermissionClaim.validators.includes("edit")
            ]
        });

        let userId = session.getUserId();
        //highlight-end
        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post("/like-comment", async (req, res) => {
    let session = await Session.getSession(req, res, {
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ]
    });

    let userId = session.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

//highlight-start
async function likeComment(awsEvent: SessionEvent) {
    let session = await Session.getSession(awsEvent, awsEvent, {
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ]
    });

    let userId = session.getUserId();
    //highlight-end
    //....
};

//highlight-next-line
exports.handler = middleware(likeComment);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/like-comment", async (ctx, next) => {
    let session = await Session.getSession(ctx, ctx, {
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ]
    });

    let userId = session.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    //highlight-start
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/like-comment")
    @response(200)
    async handler() {
        let session = await Session.getSession(this.ctx, this.ctx, {
            overrideGlobalClaimValidators: async (globalValidators) => [
                ...globalValidators,
                UserRoles.UserRoleClaim.validators.includes("admin"),
                // UserRoles.PermissionClaim.validators.includes("edit")
            ]
        });

        let userId = session.getUserId();
        //highlight-end
        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function likeComment(req: SessionRequest, res: any) {
    let session = await superTokensNextWrapper(
        async (next) => {
            return await Session.getSession(req, res, {
                overrideGlobalClaimValidators: async (globalValidators) => [
                    ...globalValidators,
                    UserRoles.UserRoleClaim.validators.includes("admin"),
                    // UserRoles.PermissionClaim.validators.includes("edit")
                ]
            });
        },
        req,
        res
    )

    let userId = session.getUserId();
    // highlight-end
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withPreParsedRequestResponse(request, async (baseRequest: PreParsedRequest, baseResponse: CollectingResponse) => {
        const session = await Session.getSession(baseRequest, baseResponse, {
            overrideGlobalClaimValidators: async (globalValidators) => [
                ...globalValidators,
                UserRoles.UserRoleClaim.validators.includes("admin"),
                // UserRoles.PermissionClaim.validators.includes("edit")
            ]
        });
        let userId = session.getUserId();
        return NextResponse.json({});
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx

@Controller()
export class ExampleController {
  @Post('example')
  async postExample(@Req() req: Request, @Res({passthrough: true}) res: Response): Promise<boolean> {
    //highlight-start
    // This should be done inside a parameter decorator, for more information please read our NestJS guide.
    const session = await Session.getSession(req, res, {
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ]
    });

    const userId = session.getUserId();
    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

function verifySession(options?: VerifySessionOptions) {
    return async (req: Request, res: Response, next: NextFunction) => {
        try {
            (req as any).session = await Session.getSession(req, res, options);
            next();
        } catch (err) {
            if (SuperTokensError.isErrorFromSuperTokens(err)) {
                if (err.type === Session.Error.TRY_REFRESH_TOKEN) {
                    // This means that the session exists, but the access token
                    // has expired.

                    // You can handle this in a custom way by sending a 401.
                    // Or you can call the errorHandler middleware as shown below
                } else if (err.type === Session.Error.UNAUTHORISED) {
                    // This means that the session does not exist anymore.

                    // You can handle this in a custom way by sending a 401.
                    // Or you can call the errorHandler middleware as shown below
                } else if (err.type === Session.Error.INVALID_CLAIMS) {
                    // The user is missing some required claim. 
                    // You can pass the missing claims to the frontend and handle it there. Send a 403 to the frontend.
                }

                // OR you can use this errorHandler which will
                // handle all of the above errors in the default way
                errorHandler()(err, req, res, (err) => {
                    next(err)
                })
            } else {
                next(err)
            }
        }
    };
}
```

The `errorHandler` sends a `401` reply to the frontend if the `getSession` function throws an exception indicating that the session does not exist or if the access token has expired.

</Tab>
<Tab value="go">

```go

            baseRequest = FlaskRequest(request)
            try:
                session = get_session(
                    baseRequest,
                    session_required,
                    anti_csrf_check,
                    check_database,
                    override_global_claim_validators,
                )
            except Exception as e:
                if isinstance(e, TryRefreshTokenError):
                    # This means that the session exists, but the access token
                    # has expired.

                    # You can handle this in a custom way by sending a 401.
                    # Or you can call the errorHandler middleware as shown below
                    pass
                if isinstance(e, UnauthorisedError):
                    # This means that the session does not exist anymore.

                    # You can handle this in a custom way by sending a 401.
                    # Or you can call the errorHandler middleware as shown below
                    pass
                if isinstance(e, InvalidClaimsError):
                    # The user is missing some required claim.
                    # You can pass the missing claims to the frontend and handle it there. Send a 403 to the frontend.
                    pass

                # OR you can raise this error which will
                # handle all of the above errors in the default way
                raise e
            if session is None:
                if session_required:
                    raise Exception("Should never come here")
                baseRequest.set_session_as_none()
            else:
                baseRequest.set_session(session)
            response = make_response(f(*args, **kwargs))
            return response

        return cast(_T, wrapped_function)

    return session_verify

```

If `get_session` throws an error (in case the input access token is invalid or has expired), then the SuperTokens middleware added to your app handles that exception. It sends a `401` to the frontend.

</Tab>
</Tabs>

### Get the session using the `Access Token`

In the above snippets, `Get Session` requires the `request` object and, depending on your backend language and framework, may also require the `response` object.
Either way, this version of `Get Session` automatically reads from the request.
And automatically sets the response based on the update to the session tokens.
Whilst this is convenient, sometimes, you may not have the `request` or `response` objects, or you may not want SuperTokens to set the tokens in the response automatically.
In this case, you can use the `getSessionWithoutRequestResponse` function.

This function works similarly to `getSession`, except that it doesn't depend on the `request` or `response` objects.
It's your responsibility to provide this function the access token.
You must write the update tokens to the response if the tokens update during this API call.

<Tabs>
<Tab value="nodejs">

```tsx

async function verifySession(accessToken: string, antiCsrfToken?: string, options?: VerifySessionOptions) {
    let session: SessionContainer | undefined;
    try {
        session = await Session.getSessionWithoutRequestResponse(accessToken, antiCsrfToken, options);
    } catch (err) {
        if (SuperTokensError.isErrorFromSuperTokens(err)) {
            if (err.type === Session.Error.TRY_REFRESH_TOKEN) {
                // This means that the session exists, but the access token
                // has expired.

                // You can handle this in a custom way by sending a 401.
                // Or you can call the errorHandler middleware as shown below
            } else if (err.type === Session.Error.UNAUTHORISED) {
                // This means that the session does not exist anymore.

                // You can handle this in a custom way by sending a 401.
                // Or you can call the errorHandler middleware as shown below
            } else if (err.type === Session.Error.INVALID_CLAIMS) {
                // The user is missing some required claim. 
                // You can pass the missing claims to the frontend and handle it there. Send a 403 to the frontend.
            }
        }
        throw err;
    }
    if (session !== undefined) {
        // we can use the `session` container as we usually do..
        // TODO: API logic...

        // At the end of the API logic, we must fetch all the tokens from the session container
        // and set them in the response headers / cookies ourselves.
        const tokens = session.getAllSessionTokensDangerously();
        if (tokens.accessAndFrontTokenUpdated) {
            // TODO: set access token in response via tokens.accessToken
            // TODO: set front-token in response via tokens.frontToken
            if (tokens.antiCsrfToken) {
                // TODO: set anti-csrf token update in response via tokens.antiCsrfToken
            }
        }
    }
}
```

</Tab>
<Tab value="go">

```go
		// and set them in the response headers / cookies ourselves.
		tokens := session.GetAllSessionTokensDangerously()
		if tokens.AccessAndFrontendTokenUpdated {
			// TODO: set access token in response via tokens.accessToken
			// TODO: set front-token in response via tokens.frontToken
			if tokens.AntiCsrfToken != nil {
				// TODO: set anti-csrf token update in response via *tokens.AntiCsrfToken
			}
		}
	}
	return nil
}
```

</Tab>
<Tab value="python">

```python
from typing import Any, Callable, Dict, List, Optional, TypeVar

from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.exceptions import (
    InvalidClaimsError,
    TryRefreshTokenError,
    UnauthorisedError,
)
from supertokens_python.recipe.session.interfaces import SessionClaimValidator
from supertokens_python.recipe.session.syncio import (
    get_session_without_request_response,
)
from supertokens_python.types import MaybeAwaitable

_T = TypeVar("_T", bound=Callable[..., Any])

def verify_session(
    access_token: str,
    anti_csrf_token: Optional[str],
    anti_csrf_check: Optional[bool],
    session_required: Optional[bool],
    check_database: Optional[bool],
    override_global_claim_validators: Optional[
        Callable[
            [List[SessionClaimValidator], SessionContainer, Dict[str, Any]],
            MaybeAwaitable[List[SessionClaimValidator]],
        ]
    ] = None,
):
    try:
        session = get_session_without_request_response(
            access_token,
            anti_csrf_token,
            anti_csrf_check,
            session_required,
            check_database,
            override_global_claim_validators,
        )
    except Exception as e:
        if isinstance(e, TryRefreshTokenError):
            # This means that the session exists, but the access token
            # has expired.

            # You can handle this in a custom way by sending a 401.
            # Or you can call the errorHandler middleware as shown below
            pass
        if isinstance(e, UnauthorisedError):
            # This means that the session does not exist anymore.

            # You can handle this in a custom way by sending a 401.
            # Or you can call the errorHandler middleware as shown below
            pass
        if isinstance(e, InvalidClaimsError):
            # The user is missing some required claim.
            # You can pass the missing claims to the frontend and handle it there. Send a 403 to the frontend.
            pass

        # OR you can raise this error which will
        # handle all of the above errors in the default way
        raise e

    if session is not None:
        # we can use the `session` container as we usually do..
        # TODO: API logic...

        # At the end of the API logic, we must fetch all the tokens from the session container
        # and set them in the response headers / cookies ourselves.
        tokens = session.get_all_session_tokens_dangerously()
        if tokens["accessAndFrontTokenUpdated"]:
            # TODO: set access token in response via tokens["accessToken"]
            # TODO: set front-token in response via tokens["frontToken"]
            if tokens["antiCsrfToken"] is not None:
                # TODO: set anti-csrf token update in response via tokens["antiCsrfToken"]
                pass

```

</Tab>
</Tabs>

---

## Using a JWT verification library

If the previous methods are not suitable for your use case, you can use validate the token manually.
This method works for cases like:
- Your APIs are on a backend for which SuperTokens doesn't have SDKs.
- You are using a non `http` protocol (like `websockets`) and passing in the access token.
- You are using an API gateway which does JWT verification based on the JWKs endpoint.

:::caution
The downside to using JWT verification manually is that:
- Pick and configure a JWT verification library for your framework. Many online guides explain how to do this.
- You need to manually verify some custom claims in the JWT (like the user's role is `admin`, or that the user's email is verified) based on your authorization rules.
- You don't have access to the [`session` object](/docs/additional-verification/session-verification/protect-api-routes#using-verify-session) using which you can modify the session's access token payload, or revoke the session. These operations can occur in an offline manner, but they reflect in the user's session only after a session refresh.
:::

The manual session verification method should work in this way:

<Steps>
  ## Verify the JWT signature and expiry using a JWT verification library
  ## Check for custom claim values for authorization.
  ## Prevent cross-site request forgery (CSRF) attacks in case you are using cookies to store the JWT.
</Steps>



### With the JSON Web Key Set (JWKS) Endpoint

<Tabs additionalValues={[{value: "java", label: "Java"}]}>
<Tab value="nodejs">

Some libraries let you provide a JSON Web Key Set (JWKS) endpoint to verify a JWT.
The JSON Web Key Set (JWKS) endpoint exposed by SuperTokens is available at the following URL:

```bash
curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
```

Below is an example for NodeJS showing how you can use `jsonwebtoken` and `jwks-rsa` together to achieve JWT verification using the `jwks.json` endpoint.

```ts

var client = jwksClient({
  jwksUri: '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
});

function getKey(header: JwtHeader, callback: SigningKeyCallback) {
  client.getSigningKey(header.kid, function (err, key) {
    var signingKey = key!.getPublicKey();
    callback(err, signingKey);
  });
}

let jwt = "..."; // fetch the JWT from sAccessToken cookie or Authorization Bearer header
JsonWebToken.verify(jwt, getKey, {}, function (err, decoded) {
  let decodedJWT = decoded;
  // Use JWT
});
```

</Tab>
<Tab value="python">

Refer to this [GitHub gist](https://gist.github.com/rishabhpoddar/ea31502923ec9a53136371f2b6317ffa) for a code reference of how use `PyJWK` to do session verification. The gist contains two files:
- `jwt_verification.py` (which you can copy/paste into your application). You need to modify the `JWKS_URI` in this file to point to your SuperTokens core instance (replacing the `try.supertokens.com` part of the URL). This file is for `sync` python apps and can be modified to work with `async` apps as well.
  - This file essentially exposes a function called `verify_jwt` which takes an input JWT string.
  - This function takes care of caching public keys in memory and auto re-fetching if the public keys have changed (which happens automatically every 24 hours with SuperTokens). This does not cause any user logouts and is a security feature.
- `views.py`: This is an example `GET` API which extracts the JWT token from the authorization header in the request and calls the `verify_jwt` function from the other file. If you are using cookie based auth instead of header based auth, you should read the JWT from the `sAccessToken` cookie in the request.

</Tab>
<Tab value="go">

Refer to this [GitHub gist](https://gist.github.com/rishabhpoddar/8c26ed237add1a5b86481e72032abf8d) for a code reference of how use the Golang `jwt` lib to do session verification. The gist contains two files:
- `verifyToken.go` (which you can copy/paste into your application). You need to modify the `coreUrl` in this file to point to your SuperTokens core instance (replacing the `try.supertokens.com` part of the URL).
  - This file essentially exposes a function called `GetJWKS` which returns a reference to the JSON Web Key Set (JWKS) public keys usable for JWT verification.
  - This function takes care of caching public keys in memory and auto re-fetching if the public keys have changed (which happens automatically every 24 hours with SuperTokens). This does not cause any user logouts and is a security feature.
- `main.go`: This is an example of how to verify a JWT using the golang JWT verification lib along with the helper function to get the JWKs keys. If you are using header-based auth, you can fetch the JWT from the `Authorization Bearer` header, otherwise for cookie-based auth, you can fetch it from the `sAccessToken` cookie.

</Tab>
<Tab value="java">

Refer to this [GitHub gist](https://gist.github.com/rishabhpoddar/5b2d19c02337ed7ee387723c84def9cd) for a code reference of how use the Java `nimbus-jose-jwt` lib to do session verification. The gist contains three files:
- `JWTVerification.java` You need to modify the `CORE_URL` in this file to point to your SuperTokens core instance (replacing the `try.supertokens.com` part of the URL).
  - This is an example of how to verify a JWT using the Java `nimbus-jose-jwt` lib along with the helper method to get the JWKs keys. If you are using header-based auth, you can fetch the JWT from the `Authorization Bearer` header, otherwise for cookie-based auth, you can fetch it from the `sAccessToken` cookie.
  - This file has a method called `setSource` which returns a reference to the JSON Web Key Set (JWKS) public keys usable for JWT verification. This method takes care of caching public keys in memory and auto re-fetching if the public keys have changed (which happens automatically every 24 hours with SuperTokens). This does not cause any user logouts and is a security feature.
- `pom.xml`: This shows the version of `nimbus-jose-jwt` used for this project.
- `InvalidClaimsException.java`: This holds the custom Exception thrown when someone has an invalid JWT body, hasn't verified their email, or hasn't set up MFA.

</Tab>
</Tabs>

### With the public key string

<Tabs additionalValues={[{value: "java", label: "Java"}]}>
<Tab value="nodejs">

:::caution
This method is less secure compared to the first method because it disables key rotation of the access token signing key.
In this case, if the private key is somehow stolen, it can be used indefinitely to forge access tokens (Unless you manually change the key in the database).
:::

Some JWT verification libraries require you to provide the JWT secret / public key for verification.
You can obtain the JWT secret from SuperTokens in the following way:

<Steps>

## Query the `JWKS.json` endpoint:

  <br />

  ```bash
  curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'

  {
    "keys": [
      {
        "kty": "RSA",
        "kid": "s-2de612a5-a5ba-413e-9216-4c43e2e78c86",
        "n": "AMZruthvYz7Ft-Dp0BC_SEEJaWK91s_YA-RR81iLJ6BTT6gJp0CcV4DfBynFU_59dRGOZyVQpAW6Drnc_6LyZpVWHROzqt-Fjh8TAqodayhPJVuZt25eQiYrqcaK_dnuHrm8qwUq-hko6q1o1o9NIIZWNfUBEVWmNhyAJFk5bi3pLwtKPYrUQzVLcTdDUe4SIltvvfpYHbVFnYtxkBVmqO68j7sI8ktmTXM_heals-W6WmozabDkC9_ITCeRat2f7A2l0t4QzO0ZCzZcJfhusF4X1niKgY6yYXpbX6is4HCfhYfdabcE52xYMNl-gw9XDjsIxfBMUDvOFRHWlx0rU8c=",
        "e": "AQAB",
        "alg": "RS256",
        "use": "sig"
      },
      {
        "kty": "RSA",
        "kid": "d-230...802340",
        "n": "AMZruthvYz7...lx0rU8c=",
        "e": "...",
        "alg": "RS256",
        "use": "sig"
      }
    ]
  }
  ```

  :::important
  The above shows an example output which returns two keys.
  More keys could return based on the configured key rotation setting in the core.
  If you notice, each key's `kid` starts with a `s-..` or a `d-..`. The `s-..` key is a static key that never changes, whereas `d-...` keys are dynamic keys that keep changing. If you are hard-coding public keys somewhere, you always want to pick the `s-..` key.

  One exception is that if you see a key with `kid` that doesn't start with `s-` or with `d-`, then treat that as a static key.
  This only happens if you used to run an older SuperTokens core that was less than version `5.0`.
  :::

## Run the NodeJS script below to convert the above output to a `PEM` file format.

  <br />

  ```tsx

  // This JWK is copied from the result of the above SuperTokens core request
  let jwk = {
    "kty": "RSA",
    "kid": "s-2de612a5-a5ba-413e-9216-4c43e2e78c86",
    "n": "AMZruthvYz7Ft-Dp0BC_SEEJaWK91s_YA-RR81iLJ6BTT6gJp0CcV4DfBynFU_59dRGOZyVQpAW6Drnc_6LyZpVWHROzqt-Fjh8TAqodayhPJVuZt25eQiYrqcaK_dnuHrm8qwUq-hko6q1o1o9NIIZWNfUBEVWmNhyAJFk5bi3pLwtKPYrUQzVLcTdDUe4SIltvvfpYHbVFnYtxkBVmqO68j7sI8ktmTXM_heals-W6WmozabDkC9_ITCeRat2f7A2l0t4QzO0ZCzZcJfhusF4X1niKgY6yYXpbX6is4HCfhYfdabcE52xYMNl-gw9XDjsIxfBMUDvOFRHWlx0rU8c=",
    "e": "AQAB",
    "alg": "RS256",
    "use": "sig"
  };

  // @ts-ignore
  let certString = jwkToPem(jwk);
  ```

  The above snippet would generate the following certificate string:

  ```text
  -----BEGIN PUBLIC KEY-----
  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxmu62G9jPsW34OnQEL9I
  QQlpYr3Wz9gD5FHzWIsnoFNPqAmnQJxXgN8HKcVT/n11EY5nJVCkBboOudz/ovJm
  ... (truncated for display)
  XhfWeIqBjrJheltfqKzgcJ+Fh91ptwTnbFgw2X6DD1cOOwjF8ExQO84VEdaXHStT
  xwIDAQAB
  -----END PUBLIC KEY-----
  ```

 Use the generated Privacy-Enhanced Mail (PEM) string in your code as shown below:

  ```ts

  // Truncated for display
  let certificate = "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxmu62G9jPsW34OnQEL9IQQlpYr3Wz9gD5FHzWIsnoFNPqAmnQJxXgN8HKcVT/n11EY5nJVCkBboOudz/ovJm...XhfWeIqBjrJheltfqKzgcJ+Fh91ptwTnbFgw2X6DD1cOOwjF8ExQO84VEdaXHStTxwIDAQAB\n-----END PUBLIC KEY-----";
  let jwt = "..."; // fetch the JWT from sAccessToken cookie or Authorization Bearer header
  JsonWebToken.verify(jwt, certificate, function (err, decoded) {
      let decodedJWT = decoded;
      // Use JWT
  });
  ```

## Tell SuperTokens to always only use the static key when creating a new session.

You can accomplish this by setting the below configuration in the backend SDK:

  ```tsx

  SuperTokens.init({
      supertokens: {
          connectionURI: "...",
      },
      appInfo: {
          apiDomain: "...",
          appName: "...",
          websiteDomain: "..."
      },
      recipeList: [
          Session.init({
              //highlight-next-line
              useDynamicAccessTokenSigningKey: false,
          })
      ]
  });
  ```

:::caution
Updating this value causes a spike in the session refresh API, as and when users visit your application.
:::

</Steps>

</Tab>
<Tab value="python">

:::caution
Not applicable. Please use method 1 instead.
:::

</Tab>
<Tab value="go">

:::caution
Not applicable. Please use method 1 instead.
:::

</Tab>
<Tab value="java">

:::caution
Not applicable. Please use method 1 instead.
:::

</Tab>
</Tabs>

### Check for custom claim values for authorization

<Tabs additionalValues={[{value: "java", label: "Java"}]}>
<Tab value="nodejs">

Once you have verified the access token, you can fetch the payload and perform authorization checks based on the values of the custom claims. For example, if you want to check if the user's email is verified, you should check the `st-ev` claim in the payload as shown below:

```ts

var client = jwksClient({
  jwksUri: '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
});

function getKey(header: JwtHeader, callback: SigningKeyCallback) {
  client.getSigningKey(header.kid, function (err, key) {
    var signingKey = key!.getPublicKey();
    callback(err, signingKey);
  });
}

let jwt = "..."; // fetch the JWT from sAccessToken cookie or Authorization Bearer header
JsonWebToken.verify(jwt, getKey, {}, function (err, decoded) {
  if (err) {
    // send a 401 to the frontend..
  }
  if (decoded !== undefined && typeof decoded !== "string") {
    let isEmailVerified = (decoded as any)["st-ev"].v
    if (!isEmailVerified) {
      // send a 403 to the frontend..
    }
  }
});
```

Claims like email verification and user roles claims are included in the access token by the backend SDK automatically. You can even [add your own custom claims](/docs/additional-verification/session-verification/claim-validation#using-the-access-token-payload) to the access token payload, and those claims will be in the JWT as expected.

:::important
On claim validation failure, you must send a `403` to the frontend, which causes the frontend SDK (pre-built UI SDK) to recheck the claims added on the frontend and navigate to the right screen.
:::

</Tab>
<Tab value="python">

Referring once again to this [GitHub gist](https://gist.github.com/rishabhpoddar/ea31502923ec9a53136371f2b6317ffa), in `views.py`, between lines 20 and 28, the `st-ev` claim in the JWT payload undergoes verification. If the claim is not present or has a value of `false`, a `403` is sent to the frontend, causing the frontend SDK (pre-built UI SDK) to recheck the claims added on the frontend and navigate to the right screen.

</Tab>
<Tab value="go">

Referring once again to this [GitHub gist](https://gist.github.com/rishabhpoddar/8c26ed237add1a5b86481e72032abf8d), in `main.go`, between lines 32 and 44, the `st-ev` claim in the JWT payload undergoes verification. If the claim is not present or has a value of `false`, a `403` is sent to the frontend, causing the frontend SDK (pre-built UI SDK) to recheck the claims added on the frontend and navigate to the right screen.

</Tab>
<Tab value="java">

Referring once again to this [GitHub gist](https://gist.github.com/rishabhpoddar/5b2d19c02337ed7ee387723c84def9cd), in `JWTVerification.java`, between lines 42 and 58, the `st-ev` and `st-mfa` claims in the JWT payload undergo verification.
If the claims are not present or have a value of `false`, a `403` is sent to the frontend, causing the frontend SDK (pre-built UI SDK) to recheck the claims added on the frontend and navigate to the right screen.

</Tab>
</Tabs>

### Check for anti-csrf during authorization

:::important
You need to check for anti-cross-site request forgery (CSRF) for **non** GET requests when cookie-based authentication is active.
:::

Two methods exist for configuring [cross-site request forgery (CSRF) protection](/docs/post-authentication/session-management/security#anti-csrf): `VIA_CUSTOM_HEADER` and `VIA_TOKEN`.

####  `VIA_CUSTOM_HEADER` 

`VIA_CUSTOM_HEADER` is automatically set if `sameSite` is `none` or if your `apiDomain` and `websiteDomain` do not share the same top level domain.
In this case, you need to check for the presence of the `rid` header from incoming requests.

#### `VIA_TOKEN` 

When configured with `VIA_TOKEN`, an explicit `anti-csrf` token attaches as a header to requests with `anti-csrf` as the key.
To verify the `anti-csrf` token, you need to compare it to the value of the `antiCsrfToken` key from the payload of the decoded JWT.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Protect frontend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/additional-verification/session-verification/with-websocket" label="WebSockets authentication" />
  <ReferenceCard href="/docs/post-authentication/session-management/access-session-data" label="Access session data" />
</ReferenceCard.Grid>

# Additional Verification - Session Verification -  Protect frontend routes
Source: https://supertokens.com/docs/additional-verification/session-verification/protect-frontend-routes

Protect frontend routes by requiring user sessions and verifying session claims for access control.

## Before you start



---

<br />



<PrebuiltUIInstructions>

## Protect a route

<Tabs>
<Tab value="reactjs">

You can wrap your components with the `<SessionAuth>` react component.
This ensures that your component renders only if the user has logged in.
If they are not logged in, the user gets redirected to the login page.

```tsx 
// highlight-next-line 
// @ts-ignore

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        <Route path="/dashboard" element={
                            // highlight-start
                            <SessionAuth>
                                {/*Components that require to be protected by authentication*/}
                                <MyDashboardComponent />
                            </SessionAuth>
                            // highlight-end
                        } />
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}
```

### Optional session requirement

You can provide the `requireAuth={false}` prop when using `<SessionAuth>` as shown below:

```tsx 

class App extends React.Component {
    render() {
        return (
            <SuperTokensWrapper>
                <BrowserRouter>
                    <Routes>
                        <Route path="/dashboard" element={
                            // highlight-start
                            <SessionAuth requireAuth={false}>
                            // highlight-end
                                <MyDashboardComponent />
                            </SessionAuth>
                        } />
                    </Routes>
                </BrowserRouter>
            </SuperTokensWrapper>
        );
    }
}

// highlight-start
function MyDashboardComponent(props: any) {
    let sessionContext = Session.useSessionContext();

    if (sessionContext.loading) {
        return null;
    }

    if (sessionContext.doesSessionExist) {
        // TODO:
    } else {
        // TODO:
    }

    return null;
}
// highlight-end
```

</Tab>

<Tab value="angular">

You can use the `doesSessionExist` function to check if a session exists in all your routes.

```tsx

async function doesSessionExist() {
      if (await Session.doesSessionExist()) {
            // user is logged in
      } else {
            // user has not logged in yet
      }
}
```

</Tab>

</Tabs>

## Check the claims of a session

Sometimes, you may also want to check if there are certain claims in the session before granting access to a route.
For example, you may want to check that the session has the admin role claim for certain APIs, or that the user has completed 2FA.

You can achieve this using the session claims validator feature.
Let's take an example of using the user roles claim to check if the session has the admin claim:

<Tabs>
<Tab value="reactjs">

```tsx

const AdminRoute = (props: React.PropsWithChildren<any>) => {
    return (
        <SessionAuth 
            accessDeniedScreen={AccessDeniedScreen}
            overrideGlobalClaimValidators={(globalValidators) => [
                ...globalValidators, UserRoleClaim.validators.includes("admin"),
            ]
        }>
            {props.children}
        </SessionAuth>
    );
}

```
Above, you create a generic component called `AdminRoute`, which enforces that its child components render only if the user has the admin role.
In the `AdminRoute` component, the `SessionAuth` wrapper ensures that the session exists.
The `UserRoleClaim` validator is also added to the `<SessionAuth>` component, which checks if the validators pass or not.
If all validation passes, the `props.children` component renders.
If the claim validation has failed, it displays the `AccessDeniedScreen` component instead of rendering the children.
You can also pass your own custom component to the `accessDeniedScreen` prop.

:::note
You can extend the `AdminRoute` component to check for other types of validators as well.
You can then reuse this component to protect all your app's components (In this case, you may want to rename this component to something more appropriate, like `ProtectedRoute`).
:::

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx

function ProtectedComponent() {
    let claimValue = Session.useClaimValue(UserRoleClaim)
    if (claimValue.loading || !claimValue.doesSessionExist) {
        return null;
    }
    let roles = claimValue.value;
    if (Array.isArray(roles) && roles.includes("admin")) {
        // User is an admin
    } else {
        // User doesn't have any roles, or is not an admin..
    }
}
```

</Tab>

<Tab value="angular">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {

        // highlight-start
        let validationErrors = await Session.validateClaims({
            overrideGlobalClaimValidators: (globalValidators) =>
                [...globalValidators,
                    UserRoleClaim.validators.includes("admin"),
                 /* PermissionClaim.validators.includes("modify") */
                ]
        });
        // highlight-end

        if (validationErrors.length === 0) {
            // user is an admin
            return true;
        }

        for (const err of validationErrors) {
            if (err.id === UserRoleClaim.id) {
                // user roles claim check failed
            } else {
                // some other claim check failed (from the global validators list)
            }
        }
    }
    // either a session does not exist, or one of the validators failed.
    // so we do not allow access to this page.
    return false
}
```

- We call the `validateClaims` function with the `UserRoleClaim` validator which makes sure that the user has an `admin` role.
- The `globalValidators` represents other validators that apply to all calls to the `validateClaims` function. This may include a validator that enforces that you have verified the user's email (if enabled by you).
- We can also add a `PermissionClaim` validator to enforce a permission.

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        // highlight-start
        let roles = await Session.getClaimValue({claim: UserRoleClaim});
        if (Array.isArray(roles) && roles.includes("admin")) {
            // User is an admin
            return true;
        }
         // highlight-end
    }
    // either a session does not exist, or the user is not an admin
    return false
}
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

## Protect a route

You can use the `doesSessionExist` function to check if a session exists in all your routes.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function doesSessionExist() {
      if (await Session.doesSessionExist()) {
            // user is logged in
      } else {
            // user has not logged in yet
      }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function doesSessionExist() {
      if (await supertokensSession.doesSessionExist()) {
            // user is logged in
      } else {
            // user has not logged in yet
      }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function doesSessionExist() {
    if (await SuperTokens.doesSessionExist()) {
        // user is logged in
    } else {
        // user has not logged in yet
    }
}
```

</Tab>

<Tab value="android">

```kotlin
        if(accessTokenPayload != null) {
            // user is logged in
        } else {
            // user has not logged in yet
        }
    }
}
```

</Tab>

<Tab value="ios">

```swift

Future<void> doesSessionExist() async {
    var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();
    if (accessTokenPayload != null) {
       // user is logged in
    } else {
        // user has not logged in yet
    }
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

---

## Check the claims of a session

Sometimes, you may also want to check if there are certain claims in the session before granting access to a route.
For example, you may want to check that the session has the admin role claim for certain APIs, or that the user has completed 2FA.

You can achieve this using the session claims validator feature.
Let's take an example of using the user roles claim to check if the session has the admin claim:

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {

        // highlight-start
        let validationErrors = await Session.validateClaims({
            overrideGlobalClaimValidators: (globalValidators) =>
                [...globalValidators,
                    UserRoleClaim.validators.includes("admin"),
                 /* PermissionClaim.validators.includes("modify") */
                ]
        });
        // highlight-end

        if (validationErrors.length === 0) {
            // user is an admin
            return true;
        }

        for (const err of validationErrors) {
            if (err.id === UserRoleClaim.id) {
                // user roles claim check failed
            } else {
                // some other claim check failed (from the global validators list)
            }
        }
    }
    // either a session does not exist, or one of the validators failed.
    // so we do not allow access to this page.
    return false
}
```

- We call the `validateClaims` function with the `UserRoleClaim` validator which makes sure that the user has an `admin` role.
- The `globalValidators` represents other validators that apply to all calls to the `validateClaims` function.
This may include a validator that enforces that you have verified the user's email (if enabled by you).
- We can also add a `PermissionClaim` validator to enforce a permission.

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        // highlight-start
        let roles = await Session.getClaimValue({claim: UserRoleClaim});
        if (roles !== undefined && roles.includes("admin")) {
            // User is an admin
            return true;
        }
         // highlight-end
    }
    // either a session does not exist, or the user is not an admin
    return false
}
```

</Tab>
<Tab value="scripts">

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {

        // highlight-start
        let validationErrors = await supertokensSession.validateClaims({
            overrideGlobalClaimValidators: (globalValidators) =>
                [...globalValidators,
                    supertokensUserRoles.UserRoleClaim.validators.includes("admin"),
                 /* supertokensUserRoles.PermissionClaim.validators.includes("modify") */
                ]
        });
        // highlight-end

        if (validationErrors.length === 0) {
            // user is an admin
            return true;
        }

        for (const err of validationErrors) {
            if (err.id === supertokensUserRoles.UserRoleClaim.id) {
                // user roles claim check failed
            } else {
                // some other claim check failed (from the global validators list)
            }
        }
    }
    // either a session does not exist, or one of the validators failed.
    // so we do not allow access to this page.
    return false
}
```

- We call the `validateClaims` function with the `UserRoleClaim` validator which makes sure that the user has an `admin` role.
- The `globalValidators` represents other validators that apply to all calls to the `validateClaims` function. This may include a validator that enforces that you have verified the user's email (if enabled by you).
- We can also add a `PermissionClaim` validator to enforce a permission.

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {
        // highlight-start
        let roles = await supertokensSession.getClaimValue({claim: supertokensUserRoles.UserRoleClaim});
        if (roles !== undefined && roles.includes("admin")) {
            // User is an admin
            return true;
        }
         // highlight-end
    }
    // either a session does not exist, or the user is not an admin
    return false
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function getRole() {
    if (await SuperTokens.doesSessionExist()) {

        // highlight-start
        let roles: string[] = (await SuperTokens.getAccessTokenPayloadSecurely())["st-role"].v;

        if (roles.includes("admin")) {
            // TODO..
        } else {
            // TODO..
        }
        // highlight-end
    }
}
```

</Tab>

<Tab value="android">

```kotlin
        val roles: List<String> = (accessTokenPayload.get("st-role") as JSONObject).get("v") as List<String>;
        if (roles.contains("admin")) {
            // user is an admin
        } else {
            // user is not an admin
        }
    }
}
```

</Tab>

<Tab value="ios">

```swift

Future<void> checkIfUserIsAnAdmin() async {
    var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();

    if (accessTokenPayload.containsKey("st-role")) {
      Map<String, dynamic> roleObject = accessTokenPayload["st-role"];

      if (roleObject.containsKey("v")) {
        List<String> roles = roleObject["v"];

        if (roles.contains("admin")) {
          // user is an admin
        } else {
          // user is not an admin
        }
      }
    }
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

:::tip Feature
You can also [build your own custom claim validators](/docs/additional-verification/session-verification/claim-validation#using-session-claims) based on your app's requirements.
:::

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Protect backend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/additional-verification/session-verification/with-websocket" label="WebSockets authentication" />
  <ReferenceCard href="/docs/post-authentication/session-management/access-session-data" label="Access session data" />
</ReferenceCard.Grid>

# Additional Verification - Session Verification -  Session verification during server side rendering
Source: https://supertokens.com/docs/additional-verification/session-verification/ssr

## Overview

In Server Side Rendering (SSR) scenarios, the session verification process is slightly different.
Check the following guide to understand how to adjust the flow to work with SSR.

## Before you start

Getting access to the session during server side rendering is only possible using cookie-based sessions.
This is the default setting, but you have to keep this in mind if you want to switch to header-based sessions.



## Steps

### 1. Enable sharing of cookies across sub domains

If your API layer and website are on different sub domains (like `example.com` and `api.example.com`), then by default, the session tokens attach only to `api.example.com`.
Change this to ensure that the session tokens attach to `.example.com` and the access token cookie goes to your web server on `example.com`.
Enable this by [setting the `cookieDomain` configuration on the backend](/docs/post-authentication/session-management/advanced-workflows/multiple-api-endpoints).

### 2. Do JWT verification

Follow the [JWT verification guide](/docs/additional-verification/session-verification/protect-api-routes#using-a-jwt-verification-library) to verify the JWT on the server side.
You can read the JWT from the `sAccessToken` cookie in the request object.
If the JWT is missing, invalid, or expired, redirect the user to a `/refresh-session?redirectBack=<current route>` page. You can have any path for this since it's your website.

On the `/refresh-session` page, you want to call the `attemptRefreshingSession` function (from the client side).
This function attempts to refresh the session.
If it succeeds, it returns `true`.
If it fails, it returns `false`.
If it returns `true`, you want to redirect the user back to the page they were on.
If it returns `false`, you want to redirect the user to the login page.

### 3. Implement the refresh session flow (`/refresh-session` page)

On this path, attempt refreshing the session which can yield:
- Success: The frontend gets new access and refresh tokens.
Post this, redirect the user to the path mentioned on the `redirectBack` query parameter.
- Failure: This would happen if the session has expired or the backend has revoked it.
Either way, you want to redirect the user to the login page.

Below is the code snippet that you can use on the `/refresh-session` path on the frontend



<PrebuiltUIInstructions>

<Tabs>
<Tab value="reactjs">

```tsx

export function AttemptRefresh(props: any) {
    React.useEffect(() => {
        let cancel = false;
        Session.attemptRefreshingSession().then(success => {
            if (cancel) {
                // component has unmounted somehow..
                return;
            }
            if (success) {
                // we have new session tokens, so we redirect the user back
                // to where they were.
                const urlParams = new URLSearchParams(window.location.search);
                window.location.href = urlParams.get('redirectBack')!;
            } else {
                // we redirect to the login page since the user
                // is now logged out
                SuperTokens.redirectToAuth();
            }
        })
        return () => {
            cancel = true;
        }
    }, []);
    return null;
}
```

</Tab>

<Tab value="angular">

```tsx

function attemptRefresh() {
    Session.attemptRefreshingSession().then(success => {
        if (success) {
            // we have new session tokens, so we redirect the user back
            // to where they were.
            const urlParams = new URLSearchParams(window.location.search);
            window.location.href = urlParams.get('redirectBack')!;
        } else {
            // we redirect to the login page since the user
            // is now logged out
            window.location.href = "/login"
        }
    })
}
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

function attemptRefresh() {
    Session.attemptRefreshingSession().then(success => {
        if (success) {
            // we have new session tokens, so we redirect the user back
            // to where they were.
            const urlParams = new URLSearchParams(window.location.search);
            window.location.href = urlParams.get('redirectBack')!;
        } else {
            // we redirect to the login page since the user
            // is now logged out
            window.location.href = "/login"
        }
    })
}
```

</Tab>
<Tab value="scripts">

```tsx
function attemptRefresh() {
    supertokensSession.attemptRefreshingSession().then(success => {
        if (success) {
            // we have new session tokens, so we redirect the user back
            // to where they were.
            const urlParams = new URLSearchParams(window.location.search);
            window.location.href = urlParams.get('redirectBack')!;
        } else {
            // we redirect to the login page since the user
            // is now logged out
            window.location.href = "/login"
        }
    })
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

:::caution
Server side rendering is not applicable for mobile apps.
:::

</Tab>

</Tabs>

</CustomUIInstructions>

#### Why trigger the refresh session flow instead of redirecting the user to the login page directly?

Two reasons why JWT verification can fail are:
- The session tokens were not passed from the frontend: This can happen if the route is accessed when the user has logged out.
- The session tokens pass from the frontend, but the JWT has expired.

If the user goes to the login page directly, then in the second case, the frontend redirects the user back to the current route (since the refresh token is still valid), causing an infinite loop.
To counteract this issue, redirect the user to a refresh page, which creates a new access token.
In the first case, when the user is actually logged out, the refreshing fails, and they go to the login page anyway.

#### Can `verifySession` or `getSession` replace manual JWT verification?

Yes, you can, but it is not recommended because:
- Often the web server is on a different process than the API server.
Using the backend SDK requires you to give it the credentials to the SuperTokens core, which you might not want to provide to the web server.
- The `session` object resulting from `verifySession` and `getSession` makes it easy to mutate the access token payload.
These mutations reflect on the frontend via network interceptors from the frontend SDK.
In SSR, the browser makes the call to your web server directly, and the frontend SDK interceptors don't run.
This can cause inconsistency between the access token payload as seen on the frontend vs the backend.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Protect backend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Protect frontend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/post-authentication/session-management/access-session-data" label="Access session data" />
</ReferenceCard.Grid>

# Additional Verification - Session Verification -  WebSocket Session Verification
Source: https://supertokens.com/docs/additional-verification/session-verification/with-websocket

## Overview

Socket connections do not always use HTTP, which means you cannot use cookies or HTTP authorization header here.
Instead, the frontend must fetch the JWT and send it at the start of the socket connection.

## Before you start



## Steps

### 1. Expose the JWT to the frontend

Ensure that the JWT is available to the frontend.
This is already the case in header based auth, but if you are using cookie based auth, then you should set the following boolean to true in `session.init` on the backend:

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            exposeAccessTokenToFrontendInCookieBasedAuth: true
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

```tsx
declare let io: any; // REMOVE_FROM_OUTPUT

async function initSocketConnection() {
    const token = await Session.getAccessToken();
    if (token === undefined) {
        throw new Error("User is not logged in");
    }
    const socket = io.connect('http://localhost:3000', {
        query: { token }
    });
    return socket;
}
```

- See the [docs on how to fetch the access token on the frontend for all frameworks](/docs/post-authentication/session-management/access-session-data#on-the-frontend) if needed.
- The `Session.getAccessToken()` function auto refreshes the session before returning the JWT if needed.

:::caution
Make sure to close the socket connection whenever appropriate to avoid sending stale JWTs.
:::

### 3. Verify the JWT

Verify the JWT on socket connection initialisation on the backend:



```tsx
declare let io: any // REMOVE_FROM_OUTPUT

// functions to fetch jwks
var client = jwksClient({
  jwksUri: '<API_DOMAIN><API_BASE_PATH>/jwt/jwks.json'
});

function getKey(header: JwtHeader, callback: SigningKeyCallback) {
  client.getSigningKey(header.kid, function (err, key) {
    var signingKey = key!.getPublicKey();
    callback(err, signingKey);
  });
}

// socket io connection
io.use(function (socket: any, next: any) {
  // highlight-start
  // we first try and verify the jwt from the token param.
  if (socket.handshake.query && socket.handshake.query.token) {
    jwt.verify(socket.handshake.query.token, getKey, {}, function (err, decoded) {
      if (err) return next(new Error('Authentication error'));
      socket.decoded = decoded;
      next();
    });
  }
  else {
    next(new Error('Authentication error'));
  }
  // highlight-end  
})
  .on('connection', function (socket: any) {
    // Connection now authenticated to receive further events

    socket.on('message', function (message: string) {
      io.emit('message', message);
    });
  });
```

:::important
Post verification, ensure that the claims in the JWT align with your authorization rules.

For example, if your app requires that the user verifies their email before they use it, check that the `decoded["st-ev"].v` claim in the JWT equals `true`.

Normally, the backend SDK's `getSession` or `verifySession` function performs this check for you based on your configuration. However, since JWT verification is happening manually here, you need to do those checks yourself.
:::

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Protect backend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Protect frontend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/post-authentication/session-management/access-session-data" label="Access session data" />
</ReferenceCard.Grid>

# Additional Verification - Session Verification -  Claim validation
Source: https://supertokens.com/docs/additional-verification/session-verification/claim-validation

## Overview

**SuperTokens** provides two approaches for managing access control: 

1. **Session Claims**: An abstraction that includes automatic validation and refresh capabilities
2. **Access Token Payload**: A basic way to check the token payload

In most of the cases the recommended way is to use session claims.
You can use next table to understand the differences between the two approaches.

| Feature                              | Session Claims | Access Token Payload |
| ------------------------------------ | -------------- | -------------------- |
| Store simple static data             | ✅             | ✅                   |
| Built-in validation                  | ✅             | ❌                   |
| Automatic refresh mechanism          | ✅             | ❌                   |
| Graceful validation failure handling | ✅             | ❌                   |
| Lightweight implementation           | ❌             | ✅                   |
| No validation overhead               | ❌             | ✅                   |

This guide shows you how to use each method.

## References

<Accordion px="4">

## Session Claim

### Session claim interface

```tsx

type JSONObject = any; // REMOVE_FROM_OUTPUT
interface SessionClaim<T> {
    // Unique identifier for the claim.
    // For a `boolean` claim (for example if the email is verified or not), this would be a string like `"st-ev"`.
    readonly key: string;

    /**
     * Fetches the current value of this claim for the user.
     * The undefined return value signifies that we don't want to update the claim payload and or the claim value is not present in the database
     * This can happen for example with a second factor auth claim, where we don't want to add the claim to the session automatically.
     */
    fetchValue(
        userId: string,
        recipeUserId: RecipeUserId,
        tenantId: string,
        currentPayload: JSONObject | undefined,
        // @ts-expect-error
        userContext: UserContext
    ): Promise<T | undefined> | T | undefined;

    /**
     * Removes the claim from the payload, by cloning and updating the entire object.
     *
     * @returns The modified payload object
     */
     // @ts-expect-error
    removeFromPayload(payload: JSONObject, userContext: UserContext): JSONObject;

    /**
     * Gets the value of the claim stored in the payload
     *
     * @returns Claim value
     */
     // @ts-expect-error
    getValueFromPayload(payload: JSONObject, userContext: UserContext): T | undefined;
}
```

The SDK provides a few base claim classes which make it easy for you to implement your own claims:
- [`PrimitiveClaim`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveClaim.ts): Use this to add any primitive type value (`boolean`, `string`, `number`) to the session payload.
- [`PrimitiveArrayClaim`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts): Use this to add any primitive array type value (`boolean[]`, `string[]`, `number[]`) to the session payload.
- [`BooleanClaim`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/booleanClaim.ts): A special case of the `PrimitiveClaim`, used to add a `boolean` type claim.

All the recipe claims are built around these primitives:
- [`EmailVerificationClaim`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/emailverification/emailVerificationClaim.ts): This stores information about whether the user has verified their email.
- [`RolesClaim`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/userroles/userRoleClaim.ts): This stores the list of roles associated with a user.
- [`PermissionClaim`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/userroles/permissionClaim.ts): This stores the list of permissions associated with the user.

#### On the frontend

Like the backend, the frontend also has the concept of session claim objects which need to conform to the following interface:

```tsx
type SessionClaim<T> = {
    // Refresh the claim values based on an async API call
    refresh(): Promise<void>;

    // Returns the value from the session claim
    getValueFromPayload(payload: any): T | undefined;
    
    // Returns the last time the claim was refreshed
    getLastFetchedTime(payload: any): number | undefined;
};
```

When used, these objects provide a way for the SuperTokens SDK to update the claim values when needed.
For example, in the built-in email verification claim, the `refresh` function calls the backend API to check if the email has verification. That API in turn updates the session claim to reflect the email verification status. This way, even if the system marked the email as verified in offline mode, the frontend can get the email verification status update automatically.

Like the backend SDK, the frontend SDK also exposes a few base claims:
- [`BooleanClaim`](https://github.com/supertokens/supertokens-website/blob/master/lib/ts/claims/booleanClaim.ts)
- [`PrimitiveClaim`](https://github.com/supertokens/supertokens-website/blob/master/lib/ts/claims/primitiveClaim.ts)
- [`PrimitiveArrayClaim`](https://github.com/supertokens/supertokens-website/blob/master/lib/ts/claims/primitiveArrayClaim.ts)

## Claim Validator

Once you add a claim to the session, specify the checks that need to run on them during session verification. For example, if an API should allow access only to `admin` roles, there must be a way to tell SuperTokens to do that check. This is where claim validators come into the picture. Here is the shape for a claim validator object:

```tsx
type SessionClaim<T> = any; // REMOVE_FROM_OUTPUT
type SessionClaimValidator = {
    // Identifies the session claim validator
    // Used to know which validator failed in case multiple of them undergo checking at the same time. 
    // The value of this is typically the same as the claim object's `key`, but you can set it to anything else.
    id: string;

    // A reference to the claim object that's associated with this validator.
    claim: SessionClaim<any>;

    // Determines if the value of the claim should undergo fetching again.
    // In the built-in validators, this function typically returns `true` if the claim does not exist in the `payload`, or if it's too old. 
    shouldRefetch: (payload: any, userContext: any) => Promise<boolean>;

    /** extracts the claim value from the input `payload` (typically using `claim.getValueFromPayload`), and determines if the validator check has passed or not.
    * For example, if the validator aims to enforce that the user has verified their email, and if the claim value is `false`, then this function would return:
    * {
    *  isValid: false,
    *    reason: {
    *      message: "wrong value",
    *      expectedValue: true,
    *      actualValue: false
    *    }
    *  }
    */
    validate: (payload: any, userContext: any) => Promise<ClaimValidationResult>;
};

type ClaimValidationResult = { isValid: true } | { isValid: false; reason?: any };
```

Using this interface and the claims interface, SuperTokens runs the following session claim validation process during session verification:

```tsx
// @ts-nocheck
function validateSessionClaims(accessToken, claimValidators) {
    payload = accessToken.getPayload();
    
    // Step 1: refetch claims if required
    for(validator in claimValidators) {
        if (validator.shouldRefetch(payload)) {
            claimValue = validator.claim.fetchValue(accessToken.sub)
            payload = validator.claim.addToPayload_internal(payload, claimValue) 
        }
    }

    failedClaims = []

    // Step 2: Validate all claims
    for(validator in claimValidators) {
        validationResult = validator.validate(payload)
        if (!validationResult.isValid) {
            failedClaims.push({id: validator.id, reason: validationResult.reason})
        }
    }

    return failedClaims
}
```

The built-in base claims (`PrimitiveClaim`, `PrimitiveArrayClaim`, `BooleanClaim`) all expose a set of useful validators:

- [`PrimitiveClaim.validators.hasValue(val, maxAgeInSeconds?)`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveClaim.ts#L50): This function call returns a validator object that enforces that the session claim has the specified `val`.

- [`PrimitiveArrayClaim.validators.includes(val, maxAgeInSeconds?)`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts#L50): This checks if the the session claims value, which is an array, includes the input `val`.

- [`PrimitiveArrayClaim.validators.excludes(val, maxAgeInSeconds?)`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts#L91): This checks if the the session claims value, which is an array, excludes the input `val`.

- [`PrimitiveArrayClaim.validators.includesAll(val[], maxAgeInSeconds?)`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts#L136): This checks if the session claims value, which is an array, includes all the items in the input `val[]`.

- [`PrimitiveArrayClaim.validators.excludesAll(val[], maxAgeInSeconds?)`](https://github.com/supertokens/supertokens-node/blob/master/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts#L178): This checks if the session claims value, which is an array, excludes all the items in the input `val[]`.

In all the above claim validators, the `maxAgeInSeconds`/`maxAge` input (which is optional) governs how often to refetch the session claim value:
- A value of `0` causes it to refetch the claim value each time a check happens.
- If not passed, the claim is only refetched if it's missing in the session. The built-in claims like email verification or user roles claims have a default value of five minutes, meaning that those claim values refresh from the database after every five minutes.

```tsx
interface SessionClaim<T> {
  readonly key: string;
  fetchValue(userId: string, userContext: any): Promise<T | undefined>;
  addToPayload(payload: any, value: T): any;
  getValueFromPayload(payload: any): T | undefined;
}
```

</Accordion>

## Before you start



---

## Using session claims

SuperTokens sessions have a property called `accessTokenPayload`.
This is a `JSON` object which you can access on the frontend and backend.
The key-values in this JSON payload refer to **claims**.

### 1. Create a custom claim

```tsx

const SecondFactorClaim = new BooleanClaim({
  key: "2fa-completed",
  fetchValue: () => false,
});
```

### 2. Add claim validators

#### Backend global validation

```tsx

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    Session.init({
      override: {
        functions: (originalImplementation) => {
          return {
            ...originalImplementation,
            getGlobalClaimValidators: async function (input) {
              // @ts-expect-error
              return [...input.claimValidatorsAddedByOtherRecipes, SecondFactorClaim.validators.isTrue()];
            },
          };
        },
      },
    }),
  ],
});
```

#### Backend route-specific validation

```tsx

let app = express();

app.post(
  "/admin-only",
  verifySession({
    overrideGlobalClaimValidators: async (globalValidators) => [
      ...globalValidators,
      UserRoleClaim.validators.includes("admin"),
    ],
  }),
  async (req, res) => {
    // Only admin users can access this endpoint
  },
);
```

#### Frontend validation

```tsx

const AdminRoute = (props: React.PropsWithChildren<any>) => {
  return (
    <SessionAuth
      overrideGlobalClaimValidators={(globalValidators) => [
        ...globalValidators,
        UserRoleClaim.validators.includes("admin"),
      ]}
    >
      {props.children}
    </SessionAuth>
  );
};
```

### 3. Handle validation failures

#### Backend custom error handling

```tsx

// @ts-expect-error
if (roles === undefined || !roles.includes("admin")) {
  throw new STError({
    type: "INVALID_CLAIMS",
    message: "User is not an admin",
    payload: [
      {
        id: UserRoleClaim.key,
      },
    ],
  });
}
```

#### Frontend redirection

```tsx

const AdminRoute = (props: React.PropsWithChildren<any>) => {
  return (
    <SessionAuth
      overrideGlobalClaimValidators={(globalValidators) => [
        ...globalValidators,
        {
          ...UserRoleClaim.validators.includes("admin"),
          onFailureRedirection: () => "/not-an-admin",
        },
      ]}
    >
      {props.children}
    </SessionAuth>
  );
};
```

--- 

## Using the Access Token Payload

The access token payload is a simple way to store custom data that needs to be accessible on both the frontend and the backend.

### 1. Add Custom Claims to the Access Token Payload

:::important
The access token payload has a set of default claims that can not be overwritten.
They reserve these for standard or SuperTokens specific use-cases.
Those claims are: `sub`, `iat`, `exp`, `sessionHandle`, `refreshTokenHash1`, `parentRefreshTokenHash1`, `antiCsrfToken`

Trying to overwrite these values results in errors in the authentication flow process.
:::

You can add custom claims to the access token payload in two ways:

#### During session creation

```tsx

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    Session.init({
      override: {
        functions: (originalImplementation) => {
          return {
            ...originalImplementation,
            createNewSession: async function (input) {
              let userId = input.userId;

              // This goes in the access token, and is available to read on the frontend.
              input.accessTokenPayload = {
                ...input.accessTokenPayload,
                someKey: "someValue",
              };

              return originalImplementation.createNewSession(input);
            },
          };
        },
      },
    }),
  ],
});
```

#### Post Session Creation

```tsx

let app = express();

app.post("/updateinfo", verifySession(), async (req: SessionRequest, res) => {
  let session = req.session;
  await session!.mergeIntoAccessTokenPayload({ newKey: "newValue" });
  res.json({ message: "successfully updated access token payload" });
});
```

### 2. Read the Access Token Payload

#### On the backend

```tsx

let app = express();

app.get("/myApi", verifySession(), async (req, res) => {
  let session = req.session;
  let accessTokenPayload = session.getAccessTokenPayload();
  let customClaimValue = accessTokenPayload.customClaim;
});
```

#### On the frontend

```tsx

async function someFunc() {
  if (await Session.doesSessionExist()) {
    let accessTokenPayload = await Session.getAccessTokenPayloadSecurely();
    let customClaimValue = accessTokenPayload.customClaim;
  }
}

```

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Protect Backend Routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Protect Frontend Routes" />
  <ReferenceCard href="/docs/additional-verification/user-roles/protecting-routes" label="User Roles" />
  <ReferenceCard href="/docs/additional-verification/session-verification/with-websocket" label="WebSockets authentication" />
  <ReferenceCard href="/docs/post-authentication/session-management/access-session-data" label="Access session data" />
</ReferenceCard.Grid>

# Additional Verification - Multi Factor Authentication -  Important concepts
Source: https://supertokens.com/docs/additional-verification/mfa/important-concepts

## Overview

If you are new to Multi-factor authentication, MFA, this page provides a quick summary of how it works and the main terminology used in it.

MFA enhances security by requiring users to authenticate through:

<Steps>

## **Initial login**

  The user enters their primary credentials, typically a username and password (first factor).
  
## **Authentication challenge**

Upon successful entry of the primary credentials, the user receives an authentication challenge, prompting them to provide a secondary factor, such as an OTP or biometric verification.

## **Access granted** 

Access to the account or service is only granted when both the primary and secondary factors are successfully verified.

</Steps>

This layered approach reduces the risk of unauthorized access, as an attacker would need to compromise multiple authentication methods to gain access.

## Terminology

### Authentication challenge

An authentication challenge is a prompt that requires the user to provide additional credentials beyond the primary factor to verify their identity.
This typically involves requesting a secondary factor, such as entering an OTP received via SMS/email or approving a push notification from an authenticator app.
Authentication challenges are crucial in detecting and preventing unauthorized access by requiring proof of possession or identity beyond a password.

### Factors

Factors refer to the different categories of credentials used in MFA:
- **Something You Know**: Information only the user knows, such as a password or personal identification number (`PIN`).
- **Something You Have**: A physical item the user possesses, such as a smartphone or hardware token used for generating one-time passwords (OTPs).
- **Something You Are**: Biometric characteristics unique to the user, such as fingerprints, facial recognition, or voice patterns.

Each auth challenge has a factor ID in SuperTokens:

| Authentication Type | Factor ID |
|-------------------|-----------|
| Email password auth | `emailpassword` |
| Social login / enterprise SSO auth | `thirdparty` |
| Passwordless - Email OTP | `otp-email` |
| Passwordless - SMS OTP | `otp-phone` |
| Passwordless - Email magic link | `link-email` |
| Passwordless - SMS magic link | `link-phone` |
| TOTP | `totp` |
| WebAuthn/Passkeys | `webauthn` |

These factor IDs get used to configure the MFA requirements for users (except the `acccess-denied` one). 
They are also used to indicate which authentication challenges have completed in the current session.

#### Factor completion status 

You can determine the status of the authentication factors by checking the session's access token payload.
In the payload you can find the following claim structure: 

```json
{
    "st-mfa": {
        // c stands for completed, and 
        // Shows that only the emailpassword factor has been completed
        "c": {
            // the timestamp when the factor was completed
            "emailpassword": 1702877939,
        },
        // v stands for value
        // In this example, the false value indicates that the MFA flow is not completed  
        // Once the second factor is finalized v will change to true  
        "v": false
    }
}
```

Each time an authentication factor completes, the SuperTokens backend adds it to the `c` (completed) object, and then re-evaluates the `v` boolean based on the MFA requirements for the user.

### First factor vs. secondary factor

- **First Factor**: The primary authentication method, traditionally a password or `PIN`.
This is the initial layer of security in the authentication process.
  
- **Secondary Factor**: An additional security layer that complements the first factor.
Common secondary factors include OTPs sent via email/SMS, authenticator apps like Google Authenticator, or biometric data.
Secondary factors enhance security by adding an extra step to the verification process.

A clear distinction exists between first and additional factors in the SDK.
When you call `MFA.init` on the backend, you need to provide a list of allowed first factors. If using multi-tenancy, you can configure the first factors on a per-tenant basis and leave the `init` array empty.

The first factors are those allowed to create a new session, whereas any other factor can only modify an existing session.
In case the user calls an additional factor's API without a session, the API responds with a `401` error.

### Account linking

Account linking refers to the process of connecting multiple accounts or identities across platforms or services.
In the context of MFA, account linking ensures that a user's secondary authentication factors (for example, an authenticator app or backup method) are correctly associated with their primary account.
This is crucial for streamlined access and maintaining secure authentication across different services without the need to set up separate MFA methods for each account.

#### The relation between account linking and MFA

During account linking, the individual login methods create their own "recipe user", and each recipe user links to another recipe user to create one primary user.
Theoretically, one can link any recipe user to another (there is no need for them to have the same email or phone number).
However, for first factor automatic linking, only link login methods if they have been verified and have the same email.

From an MFA point of view, whenever the user sets up a new passwordless factor (otp-email or otp-sms), this creates a new recipe user for the passwordless recipe. It then auto-links it to the existing session's recipe user.
Therefore, it is necessary to enable account linking for MFA to work.
In the MFA guide, first factor account linking is not enabled, but you can enable that by following the automatic account linking guide in other parts of the docs.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/mfa/initial-setup" label="MFA Initial Setup" />
  <ReferenceCard href="/docs/additional-verification/mfa/email-sms-otp/otp-for-all-users" label="Email & SMS OTP for MFA" />
  <ReferenceCard href="/docs/additional-verification/mfa/totp/totp-for-all-users" label="TOTP for MFA" />
  <ReferenceCard href="/docs/additional-verification/mfa/step-up-auth" label="Step-up Authentication" />
  <ReferenceCard href="/docs/additional-verification/mfa/protect-routes" label="Protect Routes with MFA" />
</ReferenceCard.Grid>

# Additional Verification - Multi Factor Authentication -  Initial setup
Source: https://supertokens.com/docs/additional-verification/mfa/initial-setup

## Overview

To integrate multi-factor authentication, MFA, in your application, you first need to decide on what factors you want to support and when to ask for them.
The following guide shows you how to implement a basic setup while also covering customization methods.

## Before you start



These instructions assume that you already have some knowledge of MFA.
If you are not familiar with terms like authentication factors and challenges, please go through the [MFA concepts page](/docs/additional-verification/mfa/important-concepts).

If you plan to use the `otp-email` factor as a form of email verification, you also need to initialize the `emailverification` recipe in `REQUIRED` mode on the backend.
This configuration ensures that the email verification process passes only if the originally provided email has been verified.

## Steps

<TenantType.Switch />

### 1. Set up the backend 

#### 1.1 Enable account linking

MFA requires account linking to be active. You can enable it in the following way:

<Tabs>
<Tab value="nodejs">

```ts

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        // highlight-start
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import accountlinking
from supertokens_python.types import User
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import AccountInfoWithRecipeIdAndUserId, ShouldNotAutomaticallyLink, ShouldAutomaticallyLink
from typing import Dict, Any, Optional, Union

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any]
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()
    
    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the 
        # account_info to the session user, which means it's an MFA flow, so we enable 
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)
    
    return ShouldNotAutomaticallyLink()

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework='...', # type: ignore
    recipe_list=[
        accountlinking.init(should_do_automatic_account_linking=should_do_automatic_account_linking)
    ],
)
```

</Tab>
</Tabs>

- The above snippet enables auto account linking only during the second factor and not for the first factor login. This means that if a user has an email password account, and then they login via Google (with the same email), those two accounts are not linked. However, if the second factor for logging in is email or phone OTP, then that passwordless account links to the first factor login method of that session.
- Notice that `shouldRequireVerification: false` configures account linking. It means that the second factor can connect to the first factor even though the first factor is not verified. If you want to do email verification of the first factor before setting up the second factor (for example if the first factor is email password, and the second is phone OTP), then you can set this boolean to `true`, and also init the email verification recipe on the frontend and backend in `REQUIRED` mode.
- If you also want to enable first factor automatic account linking, see [this link](/docs/post-authentication/account-linking/automatic-account-linking).

:::important
Account linking is a paid feature, and you need to generate a license key to enable it. Enabling the MFA feature also enables account linking automatically, meaning you don't need to check the account linking feature.
:::

#### 1.2 Configure the first factors

<TenantType.SingleTenantContent>

We start by initializing the MFA recipe on the backend and specifying the list of first factors using their [factor IDs](/docs/additional-verification/mfa/important-concepts#factors). You still have to initialize all the auth recipes in the `recipeList`, and configure them based on your needs.

For example, the code below initializes `thirdparty`, `emailpassword` and `passwordless` recipes and sets the `firstFactor` array to be `["emailpassword", "thirdparty"]`. This means that email password and social login appear to the user as the first factor (using the `thirdparty` + `emailpassword` recipe), and `passwordless` serves as the second factor.

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        // highlight-start
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE"
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import emailpassword, multifactorauth, thirdparty, passwordless
from supertokens_python.recipe.passwordless import ContactEmailOnlyConfig
from supertokens_python.recipe.multifactorauth.types import FactorIds

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework='...', # type: ignore
    recipe_list=[
        emailpassword.init(),
        thirdparty.init(),
        multifactorauth.init(),
        passwordless.init(contact_config=ContactEmailOnlyConfig(), flow_type="USER_INPUT_CODE"),
        multifactorauth.init(first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY])
    ],
)
```

</Tab>
</Tabs>

Other combinations of first factors exists. For example, if you want passwordless as the first factor, then you would init the passwordless recipe and add `"passwordless"` in the `firstFactors` array.

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

For a multi-tenancy setup, where each tenant can have a different set of first factors, you can leave the `firstFactors` array as `undefined` in the `MultiFactorAuth.init`. Configure the `firstFactors` on a per-tenant basis when creating or updating a tenant as shown below:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: [MultiFactorAuth.FactorIds.EMAILPASSWORD]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

`firstFactors` includes only `"emailpassword"`. This means that users who login to this tenant can only use email password as the first factor. Later on, the configuration for passwordless as a second factor for this tenant appears.

:::important
- If you do not configure `firstFactors` array on a tenant configuration, then no factors activate for that tenant by default.
- To remove the `firstFactors` configuration for a tenant, you can pass a `null` value for the `firstFactors` key in the tenant configuration. For that tenant, this makes SuperTokens default to the `firstFactors` array in the `MultiFactorAuth.init` from the backend `init` configuration.
:::

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def create_new_tenant():
    resp = await create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(first_factors=[FactorIds.EMAILPASSWORD])
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

def create_new_tenant():
    resp = create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(first_factors=[FactorIds.EMAILPASSWORD])
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash showAppTypeSelect
curl --location --request PUT 'http://localhost:3567/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "customer1",
    "firstFactors": ["emailpassword"]
}'
```

`firstFactors` includes only `"emailpassword"`. This means that users who login to this tenant can only use email password as the first factor. Later on, the configuration for passwordless as a second factor for this tenant appears.

:::important
- If you do not configure `firstFactors` array on a tenant configuration, then no factors activate for that tenant by default.
- To remove the `firstFactors` configuration for a tenant, you can pass a `null` value for the `firstFactors` key in the tenant configuration. For that tenant, this makes SuperTokens default to the `firstFactors` array in the `MultiFactorAuth.init` from the backend `init` configuration.
:::

</Tab>

<Tab value="dashboard" className="tab-with-background">

<img src="/img/dashboard/tenant-management/ep-enabled.png" alt="Email Password enabled"/>

In the above setting, Email Password is active in the **Login Methods** section. This means that users who login to this tenant can only use email password as the first factor. Later on, the configuration for passwordless as a second factor for this tenant appears.

By default, no login methods activate for a tenant.

</Tab>

</Tabs>

</TenantType.MultiTenantContent>

#### 1.3 Configure the second factor

This section explains how to configure SuperTokens such that a second factor is necessary for all users during sign up and during sign in. TOTP serves as an example for the second factor.

<TenantType.SingleTenantContent>

The following code snippet accomplishes this:

<Tabs>
<Tab value="nodejs">

```ts

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE"
        }),
        totp.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            return [MultiFactorAuth.FactorIds.TOTP]
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import (
    emailpassword,
    multifactorauth,
    thirdparty,
    passwordless,
)
from supertokens_python.recipe.passwordless import ContactEmailOnlyConfig
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.types import User
from supertokens_python.recipe.multifactorauth.types import MFARequirementList

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        return [FactorIds.TOTP]

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(),
        thirdparty.init(),
        multifactorauth.init(),
        passwordless.init(
            contact_config=ContactEmailOnlyConfig(), flow_type="USER_INPUT_CODE"
        ),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

In the above snippet, you configure email password and social login as the first factor, followed by TOTP as the second factor.

After sign in or sign up, SuperTokens calls the `getMFARequirementsForAuth` function to get a list of secondary factors for the user. The returned value determines the boolean value of `v` that's stored in the session's access token payload. If the returned factor is already completed (it's in the `c` object of the session's payload), then the value of `v` is `true`, else `false`.

In the above example, `"totp"` returns as a required factor for all users. However, you can also dynamically decide which factor to return based on the `input` arguments, which contains the `User` object, the `tenantId`, and the current session's access token payload. The default implementation of `getMFARequirementsForAuth` returns the set of factors specifically enabled for this user (see next section) or for the tenant (see later section).

The output of this function can be more complex than a `string[]`. You can also return an object which tells SuperTokens that any one of the factors must satisfy: 

<Accordion>

## Require one of multiple factors

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            // highlight-start
                            return [{
                                oneOf: [
                                    MultiFactorAuth.FactorIds.TOTP,
                                    MultiFactorAuth.FactorIds.OTP_EMAIL
                                ]
                            }]
                            // highlight-end
                        }
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.types import User
from supertokens_python.recipe.multifactorauth.types import MFARequirementList

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # highlight-next-line
        return [FactorIds.TOTP, FactorIds.OTP_EMAIL]

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

## Require multiple factors in any order

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            // highlight-start
                            return [{
                                allOfInAnyOrder: [
                                    MultiFactorAuth.FactorIds.TOTP,
                                    MultiFactorAuth.FactorIds.OTP_EMAIL
                                ]
                            }]
                            // highlight-end
                        }
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.types import User
from supertokens_python.recipe.multifactorauth.types import MFARequirementList

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # highlight-next-line
        return [{"allOfInAnyOrder": [FactorIds.TOTP, FactorIds.OTP_EMAIL]}]

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

## Require multiple factors in a specific order

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            // highlight-start
                            let currentCompletedFactors = MultiFactorAuth.MultiFactorAuthClaim.getValueFromPayload(input.accessTokenPayload)
                            if (MultiFactorAuth.FactorIds.TOTP in currentCompletedFactors.c) {
                                // this means the totp factor is completed
                                return [MultiFactorAuth.FactorIds.OTP_EMAIL]
                            } else {
                                // this means we have not finished totp yet, and we want 
                                // to do that right after first factor login
                                return [MultiFactorAuth.FactorIds.TOTP]
                            }
                            // highlight-end
                        }
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.types import User
from supertokens_python.recipe.multifactorauth.types import MFARequirementList
from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import (
    MultiFactorAuthClaim,
)

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # highlight-start
        current_completed_factors = MultiFactorAuthClaim.get_value_from_payload(
            access_token_payload
        )
        if current_completed_factors and FactorIds.TOTP in current_completed_factors.c:
            # this means the totp factor is completed
            return [FactorIds.OTP_EMAIL]
        else:
            # this means we have not finished totp yet, and we want
            # to do that right after first factor login
            return [FactorIds.TOTP]
        # highlight-end

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

</Accordion>

<br />

:::note no-title
You can return an empty array from `getMFARequirementsForAuth` if you don't want any further MFA done for the current user.
:::

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

For a multi tenant setup, you can configure a list of secondary factors when creating / modifying a tenant as shown below:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>

<Tab value="nodejs">

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: [MultiFactorAuth.FactorIds.EMAILPASSWORD],
        requiredSecondaryFactors: [MultiFactorAuth.FactorIds.OTP_EMAIL]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

In the above code, you add a property called `requiredSecondaryFactors` for a tenant whose value is a `string[]`. You add `otp-email` as a factor ID above which means that all users who log into that tenant must complete `otp-email` as a second factor.

To remove the `requiredSecondaryFactors` configuration for a tenant, you can pass a `null` value for the `requiredSecondaryFactors` key in the tenant configuration.

If you add more than one item in this array, it means that the user must complete any one of factors mentioned in the array. If you want to have a different behavior for the tenant, you can achieve that by overriding the `getMFARequirementsForAuth` function as shown below:

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def create_new_tenant():
    resp = await create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD],
            required_secondary_factors=[FactorIds.OTP_EMAIL],
        )
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

def create_new_tenant():
    resp = create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD],
            required_secondary_factors=[FactorIds.OTP_EMAIL],
        )
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

```bash
curl --location --request PUT 'http://localhost:3567/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "customer1",
    "firstFactors": ["emailpassword"],
    "requiredSecondaryFactors": ["otp-email"]
}'
```

In the above code, you add a property called `requiredSecondaryFactors` for a tenant whose value is a `string[]`. You add `otp-email` as a factor ID above which means that all users who log into that tenant must complete `otp-email` as a second factor.

To remove the `requiredSecondaryFactors` configuration for a tenant, you can turn off all the toggles.

If you add more than one item in this array, it means that the user must complete any one of factors mentioned in the array. If you want to have a different behavior for the tenant, you can achieve that by overriding the `getMFARequirementsForAuth` function as shown below:

</Tab>

<Tab value="dashboard" className="tab-with-background">

<img src="/img/dashboard/tenant-management/otp-email-enabled.png" alt="OTP - Email enabled"/>

As shown above, you turn on `OTP - Email` in the **Secondary Factors** section which means that all users who log into that tenant must complete `otp-email` as a second factor.

You can also turn off all factors to have no secondary factors required for the tenant.

If you turn on more than one factor, it means that the user must complete any one of factors that are active. If you want to have a different behavior for the tenant, you can achieve that by overriding the `getMFARequirementsForAuth` function as shown below:

</Tab>

</Tabs>

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            // highlight-start
                            return [{
                                allOfInAnyOrder: await input.requiredSecondaryFactorsForTenant
                            }]
                            // highlight-end
                        }
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.types import User
from supertokens_python.recipe.multifactorauth.types import MFARequirementList

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # highlight-start
        return [{"allOfInAnyOrder": await required_secondary_factors_for_tenant()}]
        # highlight-end

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

Notice that the input to the function contains the `requiredSecondaryFactorsForTenant` array. This would be the same list that you passed to the tenant configuration when creating / modifying the tenant as shown in the previous steps.

</TenantType.MultiTenantContent>

#### 1.4 Remove the second factor requirement {{optional}}

Instead of configuring a factor for all users in your app, or for all users within a tenant, you may want to implement a flow in which users do MFA only if they have enabled it for themselves. Here, users may also want to choose what factors they would like to enable for themselves.

This flow allows users to configure their MFA preferences in the settings page in your app's frontend. A pre-built UI for this is not yet provided, but in this section, we explain the setup on the backend.

You want to start by creating an API that does [session verification](/docs/additional-verification/session-verification/protect-api-routes), and then enable the desired factor for the user. For example, if the user wants to enable TOTP, then you would call the following function in your API:

<Tabs>
<Tab value="nodejs">

```ts

async function enableMFAForUser(userId: string) {
    await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import add_to_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def enable_mfa_for_user(user_id: str):
    await add_to_required_secondary_factors_for_user(
        user_id, FactorIds.TOTP
    )
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import add_to_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

def enable_mfa_for_user(user_id: str):
    add_to_required_secondary_factors_for_user(
        user_id, FactorIds.TOTP
    )
```

</Tab>
</Tabs>

</Tab>
</Tabs>

The effect of the above function call is that in the default implementation of `getMFARequirementsForAuth`, the factors specifically enabled for the input user are considered. By default, if you add multiple factors for a user ID, then it would require them to complete any one of those secondary factors during login.

If you want to change the default behavior from "any one of" to something else (like "all of"), you can do this by overriding the `getMFARequirementsForAuth` function:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // highlight-start
                        getMFARequirementsForAuth: async function (input) {
                            return [{
                                allOfInAnyOrder: await input.requiredSecondaryFactorsForUser
                            }]
                        }
                        // highlight-end
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.types import User
from supertokens_python.recipe.multifactorauth.types import MFARequirementList

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # highlight-start
        return [{"allOfInAnyOrder": await required_secondary_factors_for_user()}]
        # highlight-end

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

Once you call the `addToRequiredSecondaryFactorsForUser` function for a user, SuperTokens stores this preference in the user metadata JSON of the user. For example, if you add `"totp"` as a required secondary factor for a user, this preference is stored in the metadata JSON as:

```json
{
    "_supertokens": {
        "requiredSecondaryFactors": ["totp"]
    }
}
```

You can view this JSON on the [user details page of the user management dashboard](/docs/post-authentication/dashboard/user-management) and modify it manually if you like.

To know the factors that a user has enabled, you can use the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function isTotpEnabledForUser(userId: string) {
    let factors = await MultiFactorAuth.getRequiredSecondaryFactorsForUser(userId)
    return factors.includes(MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def is_totp_enabled_for_user(user_id: str):
    factors = await get_required_secondary_factors_for_user(
        user_id
    )
    return FactorIds.TOTP in factors
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

def is_totp_enabled_for_user(user_id: str):
    factors = get_required_secondary_factors_for_user(
        user_id
    )
    return FactorIds.TOTP in factors
```

</Tab>
</Tabs>

</Tab>
</Tabs>

Using the above function, you can build your settings page on the frontend which displays the existing enabled factors for the user. Allow users to enable or disable factors as they like.

Once you have enabled a factor for a user, you take them to that factor setup screen if they have not previously already setup the factor. To know if a factor is setup, you can call the following function (on the backend): 

<Tabs>
<Tab value="nodejs">

```ts

async function isTotpSetupForUser(userId: string) {
    let factors = await MultiFactorAuth.getFactorsSetupForUser(userId)
    return factors.includes(MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import get_factors_setup_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def is_totp_enabled_for_user(user_id: str):
    factors = await get_factors_setup_for_user(
        user_id
    )
    return FactorIds.TOTP in factors
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import get_factors_setup_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

def is_totp_enabled_for_user(user_id: str):
    factors = get_factors_setup_for_user(
        user_id
    )
    return FactorIds.TOTP in factors
```

</Tab>
</Tabs>

</Tab>
</Tabs>

Or you can call the [`MFAInfo` endpoint](/docs/additional-verification/mfa/initial-setup#the-mfa-info-endpoint) from the frontend which returns information indicating which factors have already been setup for the user and which not.

A factor is considered setup if the user has gone through that factor's flow at least once. For example, if the user has created and verified a TOTP device, only then does the `getFactorsSetupForUser` function return `totp` as part of the array. Likewise, if the user has completed `otp-email` or `link-email` once, only then do these factors become a part of the returned array. Let's take two examples:
- The first time the user enables TOTP, then the result of `getFactorsSetupForUser` does not contain `"totp"`. You should redirect the user to the TOTP setup screen. Once they add and verify a device, then `getFactorsSetupForUser` returns `["totp"]` even if they later disable TOTP from the settings page and re-enable it.
- Let's say that the first factor for a user is `emailpassword`, and the second factor is `otp-email`. Once they sign up, SuperTokens already knows the email for the user, when they are doing the `otp-email` step, then they are not asked to enter their email again (that is, an OTP is directly sent to them). However, until they actually complete the OTP flow, `getFactorsSetupForUser` does not return `["otp-email"]` as part of the output.

:::caution
In the edge case that a factor is active for a user, but they sign out before setting it up, then when they login next, SuperTokens still asks them to complete the factor at that time. If SuperTokens doesn't have the required information (like no TOTP device for TOTP auth), then users need to set up a device at that point in time.

If you would like to change how this works and only want users to set up their factor via the settings page, and not during sign in, you can do this by overriding the `getMFARequirementsForAuth` function, which takes as an input the list of factors that are setup for the current user.
:::

The subsequent sections in this doc walk through frontend setup, and also specific examples of common MFA flows.

### 2. Set up the frontend



<PrebuiltUIInstructions>

<TenantType.SingleTenantContent>

The pre-built UI provides support for the following MFA methods:
- TOTP
- Email / phone OTP

If you want other types of MFA (like magic links, or password), please consider checking out the custom UI second.

We start by initialising the MFA recipe on the frontend and providing the list of first factors as shown below:

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        EmailPassword.init( /* ... */),
        Passwordless.init({
             contactMethod: "EMAIL_OR_PHONE",
        }),
        // highlight-start
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        supertokensUIEmailPassword.init( /* ... */),
        supertokensUIPasswordless.init({
             contactMethod: "EMAIL_OR_PHONE",
        }),
        // highlight-start
        supertokensUIMultiFactorAuth.init({
            firstFactors: [
                supertokensUIMultiFactorAuth.FactorIds.EMAILPASSWORD,
                supertokensUIMultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        MultiFactorAuth.init()
    ],
});
```

</Tab>

</Tabs>

In the above snippet, `thirdparty` and email password are configured as first factors. The second factor is determined [on the backend](/docs/additional-verification/mfa/initial-setup#1-set-up-the-backend), based on the boolean value of  [`v` in the MFA claim in the session](/docs/additional-verification/mfa/important-concepts#factors). If the `v` is `false` in the session, it means that there are still factors pending before the user has completed login. In this case, the frontend SDK calls the `MFAInfo` endpoint (see more about this later) on the backend which returns the list of factors (`string[]`) that the user must complete next. For example: 
- If the next array is `["otp-email"]`, then the user sees the enter OTP screen for the email associated with the first factor login.
- If the `n` array has multiple items, the user sees a [factor chooser screen](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/mfa-chooser--multiple-factors) using which they can decide which factor they want to continue with.
- If the `next` is empty, it means that:
    - A misconfiguration exists on the backend. This would show an access denied screen to the user. OR;
    - Another claim needs to satisfy first (like email verification), before the next MFA challenge can display. This can happen if you configure the `backend`'s `checkAllowedToSetupFactorElseThrowInvalidClaimError` function to not allow a factor setup until the email has been verified.

If you notice, in the above code snippet, `Passwordless.init` is also included, and this handles cases where the second factor is `otp-email` or `otp-sms`. For TOTP, a different recipe is used as shown later in this guide.

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

For a multi-factor setup, the first factors are selected based on [the configuration of the tenant](./backend-setup#multi-tenant-setup). Each tenant has a `firstFactors` array configuration which determines the login options shown for that tenant. For MFA, the login options are determined by the [`requiredSecondaryFactors` configuration on the tenant](./backend-setup#multi-tenant-setup-1), or based on the customisations for `getMFARequirementsForAuth` on the backend.

To tell the frontend to dynamically load the factors based on the tenant, four things need to supply:
- The current `tenantId`
- Enable dynamic login methods
- Add `MultiFactorAuth.init` to the recipe list without any configured `firstFactors`
- Init all the recipes that can be possibly used by any tenant as the first or second factor.

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        Multitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        // highlight-start
                        getTenantId: (input) => {
                            // Implement the following based on the UX flow you want for
                            // tenant discovery
                            return "TODO.."
                        }
                        // highlight-end
                    }
                }
            }
        }),
        EmailPassword.init( /* ... */),
        Passwordless.init({
            contactMethod: "EMAIL_OR_PHONE",
        }),
        // highlight-start
        MultiFactorAuth.init()
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        supertokensUIMultitenancy.init({
            override: {
                functions: (oI) => {
                    return {
                        ...oI,
                        // highlight-start
                        getTenantId: (input) => {
                            // Implement the following based on the UX flow you want for
                            // tenant discovery
                            return "TODO.."
                        }
                        // highlight-end
                    }
                }
            }
        }),
        supertokensUIEmailPassword.init( /* ... */),
        supertokensUIPasswordless.init({
            contactMethod: "EMAIL_OR_PHONE",
        }),
        // highlight-start
        supertokensUIMultiFactorAuth.init()
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        MultiFactorAuth.init()
    ],
});
```

</Tab>

</Tabs>

- In the above code snippet, `ThirdPartyEmailPassword` and `Passwordless` are included as the auth methods. This works for a variety of use cases like:
    - The first factor for any tenant can be third party or email password login, and the second factor can be passwordless login (`otp-email` or `otp-sms`).
    - The first factor for any tenant can be email password, with, or without a second factor (like `otp-email`)..
    - The first factor for any tenant can be third party, with, or without a second factor (like `otp-email`)..
    - The first factor for any tenant can be passwordless login (with magic link), with or without a second factor (like `otp-email`).
    - You can even change `passwordles.init` to using `thirdpartypasswordless.init` if you want to have the first factor for any tenant to be `thirdparty` or passwordless login, with or without a second factor (like `otp-email`).
- The `MultiFactorAuth` is configured without any configured `firstFactors` because the frontend is set to dynamically load the first factors based on the tenant. Therefore, `usesDynamicLoginMethods: true` is included in the `SuperTokens.init` call.
- The `Multitenancy` is configured as well, and a skeleton for `getTenantId` is provided. You need to implement this function based on the UX flow desired for tenant discovery. For example, [here is a common UX flow in which the tenant ID is determined based on the current sub domain](/docs/authentication/enterprise/subdomain-login).

:::important
- If you do initialize the `firstFactors` array for `MultiFactorAuth.init()` on the frontend, it is not considered when `usesDynamicLoginMethods: true` is included.
- If the tenant doesn't have the `firstFactors` array set, then the list of first factors that appear is determined by the [login methods that are enabled in that tenant's configuration](/docs/multi-tenancy/new-tenant).
:::

The second factor for a tenant is selected based on the [`secondaryFactors` configuration for the tenant](./backend-setup#multi-tenant-setup-1), or based on any custom implementation for the `getMFARequirementsForAuth` function. If the current user has specific MFA methods enabled for them, those are also shown as options as well. Overall, the list of secondary factors is used to build the `next` array returned from the `MFAInfo` endpoint (see more about this later). For example: 
- If the next array is `["otp-email"]`, then the user sees the enter OTP screen for the email associated with the first factor login.
- If the `n` array has multiple items, the user sees a [factor chooser screen](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/mfa-chooser--multiple-factors) using which they can decide which factor they want to continue with.
- If the `next` is empty, it means that:
    - A misconfiguration exists on the backend. This would show an access denied screen to the user. OR;
    - Another claim needs to satisfy first (like email verification), before the next MFA challenge can display. This can happen if you configure the `backend`'s `checkAllowedToSetupFactorElseThrowInvalidClaimError` function to not allow a factor setup until the email has been verified.

In the subsequent sections, specific MFA setup examples are given for your reference.

</TenantType.MultiTenantContent>

#### Usage with email verification 

If you are also requiring email verification, the user must verify the email first, and then all the MFA challenges.
For example, if the user has email password as the first factor, and then TOTP as a second factor, SuperTokens prompts the user to do email password login, followed by email verification, followed by TOTP.

To switch the order such that email verification happens after the secondary factors of MFA, follow the next code snippet.

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes...
        EmailVerification.init({
            mode: "REQUIRED",
        }),
        Session.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // highlight-start
                        getGlobalClaimValidators: (input) => {
                            let emailVerificationClaimValidator = input.claimValidatorsAddedByOtherRecipes.find(v => v.id === EmailVerification.EmailVerificationClaim.id)!;
                            let filteredValidators = input.claimValidatorsAddedByOtherRecipes.filter(v => v.id !== EmailVerification.EmailVerificationClaim.id);
                            return [...filteredValidators, emailVerificationClaimValidator];
                        }
                        // highlight-end
                    }
                }
            }
        })
    ]
})
```

In the snippet above, the `getGlobalClaimValidators` function in the Session recipe is overridden to add the email verification validator at the end of the returned validators array. This ensures that post the first factor sign up, the first validator that fails is the MFA one which redirects the user to complete the MFA factors.

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes...
        supertokensUIEmailVerification.init({
            mode: "REQUIRED",
        }),
        supertokensUISession.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // highlight-start
                        getGlobalClaimValidators: (input) => {
                            let emailVerificationClaimValidator = input.claimValidatorsAddedByOtherRecipes.find(v => v.id === supertokensUIEmailVerification.EmailVerificationClaim.id)!;
                            let filteredValidators = input.claimValidatorsAddedByOtherRecipes.filter(v => v.id !== supertokensUIEmailVerification.EmailVerificationClaim.id);
                            return [...filteredValidators, emailVerificationClaimValidator];
                        }
                        // highlight-end
                    }
                }
            }
        })
    ]
})
```

In the snippet above, the `getGlobalClaimValidators` function in the Session recipe is overridden to add the email verification validator at the end of the returned validators array. This ensures that post the first factor sign up, the first validator that fails is the MFA one which redirects the user to complete the MFA factors.

</Tab>

</Tabs>

#### Handle misconfigurations

There can be situations of misconfigurations.
For example you may have enabled `otp-email` for a user as a secondary factor, but did not add `Passwordless` (or `ThirdPartyPasswordless`) in the `recipeList` on the frontend.
In such (and similar) situations, the pre-built UI on the frontend throws an error which is sent to the error boundary of your app.
The way to solve these errors is to recheck the `recipeList` on the frontend, and make sure that it has all the recipes initialized that are necessary for any factor configured on the backend.

#### The access denied screen

Sometimes, users may end up seeing [an access denied screen](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/totp-mfa--device-setup-access-denied-reload) during the login flow. This appears if there is a 500 (backend sends a 500 status code) error during the MFA flow for API calls that are automatically initiated (without user action). For example:
- When the user wants to setup a new `TOTP` device, the pre-built UI calls the `createDevice` function from the `totp` recipe on page load, and if that fails, users see the access denied screen asking them to retry.
- When the user needs to complete an OTP email factor, and if the API call to send an email (which starts on page load) fails, then users see the access denied screen asking them to retry.

You can override this component in the following way:

<Tabs>

<Tab value="reactjs">

<Question
    question="Do you use react-router-dom?">
<Answer title="Yes">

```tsx

function App() {
    return (
        <SuperTokensWrapper>
            <SessionComponentsOverrideProvider
                components={{
                    SessionAccessDenied_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <div>
                                Access denied!
                                {props.error === undefined ? null : props.error}
                            </div>
                        );
                    },
                }}>
                {/* Rest of the JSX */}
            </SessionComponentsOverrideProvider>
        </SuperTokensWrapper>
    );
}
export default App;
```

</Answer>

<Answer title="No">

```tsx

function App() {
    if(canHandleRoute([/*...*/])){
        return (
            <SessionComponentsOverrideProvider
                components={{
                    SessionAccessDenied_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <div>
                                Access denied!
                                {props.error === undefined ? null : props.error}
                            </div>
                        );
                    },
                }}>
                {getRoutingComponent([/*...*/])}
            </SessionComponentsOverrideProvider>
        )
    }
    return (
        <SuperTokensWrapper>
            {/* Rest of the JSX */}
        </SuperTokensWrapper>
    );
}
export default App;
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::caution
You cannot override the pre-built UI in non react apps yet.
:::

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

After the first factor sign in is over, to know the next auth challenge, the frontend should rely on the session's access token payload MFA claim's `n` array. For example, the access token payload may have the following content:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

This means that the user has completed the email password login, and that there are still MFA login challenge(s) remaining (`v` is `false`).

#### 1.1 Initialize the MFA recipe 

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-next-line
        MultiFactorAuth.init()
    ],
});
```

</Tab>

<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-next-line
        supertokensMultiFactorAuth.init()
    ],
});
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

:::success
This step is not applicable for mobile apps. Please continue reading.
:::

</Tab>

</Tabs>

#### 1.2 Add the MFA flow

The overall lifecycle of a factor post sign in is as follows:

<Steps>

## Asking for the first factor

This is the same as setting up a recipe per the other recipe guides. Please follow those.

## Checking the `v` boolean value in the MFA claim

After the first factor is complete, the frontend needs to check if there are any pending MFA challenges. This can be done by reading the `v` claim from the session as shown below:

<Tabs uiType="custom">

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function isAllMFACompleted() {
    if (await Session.doesSessionExist()) {
        let mfaClaim = await Session.getClaimValue({
            claim: MultiFactorAuth.MultiFactorAuthClaim
        });
        if (mfaClaim === undefined) {
            // this can happen during migration where the session is an older one
            // that was created before MFA was introduced on the backend
            return true;
        } else {
            return mfaClaim.v
        }
    } else {
        throw new Error("Illegal function call: For first factor setup, you do not need to call this function")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx
async function isAllMFACompleted() {
    if (await supertokensSession.doesSessionExist()) {
        let mfaClaim = await supertokensSession.getClaimValue({
            claim: supertokensMultiFactorAuth.MultiFactorAuthClaim
        });
        if (mfaClaim === undefined) {
            // this can happen during migration where the session is an older one
            // that was created before MFA was introduced on the backend
            return true;
        } else {
            return mfaClaim.v
        }
    } else {
        throw new Error("Illegal function call: For first factor setup, you do not need to call this function")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function isAllMFACompleted() {
    if (await SuperTokens.doesSessionExist()) {

        // highlight-start
        let isMFACompleted: boolean = (await SuperTokens.getAccessTokenPayloadSecurely())["st-mfa"].v;
        return isMFACompleted
        // highlight-end
    }
}
```

</Tab>

<Tab value="android">

```kotlin
        val isMFACompleted: Boolean = (accessTokenPayload.get("st-mfa") as JSONObject).get("v") as Boolean;
        return isMFACompleted;
    }
}
```

</Tab>

<Tab value="ios">

```swift
            let mfaObject: [String: Any] = accessTokenPayload["st-mfa"] as? [String: Any],
            // Determine if MFA has been completed
            let isMFACompleted: Bool = mfaObject["v"] as? Bool {
            // Return the MFA completion status
            return isMFACompleted
        }
        // Return false if any of the unwrapping fails, indicating MFA completion status cannot be confirmed
        return false
    }
}
```

</Tab>

<Tab value="flutter">

```dart

Future<bool> isAllMFACompleted() async {
  var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();

  if (accessTokenPayload.containsKey("st-mfa")) {
    Map<String, dynamic> mfaObject = accessTokenPayload["st-mfa"];

    if (mfaObject.containsKey("v")) {
      bool isMFACompleted = mfaObject["v"];

      return isMFACompleted;
    }
  }
  return false; // Return false if "st-mfa" is not present or "v" is not found
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

## Checking the `next` array
Once it is verified that MFA is still pending, the list of factors the user must do next needs to be retrieved. This can be done by calling the [MFA Info endpoint](#mfa-info-endpoint) which returns a list of next (`string[]`) factors:
- If there are multiple values in this array, then the frontend needs to show these options to the user and ask them to pick one of them.
- If there is only one item, then the UI can directly ask the user to complete that factor.
- If this array is empty, then:
    - A misconfiguration exists on the backend. This would show an access denied screen to the user. OR;
    - Another claim needs to satisfy first (like email verification), before the next MFA challenge can display. This can happen if you configure the `backend`'s `checkAllowedToSetupFactorElseThrowInvalidClaimError` function to not allow a factor setup until the email has been verified.

## Checking for factor setup
Once the user has picked a specific factor (or if `next` contains only one item), you need to check if that factor has already been setup for that user. A factor is setup already if:
- For `totp`: The user has already added a `totp` device and verified it.
- For `otp-email`: The user has a passwordless `loginMethod` that has an email associated with it.
- For `link-email`: The user has a passwordless `loginMethod` that has an email associated with it. Note that this is not a valid secondary factor, but is a valid first factor.
- For `otp-sms`: The user has a passwordless `loginMethod` that has a phone number associated with it.
- For `link-phone`: The user has a passwordless `loginMethod` that has a phone number associated with it. Note that this is not a valid secondary factor, but is a value first factor.
- For `emailpassword`: The user has an email password `loginMethod`.
- For `thirdparty`: The user has a third party `loginMethod`.

If the user has the factor already setup, you can skip the setup step and directly ask them for the challenge:
- For `totp`: Ask them to enter the OTP.
- For `otp-email`: Send them an email with the OTP, and ask them to enter the OTP.
- For `otp-sms`: Send them an SMS with the OTP, and ask them to enter the OTP.
- For `emailpassword`: Ask them to enter their password.
- For `thirdparty`: Ask them to login using the third party provider.

In case the user does not have the factor setup, you need to ask them to set it up first:
- For `totp`: Ask them to scan the QR code and enter the TOTP to verify the device.
- For `otp-email`: Ask them to enter their email and send them an email with the OTP. Once they enter the OTP, a passwordless user is created and associated with their user object. Note that if you already have the user's email from another login method (see later), you do not need to ask them to enter their email again. In that way, it would be similar to as if the factor is already setup, but technically, it is not.
- For `otp-sms`: Ask them to enter their phone number and send them an SMS with the OTP. Once they enter the OTP, a passwordless user is created and associated with their user object. Note that if you already have the user's phone number from another login method (see later), you do not need to ask them to enter their phone number again. In that way, it would be similar to as if the factor is already setup, but technically, it is not.
- For `emailpassword`: Ask them to enter their email and password. Once they enter the password, an email password user is created and associated with their user object. Note that if you already have the user's email from another login method (see later), you do not need to ask them to enter their email again. In that way, it would be similar to as if the factor is already setup, but technically, it is not. Here you would be calling the sign up API, vs in the other case (where the factor is already setup), you would be calling the sign in API.
- For `thirdparty`: Ask them to login using the third party provider. Once they login, a third party user is created and associated with their user object.

In the later guides of this recipe, the use cases are described. If you want to know the status of any factor, you can get that by calling the [MFA Info endpoint](#mfa-info-endpoint).

</Steps>

</CustomUIInstructions>

## References 

### The MFA info endpoint

This is an important endpoint which can be utilized to:
- Know which factors are pending for the user (referred to as the the `next` array in the documentation).
- Update the `v` and `c` values in the MFA claim.
- Get a list of all factors that are already setup for the session user.
- For each factor, get a list of emails / phone numbers that can be utilized for that factor.

Our pre-built UI uses this API automatically, but you can also always call this API manually if you are building a custom UI:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function fetchMFAInfo() {
    if (await Session.doesSessionExist()) {
        try {
            let mfaInfo = await MultifactorAuth.resyncSessionAndFetchMFAInfo()
            let factorEmails = mfaInfo.emails;
            let factorPhoneNumbers = mfaInfo.phoneNumbers;

            let emailsForOTPEmail = factorEmails["otp-email"];
            let phoneNumbersForOTPSms = factorEmails["otp-sms"];
            let isTotpSetup = mfaInfo.factors.alreadySetup.includes("totp");
            let isOTPEmailSetup = mfaInfo.factors.alreadySetup.includes("otp-email");
            let isOTPSmsSetup = mfaInfo.factors.alreadySetup.includes("otp-sms");
            let next = mfaInfo.factors.next;

            let factorsAllowedToBeSetup = mfaInfo.factors.allowedToSetup;
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: For first factor setup, you do not need to call this function")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx
async function fetchMFAInfo() {
    if (await supertokensSession.doesSessionExist()) {
        try {
            let mfaInfo = await supertokensMultiFactorAuth.resyncSessionAndFetchMFAInfo()
            let factorEmails = mfaInfo.emails;
            let factorPhoneNumbers = mfaInfo.phoneNumbers;

            let emailsForOTPEmail = factorEmails["otp-email"];
            let phoneNumbersForOTPSms = factorEmails["otp-sms"];
            let isTotpSetup = mfaInfo.factors.alreadySetup.includes("totp");
            let isOTPEmailSetup = mfaInfo.factors.alreadySetup.includes("otp-email");
            let isOTPSmsSetup = mfaInfo.factors.alreadySetup.includes("otp-sms");
            let next = mfaInfo.factors.next;

            let factorsAllowedToBeSetup = mfaInfo.factors.allowedToSetup;
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: For first factor setup, you do not need to call this function")
    }
}
```

</Tab>

</Tabs>

- In the above code snippet, the list of factors which the user must complete next (in the `next` array) is retrieved along with all the relevant information to know what state each factor is in to decide if the user should be prompted to setup the factor (for example create a new TOTP device), or solve the auth challenge instead (for example, showing the enter TOTP screen).
- The function is called `resyncSessionAndFetchMFAInfo` because it does two things:
    - fetches the MFA info that you can consume to know the `next` array and what state each factor is in.
    - resynchronizes the value of the `v` and `c` in the session's MFA claim.

</Tab>

<Tab value="mobile">



Call the following API when you want to know the status of any factor. Notice that the API call requires the session's access token as an input (this should be included by the frontend SDK automatically):

```bash
curl --location --request PUT '<API_DOMAIN><API_BASE_PATH>/mfa/info' \
--header 'Authorization: Bearer ...'
```

</Tab>

</Tabs>

- The structure of the raw JSON response is as follows:
    ```json
    {
        "status": "OK",
        "factors": {
            "alreadySetup": ["totp", "otp-email", "..."],
            "allowedToSetup": ["otp-sms", "otp-email", "..."],
            "next": ["otp-sms", "..."]
        },
        "emails": {
            "otp-email": ["user1@example.com", "user2@example.com"],
            "link-email": ["user1@example.com", "user2@example.com"],
        },
        "phoneNumbers": {
            "otp-sms": ["+1234567890", "+1098765432"],
            "link-phone": ["+1234567890", "+1098765432"],
        },
    }
    ```

    - `factors.alreadySetup` is an array that contains all factors that have been setup by the user. If the current factor is a part of this array, it means that you can directly take the user to the factor challenge screen. If your factor depends on an email or phone number (like in the case of `otp-sms` or `otp-email`), then you can find the email to send the code to in the `emails` or `phoneNumbers` object in the response with the key as the current factor ID.
    - `factors.allowedToSetup` is an array that contains all factors that the user can setup at this point. This is not that useful during the sign in process, but may be useful post sign in if you want to know what are the factors that the user can setup at any point in time. 
    - `emails` is an object in which the key are all the factor IDs supported by SuperTokens (and any custom factor ID added by you). The values against each of the keys is a list of emails that can be utilized to complete the factor. The first email (index 0) in the list is the preferred email to use for the factor. The order is determined based on the first factor chosen by the user, and if the factor was already setup or not.

    If the array is empty, it means that there is no email associated with the user for that factor. This can happen only if the factor was not already setup. In this case, you should take the user to a screen to ask them to first enter an email, and then to the challenge screen.

    The flow is further explained in the common flows guide later on.
    - `phoneNumbers` is similar to the `emails` object, except that it contains phone numbers for factors that are dependent on phone numbers.
    - The `factors.next` array determines the list of factors which the user must completed next. For example:
        - If the next array is `["otp-email"]`, then the user sees the enter OTP screen for the email associated with the first factor login.
        - If the `n` array has multiple items:
            - For the pre-built UI, the user sees a [factor chooser screen](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/mfa-chooser--multiple-factors) using which they can decide which factor they want to continue with.
            - For custom UI, you would need to make this screen on your own.
        - If the `next` is empty, it means that:
            - A misconfiguration exists on the backend. This would show an access denied screen to the user. OR;
            - Another claim needs to satisfy first (like email verification), before the next MFA challenge can display. This can happen if you configure the `checkAllowedToSetupFactorElseThrowInvalidClaimError` function, on the backend, to not allow a factor setup until the email is verified.

### Handle support cases

Some situations exist in which users may be locked out of their accounts and would need you to do certain steps to unlock their accounts.
These cases are:

<Accordion px="3">

## `ERR_CODE_009`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signin POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_009)"
        }
        ```
- This can happen if the email password account you are trying to do MFA with is not verified.

## `ERR_CODE_010`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signin POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_010)"
        }
        ```
- This can happen if the email password account you are trying to do MFA with is already linked to another primary user that is not equal to the session user.

## `ERR_CODE_011`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signin POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_011)"
        }
        ```
- This can happen if the email password account you are trying to do MFA cannot link to the session user because there already exists another primary user with the same email.

## `ERR_CODE_012`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signin POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_012)"
        }
        ```
- To link the email password user with the session user, it must be confirmed that the session user is a primary user. However, that can fail if there exists another primary user with the same email as the session user, and in this case, this error is sent to the frontend.

## `ERR_CODE_013`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_013)"
        }
        ```
- An example scenario of when in the following scenario:
    - A user signs up with their phone number and OTP
    - Post sign up, they are prompted to add their email and a password for the account. In this case, since the entered email is not verified, this error will display.

- To resolve this, it is advised to change the flow to first ask the user to go through the email OTP flow post the first factor sign up, and then add a password to the account. This way, the email will be verified. 

## `ERR_CODE_014`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_014)"
        }
        ```
- An example scenario of when in the following scenario:
    - Let's say that the app is set up to not have automatic account linking during the first factor.
    - A user creates an email password account with email `e1`, verifies it, and links social login account to it with email `e2`.
    - The user logs out, and then creates a social login account with email `e1`. Then, they are prompted to add a password to this account. Since an email password account with `e1` already exists, SuperTokens will try and link that to this new account, but fail, since the email password account with `e1` is already a primary user.

- To resolve this, it is advised to manually link the `e1` social login account with the `e1` email password account. Or you can enable automatic account linking for first factor and this way, the above scenario will not happen.

## `ERR_CODE_015`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_015)"
        }
        ```
- An example scenario of when in the following scenario:
    - A user creates a social login account with email `e1` which becomes a primary user.
    - The user logs out, and creates another social login account with email `e2`, which also becomes a primary user.
    - The user is prompted to add a password for the new account with an option to also specify an email with it (this is strange, but theoretically possible). They now enter the email `e1` for the email password account.
    - This will cause this type of error since the linking of the new social login and email account will fail since there already exists another primary user with the same (`e1`) email.

- To resolve this, it is advised not allowing users to specify an email when asking them to add a password for their account.

## `ERR_CODE_016`
- This can happen when the second factor is `emailpassword`:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_016)"
        }
        ```
- An example scenario of when in the following scenario:
    - Let's say that the app is set up to not have automatic account linking during the first factor.
    - A user signs up with a social login account using Google with email `e1`, and they add another social account, with Facebook, with the same email.
    - The user logs out and creates another social login account with email `e1` (say `GitHub`), and then tries and adds a password to this account with email `e1`. Here, SuperTokens will try and make the `GitHub` login a primary user, but fail, since the email `e1` is already a primary user (with Google login). 

- To resolve this, it is advised to manually link the `e1` `GitHub` social login account with the `e1` Google social login account. Or you can enable automatic account linking for first factor and this way, the above scenario will not happen.

## `ERR_CODE_017`
- This can happen when the second factor relies on the passwordless recipe.
    - API Path is `/signinup/code/consume POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_017)"
        }
        ```
- This can happen when the passwordless account is trying to link to the account of the first factor, but it can't because the passwordless account is already linked with another primary user.

## `ERR_CODE_018`
- This can happen when the second factor relies on the passwordless recipe.
    - API Path is `/signinup/code/consume POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_018)"
        }
        ```
- This can happen when the passwordless account is trying to link to the account of the first factor, but it can't because there exists another primary user with the same email as the passwordless account.

## `ERR_CODE_019`
- This can happen when the second factor relies on the passwordless recipe.
    - API Path is `/signinup/code POST` or `/signinup/code/consume POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_019)"
        }
        ```
- This can happen when the passwordless account is trying to link to the account of the first factor, but, the first factor account cannot become a primary user because there exists another account with the same email as the first factor user account which is already primary.
</Accordion>

If you are using otp-email MFA factor as a form of email verification, you should also have `emailverification` recipe initialised in `REQUIRED` mode on the backend (no need to add it on the frontend since users won't see that UI).
This is for security reasons wherein during the sign up process, when asking for the otp-email challenge, the email the OTP is sent to is determined on the frontend (automatically). In this case, the following scenario is possible:
- User signs up with email `A`
- An email OTP challenge is displayed to the user, and an OTP to email `A` is sent automatically.
- The user manually calls the OTP create code API with email `B` and their session token, and verifies the OTP via a call to the consume code API.
- The user refreshes the page and the otp-email challenge is complete.

Of course, this is not the desired flow when you want to use otp-email as a form of email verification. To prevent this, you should have the `emailverification` recipe initialised in `REQUIRED` mode on the backend. This ensures that the email verification claim validator only passes if the email that's verified is the one from the first factor (email `A`).

The above case is only possible during sign up, and not sign in.
:::

### Security considerations

SuperTokens enforces that a user has completed all the required factors by keeping track of and checking them in the user's access token payload.
- If a user is required to complete a MFA challenge, for example TOTP, if they already have a verified TOTP device, they cannot setup any other factor before completing this factor challenge, and if they do not yet have a verified TOTP device, then the only action they are allowed to take is to create a new TOTP device. This ensures that a user cannot bypass the MFA challenges of the current or future step.
- When a user creates a new TOTP device, it cannot be utilized unless they first verify it by entering the initial TOTP code.
- If the email of the 2nd factor login method is not confirmed, by default, it is not allowed to be setup or used as a 2nd factor, unless the session user has a login method that has the same email which is verified.
- A fixed number of times (5 times by default) a user can enter an invalid TOTP code, after which they have to wait for 15 minutes before trying again. This timeout and the max attempts count can be modified in the core configuration.
- During sign up (not sign in), for email / SMS OTP challenge, the email / SMS that the OTP is sent to is determined by the frontend. This is intentional because it allows you to create a flow in which the email the OTP is sent to may not be the same as the login method of the first factor. However, from a security point of view, it allows a malicious actor to send an OTP to a different email / phone number than the first factor's phone or email. This is not an issue if you are using email OTP as a method for email verification because the email verification recipe checks that the email of the first factor is verified, and in the case of the malicious user, the email of the first factor won't be verified because they entered a different email for otp-email challenge.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/mfa/email-sms-otp/otp-for-all-users" label="Email & SMS OTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/totp/totp-for-all-users" label="TOTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/step-up-auth" label="Step-up Authentication" />
  <ReferenceCard href="/docs/additional-verification/mfa/backup-codes" label="Backup Codes" />
  <ReferenceCard href="/docs/additional-verification/mfa/protect-routes" label="Protect Routes with MFA" />
</ReferenceCard.Grid>

# Additional Verification - Multi Factor Authentication - TOTP -  TOTP required for all users
Source: https://supertokens.com/docs/additional-verification/mfa/totp/totp-for-all-users

## Overview

This guide shows you how to implement an MFA policy that requires all users to use TOTP before they get access to your application.

## Before you start

The tutorial assumes that the first factor is email password or social login, but the same set of steps are applicable for other first factor types.



## Steps

<TenantType.Switch />

<TenantType.SingleTenantContent>

### 1. Configure the backend

To start with, we configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-next-line
        totp.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            return [MultiFactorAuth.FactorIds.TOTP]
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, totp
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # Get roles for the user
        return [FactorIds.TOTP]

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        totp.init(),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

- Notice that we have initialised the TOTP recipe in the `recipeList`. By default, no configs are required for it, but you can provide:
    - `issuer`: This is the name that will show up in the TOTP app for the user. By default, this is equal to the `appName` config, however, you can change it to something else using this property.
    - `defaultSkew`: The default value of this is `1`, which means that TOTP codes that were generated 1 tick before, and that will be generated 1 tick after from the current tick will be accepted at any given time (including the TOTP of the current tick, of course).
    -  `defaultPeriod`: The default value of this is `30`, which means that the current tick is value for 30 seconds. So by default, a TOTP code that's just shown to the user, is valid for 60 seconds (`defaultPeriod + defaultSkew*defaultPeriod` seconds)
- We also override the `getMFARequirementsForAuth` function to indicate that `totp` must be completed before the user can access the app. Notice that we do not check for the userId there, and return `totp` for all users.

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload will look like this:
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished `totp`, the payload will look like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "totp": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

### 2. Configure the frontend



<PrebuiltUIInstructions>

We start by modifying the `init` function call on the frontend like so:

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes..
        // highlight-start
        totp.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You will have to make changes to the auth route config, as well as to the `supertokens-web-js` SDK config at the root of your application:

This change is in your auth route config.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes..
        // highlight-start
        supertokensUITOTP.init(),
        supertokensUIMultiFactorAuth.init({
            firstFactors: [
                supertokensUIMultiFactorAuth.FactorIds.EMAILPASSWORD,
                supertokensUIMultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK config at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        Totp.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

- Just like on the backend, we init the `totp` recipe in the `recipeList`.
- We also init the `MultiFactorAuth` recipe, and pass in the first factors that we want to use. In this case, that would be `emailpassword` and `thirdparty` - same as the backend.

Next, we need to add the TOTP pre-built UI when rendering the SuperTokens component:

<Tabs>

<Tab value="reactjs">

<Question
    question="Do you use react-router-dom?">
<Answer title="Yes">

```tsx

function App() {
  return (
    <SuperTokensWrapper>
      <div className="App">
        <Router>
          <div className="fill">
            <Routes>
              // highlight-start 
              {getSuperTokensRoutesForReactRouterDom(reactRouterDOM, [/* ... */ TOTPPreBuiltUI, MultiFactorAuthPreBuiltUI])}
              // highlight-end 
              // ... other routes
            </Routes>
          </div>
        </Router>
      </div>
    </SuperTokensWrapper>
  );
}
```

</Answer>

<Answer title="No">

```tsx

function App() {
  // highlight-start
  if (canHandleRoute([/* ... */ TOTPPreBuiltUI, MultiFactorAuthPreBuiltUI])) {
      return getRoutingComponent([/* ... */ TOTPPreBuiltUI, MultiFactorAuthPreBuiltUI])
  }
  // highlight-end
  return (
    <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
  );
}
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::success
This step is not required for non React apps, since all the pre-built UI components are already added into the bundle.
:::

</Tab>

</Tabs>

With the above configuration, users will see `emailpassword` or social login UI when they visit the auth page. After completing that, users will be redirected to `/auth/mfa/totp` (assuming that the `websiteBasePath` is `/auth`) where they will be asked to setup the factor, or complete the TOTP challenge if they have already setup the factor before. The UI for this screen looks like:
- [Factor Setup UI](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--device-setup-with-single-next-option)
- [Verification UI](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--verification-with-single-next-option) (In case the factor is already setup before).

</PrebuiltUIInstructions>

<CustomUIInstructions>

We start by initialising the MFA and TOTP recipe on the frontend like so:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        Totp.init()
        // highlight-end
    ],
});
```

</Tab>

<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        supertokensMultiFactorAuth.init(),
        supertokensTotp.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

:::success
This step is not applicable for mobile apps. Please continue reading.
:::

</Tab>

</Tabs>

After the first factor login, you should start by [checking the access token payload and see if the MFA claim's `v` boolean is `false`](../frontend-setup#step-2-checking-the---custv-boolean-value-in-the-mfa-claim--cust). If it's not, then we can redirect the user to the application page.

If it's `false`, the frontend then needs to [call the MFA endpoint](../frontend-setup#mfa-info-endpoint) to get information about which factor the user should be asked to complete next. Based on the backend config in this page, the `next` array will contain `["totp"]`.

Two possibilities exist here:
- Case 1: The user needs to setup a TOTP device cause they don't have any.
- Case 2: The user already has a verified device setup and needs to complete the TOTP challenge.

We can know which case it is by checking if `"totp"` is one of the items in the `factorsThatAreAlreadySetup` array that is returned from the API call above. If it is in the array, then it's case 2, otherwise it's case 1.

#### Case 1 implementation: User needs to setup a new TOTP device
In this case, we do two things:
- Call an API on the backend to create a device. This returns the device secret that can be displayed to the user. The user is supposed to scan this using their authenticator app, to add a new entry for your app in their authenticator app.
- Then the user needs to enter the TOTP code that's displayed to them in the app, and this needs to be sent to the backend to mark the device as verified. Once a device is marked as verified, only then will the `factorsThatAreAlreadySetup` array contain `"totp"` the next time they login.

To create a new device, call the following API:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function createNewTotpDevice() {
    if (await Session.doesSessionExist()) {
        try {
            let deviceResponse = await Totp.createDevice();
            if (deviceResponse.status === "DEVICE_ALREADY_EXISTS_ERROR") {
                // this should only come here if you are passing a custom device name when calling the above function.
                throw new Error("Should never come here")
                // device created successfully
            }
            // device created successfully
            let qrCodeString = deviceResponse.qrCodeString;
            let secret = deviceResponse.secret;

            // TODO: display a QR code based on qrCodeString, and also an option to view
            // the secret if the user is unable to scan the QR code.
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("TOTP device creation can only happen after the first factor is complete and when a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx
async function createNewTotpDevice() {
    if (await supertokensSession.doesSessionExist()) {
        try {
            let deviceResponse = await supertokensTotp.createDevice();
            if (deviceResponse.status === "DEVICE_ALREADY_EXISTS_ERROR") {
                // this should only come here if you are passing a custom device name when calling the above function.
                throw new Error("Should never come here")
                // device created successfully
            }
            // device created successfully
            let qrCodeString = deviceResponse.qrCodeString;
            let secret = deviceResponse.secret;

            // TODO: display a QR code based on qrCodeString, and also an option to view
            // the secret if the user is unable to scan the QR code.
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("TOTP device creation can only happen after the first factor is complete and when a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

The above API call returns the following response:

```json
{
    "status": "OK",
    "issuerName": "...",
    "deviceName": "TOTP Device 1",
    "secret": "....",
    "userIdentifier": "user@example.com",
    "qrCodeString": "..."    
} | {
    "status": "DEVICE_ALREADY_EXISTS_ERROR" | "GENERAL_ERROR"
}
```

</Tab>

</Tabs>

- When device registration is successful, the API returns:
    - The `secret` and `qrCodeString` which are to be displayed to the user. For React apps, we recommend using the [react-qr-code library](https://github.com/rosskhanas/react-qr-code) to display the QR code.
    - The `issuerName` is the name will show up on the TOTP app for the user. By default, this is equal to the `appName` config on the backend SDK, however, you can change it to something else in the backend `totp.init` config.
    - The `userIdentifier` is the email / phone number of the user based on the first factor. This will also be shown in the TOTP app along with the `issuerName`.
- The API call can also take a `deviceName` (as a POST body prop) which attempts to create a TOTP device with the provided name. A status of `"DEVICE_ALREADY_EXISTS_ERROR"` is returned in case a verified device with the input name already exists. In this case, you should ask the user to enter a different name. Note that this status is only returned in case you are passing in a custom device name. The default naming strategy is to name the device "TOTP Device N", where we start N from 1, and keep increasing it. This value can be used to identify a device from the backend point of view, for operations like deleting a device.
- A status of `"GENERAL_ERROR"` is returned in case you specifically return that from a backend API override.

Once a device has been created, and scanned, you need to ask the user to enter the TOTP and call the API below to verify it:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function verifyTotpDevice(deviceName: string, userInputTotp: string) {
    if (await Session.doesSessionExist()) {
        try {
            let verifyResponse = await Totp.verifyDevice({
                deviceName,
                totp: userInputTotp,
            });
            if (verifyResponse.status === "UNKNOWN_DEVICE_ERROR") {
                // this can happen due to a race condition wherein the device is deleted before verifying.
                window.alert("Something went wrong. Please reload and try again");
            } else if (verifyResponse.status === "LIMIT_REACHED_ERROR") {
                // this can happen if the user has entered a wrong TOTP too many times.
                window.alert("Totp incorrect. Please try again in " + (verifyResponse.retryAfterMs / 1000) + " seconds");
            } else if (verifyResponse.status === "INVALID_TOTP_ERROR") {
                window.alert("Totp incorrect. Please try again");
            } else {
                // Device verified successfully
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("TOTP device verification can only happen after the first factor is complete and when a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx

async function verifyTotpDevice(deviceName: string, userInputTotp: string) {
    if (await supertokensSession.doesSessionExist()) {
        try {
            let verifyResponse = await supertokensTotp.verifyDevice({
                deviceName,
                totp: userInputTotp,
            });
            if (verifyResponse.status === "UNKNOWN_DEVICE_ERROR") {
                // this can happen due to a race condition wherein the device is deleted before verifying.
                window.alert("Something went wrong. Please reload and try again");
            } else if (verifyResponse.status === "LIMIT_REACHED_ERROR") {
                // this can happen if the user has entered a wrong TOTP too many times.
                window.alert("Totp incorrect. Please try again in " + (verifyResponse.retryAfterMs / 1000) + " seconds");
            } else if (verifyResponse.status === "INVALID_TOTP_ERROR") {
                window.alert("Totp incorrect. Please try again");
            } else {
                // Device verified successfully
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("TOTP device verification can only happen after the first factor is complete and when a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

The above API call returns the following response:

```json
{
        "status": "OK",
        "wasAlreadyVerified": false
} | {
        "status": "INVALID_TOTP_ERROR",
        "currentNumberOfFailedAttempts": 1,
        "maxNumberOfFailedAttempts": 5
} | {
        "status": "LIMIT_REACHED_ERROR",
        "retryAfterMs": 900000
} | {
        "status": "UNKNOWN_DEVICE_ERROR" | "GENERAL_ERROR"
}
```

</Tab>

</Tabs>

- The `deviceName`, which is an input to the API is one of the props returned from the previous API call to create a device.
- When verification is successful (`status: "OK"`), the device is marked as verified in the database and can be used for the TOTP challenge next time around. The boolean `wasAlreadyVerified` indicates if the device was already verified before this call was made.
- A status of `INVALID_TOTP_ERROR` means that the user has entered the an incorrect TOTP and needs to retry. The response contains two other props:
    - `currentNumberOfFailedAttempts`: The number of times the user has entered an incorrect TOTP so far.
    - `maxNumberOfFailedAttempts`: The maximum number of times the user can enter an incorrect TOTP before they are asked to wait (see `status: LIMIT_REACHED_ERROR`). This is set to 5 by default in the core. You can change this value by setting the `totp_max_attempts` in the core config.
- A status of `LIMIT_REACHED_ERROR` indicates that the user has entered an incorrect TOTP too many times and must wait before trying again (otherwise even value TOTPs will fail). The waiting period is indicated by the `retryAfterMs` prop in the response body. By default, it is 15 minutes, but it can be changed by setting the value for `totp_rate_limit_cooldown_sec` in the core config.
- A status of `UNKNOWN_DEVICE_ERROR` is possible due to a race condition in which the device is somehow deleted before the verification call is made.
- A status of `GENERAL_ERROR` is possible if you specifically return that from a backend API override.

On successful verification of a device, the `totp` factor is marked as completed and the `v` value is updated in the session based on if there are any more factors that the user needs to complete. The next step would be to check this `v` value in the MFA claim and redirect the user to the application page, or get information about the next factor using the [MFA info endpoint](../frontend-setup#mfa-info-endpoint).

#### Case 2 implementation: User needs to complete the TOTP challenge

This case is when the user already has a device setup (`totp` is in `factorsThatAreAlreadySetup`), and needs to complete the TOTP challenge. In this case, you should show the user an input box asking them to enter their TOTP from the authenticator app and then call the following API:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function verifyTotpCode(userInputTotp: string) {
    if (await Session.doesSessionExist()) {
        try {
            let verifyResponse = await Totp.verifyCode({
                totp: userInputTotp,
            });
            if (verifyResponse.status === "LIMIT_REACHED_ERROR") {
                // this can happen if the user has entered a wrong TOTP too many times.
                window.alert("Totp incorrect. Please try again in " + (verifyResponse.retryAfterMs / 1000) + " seconds");
            } else if (verifyResponse.status === "INVALID_TOTP_ERROR") {
                window.alert("Totp incorrect. Please try again");
            } else {
                // Code verified successfully
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("TOTP code verification can only happen after the first factor is complete and when a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx

async function verifyTotpCode(userInputTotp: string) {
    if (await supertokensSession.doesSessionExist()) {
        try {
            let verifyResponse = await supertokensTotp.verifyCode({
                totp: userInputTotp,
            });
            if (verifyResponse.status === "LIMIT_REACHED_ERROR") {
                // this can happen if the user has entered a wrong TOTP too many times.
                window.alert("Totp incorrect. Please try again in " + (verifyResponse.retryAfterMs / 1000) + " seconds");
            } else if (verifyResponse.status === "INVALID_TOTP_ERROR") {
                window.alert("Totp incorrect. Please try again");
            } else {
                // Code verified successfully
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("TOTP code verification can only happen after the first factor is complete and when a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

The above API call returns the following response:

```json
{
        "status": "OK" | "UNKNOWN_USER_ID_ERROR"
} | {
        "status": "INVALID_TOTP_ERROR",
        "currentNumberOfFailedAttempts": 1,
        "maxNumberOfFailedAttempts": 5,
} | {
        "status": "LIMIT_REACHED_ERROR",
        "retryAfterMs": 900000,
} | {
        "status": "GENERAL_ERROR"
}
```

</Tab>

</Tabs>

- A `status: OK` indicates that verification was successful. SuperTokens tries and verifies the input TOTP against all verified devices that belong to this user.
- A status of `INVALID_TOTP_ERROR` means that the user has entered the an incorrect TOTP and needs to retry. The response contains two other props:
    - `currentNumberOfFailedAttempts`: The number of times the user has entered an incorrect TOTP so far.
    - `maxNumberOfFailedAttempts`: The maximum number of times the user can enter an incorrect TOTP before they are asked to wait (see `status: LIMIT_REACHED_ERROR`). This is set to 5 by default in the core. You can change this value by setting the `totp_max_attempts` in the core config.
- A status of `LIMIT_REACHED_ERROR` indicates that the user has entered an incorrect TOTP too many times and must wait before trying again (otherwise even value TOTPs will fail). The waiting period is indicated by the `retryAfterMs` prop in the response body. By default, it is 15 minutes, but it can be changed by setting the value for `totp_rate_limit_cooldown_sec` in the core config.
- A status of `UNKNOWN_USER_ID_ERROR` is possible due to a race condition in which all devices that the user had are deleted by the time this API is called. In this case, you can ask users to setup a new device.
- A status of `GENERAL_ERROR` is possible if you specifically return that from a backend API override.

On successful verification of the code, the `totp` factor is marked as completed and the `v` value is updated in the session based on if there are any more factors that the user needs to complete. The next step would be to check this `v` value in the MFA claim and redirect the user to the application page, or get information about the next factor using the [MFA info endpoint](../frontend-setup#mfa-info-endpoint).

</CustomUIInstructions>

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

In a multi tenancy setup, you may want to enable TOTP for all users, across all tenants, or for all users within specific tenants. For enabling for all users across all tenants, it's the same steps as in the [single tenant setup](#single-tenant-setup) section above, so in this section, we will focus on enabling TOTP for all users within specific tenants.

### 1. Configure the backend 

To start, we will initialise the TOTP and the MultiFactorAuth recipes in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        totp.init(),
        MultiFactorAuth.init()
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, totp

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        totp.init(),
        multifactorauth.init(),
    ],
)
```

</Tab>
</Tabs>

Unlike the single tenant setup, we do not provide any config to the `MultiFactorAuth` recipe cause all the necessary configuration will be done on a tenant level.

<Tabs>

<Tab value="nodejs">

To configure TOTP requirement for a tenant, we can call the following API:

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: [
            MultiFactorAuth.FactorIds.EMAILPASSWORD,
            MultiFactorAuth.FactorIds.THIRDPARTY
        ],
        requiredSecondaryFactors: [MultiFactorAuth.FactorIds.TOTP]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

- In the above, we set the `firstFactors` to `["emailpassword", "thirdparty"]` to indicate that the first factor can be either `emailpassword` or `thirdparty`.
- We set the `requiredSecondaryFactors` to `["totp"]` to indicate that TOTP is required for all users in this tenant. The default implementation of `getMFARequirementsForAuth` in the `MultiFactorAuth` takes this into account.

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def create_new_tenant():
    resp = await create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD],
            required_secondary_factors=[FactorIds.TOTP],
        )
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

def create_new_tenant():
    resp = create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD],
            required_secondary_factors=[FactorIds.TOTP],
        )
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
</Tabs>

</Tab>

</Tabs>

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload will look like this:
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished `totp`, the payload will look like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "totp": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

### 2. Configure the frontend

<PrebuiltUIInstructions>

We start by modifying the `init` function call on the frontend like so:

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        // other recipes...
        // highlight-start
        totp.init(),
        MultiFactorAuth.init(),
        Multitenancy.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getTenantId: async (context) => {
                            return "TODO"
                        }
                    }
                }
            }
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You will have to make changes to the auth route config, as well as to the `supertokens-web-js` SDK config at the root of your application:

This change is in your auth route config.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        // other recipes...
        // highlight-start
        supertokensUITOTP.init(),
        supertokensUIMultiFactorAuth.init(),
        supertokensUIMultitenancy.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getTenantId: async (context) => {
                            return "TODO"
                        }
                    }
                }
            }
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK config at the root of your application:

```tsx

supertokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // highlight-start
        Session.init(),
        MultiFactorAuth.init(),
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

- Just like on the backend, we init the `totp` recipe in the `recipeList`.
- We also init the `MultiFactorAuth` recipe. Notice that unlike the single tenant setup, we do not specify the `firstFactors` here. That information is fetched based on the tenantId you provide the SDK with.
- We have set `usesDynamicLoginMethods: true` so that the SDK knows to fetch the login methods dynamically based on the tenantId.
- Finally, we init the multi tenancy recipe and provide a method for getting the tenantId. 

Next, we need to add the TOTP pre-built UI when rendering the SuperTokens component:

<Tabs>

<Tab value="reactjs">

<Question
    question="Do you use react-router-dom?">
<Answer title="Yes">

```tsx

function App() {
  return (
    <SuperTokensWrapper>
      <div className="App">
        <Router>
          <div className="fill">
            <Routes>
              // highlight-start 
              {getSuperTokensRoutesForReactRouterDom(reactRouterDOM, [/* ... */ TOTPPreBuiltUI, MultiFactorAuthPreBuiltUI])}
              // highlight-end 
              // ... other routes
            </Routes>
          </div>
        </Router>
      </div>
    </SuperTokensWrapper>
  );
}
```

</Answer>

<Answer title="No">

```tsx

function App() {
  // highlight-start
  if (canHandleRoute([/* ... */ TOTPPreBuiltUI, MultiFactorAuthPreBuiltUI])) {
      return getRoutingComponent([/* ... */ TOTPPreBuiltUI, MultiFactorAuthPreBuiltUI])
  }
  // highlight-end
  return (
    <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
  );
}
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::success
This step is not required for non React apps, since all the pre-built UI components are already added into the bundle.
:::

</Tab>

</Tabs>

With the above configuration, users will see the first and second factor based on the tenant configuration. For the tenant we configured above, users will see email password or social login first. After completing that, users will be redirected to `/auth/mfa/totp` (assuming that the `websiteBasePath` is `/auth`) where they will be asked to setup the factor, or complete the TOTP challenge if they have already setup the factor before. The UI for this screen looks like:
- [Factor Setup UI](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--device-setup-with-single-next-option)
- [Verification UI](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--verification-with-single-next-option) (In case the factor is already setup before).

</PrebuiltUIInstructions>

<CustomUIInstructions>

The steps here are the same as in [the single tenant setup above](#frontend-setup).

</CustomUIInstructions>

</TenantType.MultiTenantContent>

# Additional Verification - Multi Factor Authentication - TOTP -  Require TOTP for specific users
Source: https://supertokens.com/docs/additional-verification/mfa/totp/totp-for-opt-in-users

## Overview

In this page, we will show you how to implement an MFA policy that requires certain users to do TOTP. You can decide which those users are based on any criteria. For example:
- Only users that have an `admin` role require to do TOTP; OR
- Only users that have enabled TOTP on their account require to do TOTP; OR
- Only users that have a paid account require to do TOTP.

Whatever the criteria is, the steps to implementing this type of a flow is the same.

## Before you start

The tutorial assumes that the first factor is email password or social login, but the same set of steps are applicable for other first factor types.



## Steps

<TenantType.Switch />

<TenantType.SingleTenantContent>

### 1. Configure the backend

#### Enable TOTP for users that have an `admin` role

To start with, we configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        UserRoles.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-next-line
        totp.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            let roles = await UserRoles.getRolesForUser(input.tenantId, (await input.user).id)
                            if (roles.roles.includes("admin")) {
                                // we only want totp for admins
                                return [MultiFactorAuth.FactorIds.TOTP]
                            } else {
                                // no MFA for non admin users.
                                return []
                            }
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, totp
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.recipe.userroles.asyncio import get_roles_for_user

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # Get roles for the user
        roles = await get_roles_for_user(tenant_id, (await user()).id)

        if "admin" in roles.roles:
            # We only want OTP_EMAIL for admins
            return [FactorIds.TOTP]
        else:
            # No MFA for non-admin users
            return []

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        totp.init(),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

We override the `getMFARequirementsForAuth` function to indicate that `totp` must be completed only for users that have the `admin` role. You can also have any other criteria here.

#### Ask for TOTP only for users that have enabled TOTP on their account

To start with, we configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        totp.init({
            override: {
                apis: (oI) => {
                    return {
                        ...oI,
                        verifyDevicePOST: async function (input) {
                            let response = await oI.verifyDevicePOST!(input);
                            if (response.status === "OK") {
                                // device successfully verified. We save that this user has enabled TOTP in the user metadata.
                                // The multifactorauth recipe will pick this value up next time the user is trying to login, and
                                // ask them to enter the TOTP code.
                                await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(input.session.getUserId(), MultiFactorAuth.FactorIds.TOTP);
                            }
                            return response;
                        }
                    }
                }
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
        })
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, totp
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
)
from typing import Dict, Any
from supertokens_python.recipe.totp.types import (
    TOTPConfig,
    OverrideConfig,
    VerifyDeviceOkResult,
)
from supertokens_python.recipe.totp.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
)

def totp_override(original_implementation: APIInterface):
    original_verify_device_post = original_implementation.verify_device_post

    async def verify_device_post(
        device_name: str,
        totp: str,
        options: APIOptions,
        session: SessionContainer,
        user_context: Dict[str, Any],
    ):
        response = await original_verify_device_post(
            device_name, totp, options, session, user_context
        )
        if isinstance(response, VerifyDeviceOkResult):
            await add_to_required_secondary_factors_for_user(
                session.get_user_id(), FactorIds.TOTP
            )
        return response

    original_implementation.verify_device_post = verify_device_post
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        totp.init(TOTPConfig(override=OverrideConfig(apis=totp_override))),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY]
        ),
    ],
)
```

</Tab>
</Tabs>

We initialise the multi factor auth recipe here without any override to `getMFARequirementsForAuth`. The default implementation of this function already checks what factors are enabled for a user and returns those. Therefore all we need to do is mark `totp` as enabled for a user as soon as they have setup a device successfully. This happens in the `verifyDevicePOST` API override as shown above. Once a device is verified, we mark the `totp` factor as enabled for the user, and the next time they login, they will be asked to complete the TOTP challenge.

In both of the examples above, notice that we have initialised the TOTP recipe in the `recipeList`. Here are some of the configrations you can add to the `totp.init` function:
- `issuer`: This is the name that will show up in the TOTP app for the user. By default, this is equal to the `appName` config, however, you can change it to something else using this property.
- `defaultSkew`: The default value of this is `1`, which means that TOTP codes that were generated 1 tick before, and that will be generated 1 tick after from the current tick will be accepted at any given time (including the TOTP of the current tick, of course).
-  `defaultPeriod`: The default value of this is `30`, which means that the current tick is value for 30 seconds. By default, a TOTP code that's shown to the user, is valid for 60 seconds (`defaultPeriod + defaultSkew*defaultPeriod` seconds)

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload will look like this (for those that require TOTP):
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished TOTP, the payload will look like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "totp": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

### 2. Configure the frontend

Two parts exist to this:
- Configuring the frontend to show the TOTP UI when required during login / sign up
- Allowing users to enable / disable TOTP on their account via the settings page (If you are following Example 2 from above).

The first part is identical to the steps mentioned in [this section](./totp-for-all-users#frontend-setup), please follow that.

The second part, which is only applicable in case you want to allow users to enable / disable TOTP themselves, can be achieved by creating the following flow on your frontend:
- When the user navigates to their settings page, you can show them if TOTP is enabled or not.
- If enabled, you can show them a list of current TOTP devices with options to remove any.
- If enabled, you can show them an option to add a new TOTP device.

In order to know if the user has enabled TOTP, you can make an API your backend which calls the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function isTotpEnabledForUser(userId: string) {
    let factors = await MultiFactorAuth.getRequiredSecondaryFactorsForUser(userId)
    return factors.includes(MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def is_totp_factor_enabled_for_user(user_id: str) -> bool:
    factors = await get_required_secondary_factors_for_user(user_id, {})
    return FactorIds.TOTP in factors
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

def is_totp_factor_enabled_for_user(user_id: str) -> bool:
    factors = get_required_secondary_factors_for_user(user_id, {})
    return FactorIds.TOTP in factors
```

</Tab>
</Tabs>

</Tab>
</Tabs>

If the user wants to enable or disable TOTP for them, you can make an API on your backend which calls the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function enableMFAForUser(userId: string) {
    await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.TOTP)
}

async function disableMFAForUser(userId: string) {
    await MultiFactorAuth.removeFromRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
    remove_from_required_secondary_factors_for_user,
)
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def enable_mfa_for_user(user_id: str) -> None:
    await add_to_required_secondary_factors_for_user(user_id, FactorIds.TOTP)

async def disable_mfa_for_user(user_id: str) -> None:
    await remove_from_required_secondary_factors_for_user(user_id, FactorIds.TOTP)
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import (
    add_to_required_secondary_factors_for_user,
    remove_from_required_secondary_factors_for_user,
)
from supertokens_python.recipe.multifactorauth.types import FactorIds

def enable_mfa_for_user(user_id: str) -> None:
    add_to_required_secondary_factors_for_user(user_id, FactorIds.OTP_EMAIL)

def disable_mfa_for_user(user_id: str) -> None:
    remove_from_required_secondary_factors_for_user(user_id, FactorIds.OTP_EMAIL)
```

</Tab>
</Tabs>

</Tab>
</Tabs>

In order to list existing TOTP devices on the frontend, you can call the following API:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function fetchTOTPDevices() {
    if (await Session.doesSessionExist()) {
        try {
            let totpDevicesResponse = await Totp.listDevices();
            for (let i = 0; i < totpDevicesResponse.devices.length; i++) {
                let currDevice = totpDevicesResponse.devices[i];
                console.log(currDevice.name) // by default, this will be like "TOTP Device 1"
                console.log(currDevice.verified)
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx

async function fetchTOTPDevices() {
    if (await supertokensSession.doesSessionExist()) {
        try {
            let totpDevicesResponse = await supertokensTotp.listDevices();
            for (let i = 0; i < totpDevicesResponse.devices.length; i++) {
                let currDevice = totpDevicesResponse.devices[i];
                console.log(currDevice.name) // by default, this will be like "TOTP Device 1"
                console.log(currDevice.verified)
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

Notice that the API call requires the session's access token as an input (this should be added by our frontend SDK automatically):

```bash
curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/totp/device/list' \
--header 'Authorization: Bearer ...'
```

The output from the API call is as follows:

```json
{
    "status": "OK",
    "devices": {
        "name": "TOTP Device 1",
        "period": 30,
        "skew": 1,
        "verified": true
    }[];
} | {
    "status": "GENERAL_ERROR"
}
```

</Tab>

</Tabs>

- A `status: OK` will contain the list of all devices that exist for this user, across all of the user's tenants. We recommend only showing the devices that are `verified` to the user.
- A `status: GENERAL_ERROR`: This is possible if you have overridden the backend API to send back a custom error message which should be displayed on the frontend

In order to remove a device, you can call the following API from the frontend:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function removeTOTPDevices(deviceName: string) {
    if (await Session.doesSessionExist()) {
        try {
            await Totp.removeDevice({
                deviceName
            });
            // device is removed
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx

async function removeTOTPDevices(deviceName: string) {
    if (await supertokensSession.doesSessionExist()) {
        try {
            await supertokensTotp.removeDevice({
                deviceName
            });
            // device is removed
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

Notice that the API call requires the session's access token as an input (this should be added by our frontend SDK automatically):

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/totp/device/remove' \
--header 'Authorization: Bearer ...'
--header 'Content-Type: application/json' \
--data-raw '{
    "deviceName": "..."
}'
```

The output from the API call is as follows:

```json
{
    "status": "OK",
    "didDeviceExist": true;
} | {
    "status": "GENERAL_ERROR"
}
```

</Tab>

</Tabs>



<PrebuiltUIInstructions>

<Tabs>
<Tab value="reactjs">

In order to add a new device, you can call the following function from the frontend. This function will redirect the user to the TOTP create device pre-built UI. After the user has finished the new device creation and verification, they will be redirected back to the current page:

```tsx

async function redirectToTotpSetupScreen() {
    MultiFactorAuth.redirectToFactor({
        factorId: "totp",
        forceSetup: true,
        redirectBack: true,
    })
}
```

- In the snippet above, we redirect to the [TOTP factor setup screen](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--device-setup-with-single-next-option). We set the `forceSetup` to `true` since we want the user to setup a new TOTP device. The `redirectBack` boolean is also `true` since we want to redirect back to the current page after the user has finished setting up the device.
- You can also redirect the user to `/{websiteBasePath}/mfa/totp?setup=true&redirectToPath={currentPath}` if you don't want to use the above function.

</Tab>

<Tab value="angular">

In order to add a new device, you can redirect the user to `/{websiteBasePath}/mfa/totp?setup=true&redirectToPath={currentPath}` from your settings page. This will show the [TOTP factor setup screen](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--device-setup-with-single-next-option) to the user:
- We add the query param of `setup=true` because we want to create a new device.
- The `redirectToPath` query param will also tell our SDK to redirect the user back to the current page after they have finished creating the device.

</Tab>

</Tabs>

After the user has finished creating a device, our backend override for `verifyDevicePOST` (see "Example 2" in [Backend setup section](#backend-setup) above) will add TOTP as a required factor for this user, ensuring that next time they login, they will be asked to complete the TOTP challenge.

</PrebuiltUIInstructions>

<CustomUIInstructions>

In order to create a new device, you should redirect the user to a page which creates a new TOTP device on the backend, asks the user to scan the QR code and then to enter the TOTP in order to verify the new device. This can be achieved by calling the functions mentioned in [this section](./totp-for-all-users#case-1-implementation-user-needs-to-setup-a-new-totp-device--cust).

</CustomUIInstructions>

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

### 1. Configure the backend 

A user can be a part of multiple tenants. If you want TOTP to be enabled for a specific user across all the tenants that they are a part of, the steps are the same as in the [Backend setup](#backend-setup) section above.

However, if you want TOTP to be enabled for a specific user, for a specific tenant (or a sub set of tenants that the user is a part of), then you will have to add additional logic to the `getMFARequirementsForAuth` function override. Modifying the example code from the [Backend setup](#backend-setup) section above:

#### Only enable TOTP for users that have an `admin` role

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        UserRoles.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-next-line
        totp.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            let roles = await UserRoles.getRolesForUser(input.tenantId, (await input.user).id)
                            // highlight-next-line
                            if (roles.roles.includes("admin") && (await input.requiredSecondaryFactorsForTenant).includes(MultiFactorAuth.FactorIds.TOTP)) {
                                // we only want totp for admins
                                return [MultiFactorAuth.FactorIds.TOTP]
                            } else {
                                // no MFA for non admin users.
                                return []
                            }
                        }
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, totp
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.recipe.userroles.asyncio import get_roles_for_user

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # Get roles for the user
        roles = await get_roles_for_user(tenant_id, (await user()).id)

        if (
            "admin" in roles.roles
            and FactorIds.TOTP in await required_secondary_factors_for_tenant()
        ):
            # We only want OTP_EMAIL for admins
            return [FactorIds.TOTP]
        else:
            # No MFA for non-admin users
            return []

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
        totp.init(),
    ],
)
```

</Tab>
</Tabs>

- The implementation of `shouldRequireTotpForTenant` is entirely up to you.

#### Ask for TOTP only for users that have enabled TOTP on their account

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        totp.init({
            override: {
                apis: (oI) => {
                    return {
                        ...oI,
                        verifyDevicePOST: async function (input) {
                            let response = await oI.verifyDevicePOST!(input);
                            if (response.status === "OK") {
                                // device successfully verified. We save that this user has enabled TOTP in the user metadata.
                                // The multifactorauth recipe will pick this value up next time the user is trying to login, and
                                // ask them to enter the TOTP code.
                                await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(input.session.getUserId(), MultiFactorAuth.FactorIds.TOTP);
                            }
                            return response;
                        }
                    }
                }
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            if ((await input.requiredSecondaryFactorsForUser).includes(MultiFactorAuth.FactorIds.TOTP)) {
                                // this means that the user has finished setting up a device from their settings page.
                                if ((await input.requiredSecondaryFactorsForTenant).includes(MultiFactorAuth.FactorIds.TOTP)) {
                                    return [MultiFactorAuth.FactorIds.TOTP]
                                }
                            }
                            // no totp required for input.user, with the input.tenant.
                            return []
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, totp
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig as MFAOverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List
from supertokens_python.recipe.totp.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.totp.types import (
    TOTPConfig,
    OverrideConfig,
    VerifyDeviceOkResult,
)

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        if FactorIds.TOTP in await required_secondary_factors_for_user():
            if FactorIds.TOTP in await required_secondary_factors_for_tenant():
                return [FactorIds.TOTP]
        # no otp-email required for input.user, with the input.tenant.
        return []

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

def totp_override(original_implementation: APIInterface):
    original_verify_device_post = original_implementation.verify_device_post

    async def verify_device_post(
        device_name: str,
        totp: str,
        options: APIOptions,
        session: SessionContainer,
        user_context: Dict[str, Any],
    ):
        response = await original_verify_device_post(
            device_name, totp, options, session, user_context
        )
        if isinstance(response, VerifyDeviceOkResult):
            await add_to_required_secondary_factors_for_user(
                session.get_user_id(), FactorIds.TOTP
            )
        return response

    original_implementation.verify_device_post = verify_device_post
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        totp.init(TOTPConfig(override=OverrideConfig(apis=totp_override))),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=MFAOverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

- We provide an override for `getMFARequirementsForAuth` which checks if TOTP is enabled for the user, and also take into account the tenantId to decide if we want to have this user go through the TOTP flow whilst logging into this tenant. The implementation of `shouldRequireTotpForTenant` is entirely up to you.

### 2. Configure the frontend 

Two parts exist to this:
- Configuring the frontend to show the TOTP UI when required during login / sign up
- Allowing users to enable / disable TOTP on their account via the settings page (If you are following Example 2 from above).

The first part is identical to the steps mentioned in [this section](/docs/additional-verification/mfa/totp/totp-for-all-users#2-configure-the-), so please follow that.

The second part, which is only applicable in case you want to allow users to enable / disable TOTP themselves, can be achieved by creating the following flow on your frontend:
- When the user navigates to their settings page, you can show them if TOTP is enabled or not.
- If enabled, you can show them a list of current TOTP devices with options to remove any.
- If enabled, you can show them an option to add a new TOTP device.

In order to know if the user has enabled TOTP, you can make an API your backend which calls the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function isTotpEnabledForUser(userId: string) {
    let factors = await MultiFactorAuth.getRequiredSecondaryFactorsForUser(userId)
    return factors.includes(MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def is_totp_factor_enabled_for_user(user_id: str) -> bool:
    factors = await get_required_secondary_factors_for_user(user_id, {})
    return FactorIds.TOTP in factors
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

def is_totp_factor_enabled_for_user(user_id: str) -> bool:
    factors = get_required_secondary_factors_for_user(user_id, {})
    return FactorIds.TOTP in factors
```

</Tab>
</Tabs>

</Tab>
</Tabs>

If the user wants to enable or disable TOTP for them, you can make an API on your backend which calls the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function enableMFAForUser(userId: string) {
    await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.TOTP)
}

async function disableMFAForUser(userId: string) {
    await MultiFactorAuth.removeFromRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.TOTP)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
    remove_from_required_secondary_factors_for_user,
)
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def enable_mfa_for_user(user_id: str) -> None:
    await add_to_required_secondary_factors_for_user(user_id, FactorIds.TOTP)

async def disable_mfa_for_user(user_id: str) -> None:
    await remove_from_required_secondary_factors_for_user(user_id, FactorIds.TOTP)
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multifactorauth.syncio import (
    add_to_required_secondary_factors_for_user,
    remove_from_required_secondary_factors_for_user,
)
from supertokens_python.recipe.multifactorauth.types import FactorIds

def enable_mfa_for_user(user_id: str) -> None:
    add_to_required_secondary_factors_for_user(user_id, FactorIds.OTP_EMAIL)

def disable_mfa_for_user(user_id: str) -> None:
    remove_from_required_secondary_factors_for_user(user_id, FactorIds.OTP_EMAIL)
```

</Tab>
</Tabs>

</Tab>
</Tabs>

In order to list existing TOTP devices on the frontend, you can call the following API:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function fetchTOTPDevices() {
    if (await Session.doesSessionExist()) {
        try {
            let totpDevicesResponse = await Totp.listDevices();
            for (let i = 0; i < totpDevicesResponse.devices.length; i++) {
                let currDevice = totpDevicesResponse.devices[i];
                console.log(currDevice.name) // by default, this will be like "TOTP Device 1"
                console.log(currDevice.verified)
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx

async function fetchTOTPDevices() {
    if (await supertokensSession.doesSessionExist()) {
        try {
            let totpDevicesResponse = await supertokensTotp.listDevices();
            for (let i = 0; i < totpDevicesResponse.devices.length; i++) {
                let currDevice = totpDevicesResponse.devices[i];
                console.log(currDevice.name) // by default, this will be like "TOTP Device 1"
                console.log(currDevice.verified)
            }
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

Notice that the API call requires the session's access token as an input (this should be added by our frontend SDK automatically):

```bash
curl --location --request GET '<API_DOMAIN><API_BASE_PATH>/totp/device/list' \
--header 'Authorization: Bearer ...'
```

The output from the API call is as follows:

```json
{
    "status": "OK",
    "devices": {
        "name": "TOTP Device 1",
        "period": 30,
        "skew": 1,
        "verified": true
    }[];
} | {
    "status": "GENERAL_ERROR"
}
```

</Tab>

</Tabs>

- A `status: OK` will contain the list of all devices that exist for this user, across all of the user's tenants. We recommend only showing the devices that are `verified` to the user.
- A `status: GENERAL_ERROR`: This is possible if you have overridden the backend API to send back a custom error message which should be displayed on the frontend

In order to remove a device, you can call the following API from the frontend:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

async function removeTOTPDevices(deviceName: string) {
    if (await Session.doesSessionExist()) {
        try {
            await Totp.removeDevice({
                deviceName
            });
            // device is removed
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

<Tab value="scripts">

```tsx

async function removeTOTPDevices(deviceName: string) {
    if (await supertokensSession.doesSessionExist()) {
        try {
            await supertokensTotp.removeDevice({
                deviceName
            });
            // device is removed
        } catch (err: any) {
            if (err.isSuperTokensGeneralError === true) {
                // this may be a custom error message sent from the API by you.
                window.alert(err.message);
            } else {
                window.alert("Oops! Something went wrong.");
            }
        }
    } else {
        throw new Error("Illegal function call: Please only call this function if a session exists")
    }
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

<AppInfoForm askForAPIDomain />

Notice that the API call requires the session's access token as an input (this should be added by our frontend SDK automatically):

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/totp/device/remove' \
--header 'Authorization: Bearer ...'
--header 'Content-Type: application/json' \
--data-raw '{
    "deviceName": "..."
}'
```

The output from the API call is as follows:

```json
{
    "status": "OK",
    "didDeviceExist": true;
} | {
    "status": "GENERAL_ERROR"
}
```

</Tab>

</Tabs>



<PrebuiltUIInstructions>

<Tabs>
<Tab value="reactjs">

In order to add a new device, you can call the following function from the frontend. This function will redirect the user to the TOTP create device pre-built UI. After the user has finished the new device creation and verification, they will be redirected back to the current page:

```tsx

async function redirectToTotpSetupScreen() {
    MultiFactorAuth.redirectToFactor({
        factorId: "totp",
        forceSetup: true,
        redirectBack: true,
    })
}
```

- In the snippet above, we redirect to the [TOTP factor setup screen](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--device-setup-with-single-next-option). We set the `forceSetup` to `true` since we want the user to setup a new TOTP device. The `redirectBack` boolean is also `true` since we want to redirect back to the current page after the user has finished setting up the device.
- You can also redirect the user to `/{websiteBasePath}/mfa/totp?setup=true&redirectToPath={currentPath}` if you don't want to use the above function.

</Tab>

<Tab value="angular">

In order to add a new device, you can redirect the user to `/{websiteBasePath}/mfa/totp?setup=true&redirectToPath={currentPath}` from your settings page. This will show the [TOTP factor setup screen](https://6571be2867f75556541fde98-xieqfaxuuo.chromatic.com/?path=/story/totp-mfa--device-setup-with-single-next-option) to the user:
- We add the query param of `setup=true` because we want to create a new device.
- The `redirectToPath` query param will also tell our SDK to redirect the user back to the current page after they have finished creating the device.

</Tab>

</Tabs>

After the user has finished creating a device, our backend override for `verifyDevicePOST` (see "Example 2" in [Backend setup section](#1-configure-the-backend) above) will add TOTP as a required factor for this user, so that next time they login, they will be asked to complete the TOTP challenge.

</PrebuiltUIInstructions>

<CustomUIInstructions>

In order to create a new device, you should redirect the user to a page which creates a new TOTP device on the backend, asks the user to scan the QR code and then to enter the TOTP in order to verify the new device. This can be achieved by calling the functions mentioned in [this section](./totp-for-all-users#case-1-implementation-user-needs-to-setup-a-new-totp-device--cust).

</CustomUIInstructions>

</TenantType.MultiTenantContent>

# Additional Verification - Multi Factor Authentication - OTP -  OTP required for all users
Source: https://supertokens.com/docs/additional-verification/mfa/email-sms-otp/otp-for-all-users

This page shows how to implement an MFA policy that requires all users to complete an OTP challenge before accessing your application. The OTP can be sent via email or phone.

:::note
Assume that the first factor is email password or social login, but the same set of steps applies to other first factor types as well.
:::

## Single tenant setup

### Backend setup
To start with, configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE"
        }),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        // highlight-end
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            return [MultiFactorAuth.FactorIds.OTP_EMAIL]
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, accountlinking
from supertokens_python.recipe.multifactorauth.types import FactorIds, OverrideConfig, MFARequirementList
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import (
    AccountInfoWithRecipeIdAndUserId,
    ShouldNotAutomaticallyLink,
    ShouldAutomaticallyLink,
)
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List, Optional, Union

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any]
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()
    
    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the 
        # new_account_info to the session user, which means it's an MFA flow, so we enable 
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)
    
    return ShouldNotAutomaticallyLink()

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # highlight-next-line
        return [FactorIds.OTP_EMAIL]

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
        accountlinking.init(should_do_automatic_account_linking=should_do_automatic_account_linking)
    ],
)
```

</Tab>
</Tabs>

- Notice that the Passwordless recipe initializes in the `recipeList`. In this example, only email-based OTP is enabled, with `contactMethod` set to `EMAIL` and `flowType` to `USER_INPUT_CODE` (that is, `otp`). If you want to use phone SMS-based OTP, set the contact method to `PHONE`. If you want to give users both options, or for some users use email, and for others use phone, set `contactMethod` to `EMAIL_OR_PHONE`.
- We have also enabled the account linking feature since it's required for MFA to work. The above enables account linking for second factor only, but if you also want to enable it for first factor, see [this section](/docs/post-authentication/account-linking/automatic-account-linking).
- Notice that `shouldRequireVerification: false` configures account linking. It means that the second factor can link to the first factor even though the first factor is not verified. If you want to do email verification of the first factor before setting up the second factor (for example if the first factor is email password, and the second is phone OTP), then you can set this boolean to `true`, and also init the email verification recipe on the frontend and backend in `REQUIRED` mode.
- The `getMFARequirementsForAuth` function is overridden to indicate that `otp-email` must be completed before the user can access the app. Notice that `userId` is not checked there, and `otp-email` is returned for all users. You can also return `otp-phone` instead if you want users to complete the OTP challenge via a phone SMS. Finally, if you want to give users an option for email or phone, you can return the following array from the function:

    ```json
    [{
        "oneOf": ["otp-email", "otp-phone"]
    }]
    ```

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload looks like this:
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished `otp-email`, the payload looks like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "otp-email": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

:::caution
If you are already using `Passwordless` or `ThirdPartyPasswordless` in your app as a first factor, you do not need to explicitly initialize the Passwordless recipe again. Ensure that the `contactMethod` and `flowType` are set correctly.
:::

### Frontend setup



<PrebuiltUIInstructions>

We start by modifying the `init` function call on the frontend like this:

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        ThirdParty.init(/* ... */),
        EmailPassword.init( /* ... */),
        // highlight-start
        Passwordless.init({
            contactMethod: "EMAIL"
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You have to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        supertokensUIThirdParty.init(/* ... */),
        supertokensUIEmailPassword.init( /* ... */),
        // highlight-start
        supertokensUIPasswordless.init({
            contactMethod: "EMAIL"
        }),
        supertokensUIMultiFactorAuth.init({
            firstFactors: [
                supertokensUIMultiFactorAuth.FactorIds.EMAILPASSWORD,
                supertokensUIMultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        Passwordless.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

- Like on the backend, the `passwordless` recipe initializes in the `recipeList`. The `contactMethod` needs to be consistent with the backend setting.
- The `MultiFactorAuth` recipe is also initialized, and the first factors to use are included. In this case, that would be `emailpassword` and `thirdparty` - same as the backend.

Next, add the Passwordless pre-built UI when rendering the SuperTokens component:

<Tabs>

<Tab value="reactjs">

<Question
    question="Do you use react-router-dom?">
<Answer title="Yes">

```tsx

function App() {
  return (
    <SuperTokensWrapper>
      <div className="App">
        <Router>
          <div className="fill">
            <Routes>
              // highlight-start 
              {getSuperTokensRoutesForReactRouterDom(reactRouterDOM, [EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])}
              // highlight-end 
              // ... other routes
            </Routes>
          </div>
        </Router>
      </div>
    </SuperTokensWrapper>
  );
}
```

</Answer>

<Answer title="No">

```tsx

function App() {
  // highlight-start
  if (canHandleRoute([EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])) {
      return getRoutingComponent([EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])
  }
  // highlight-end
  return (
    <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
  );
}
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::success
This step is not required for non React apps, since all the pre-built UI components are already added into the bundle.
:::

</Tab>

</Tabs>

With the above configuration, users see `emailpassword` or social login UI when they visit the auth page. After completing that, users redirect to `/auth/mfa/otp-email` (assuming that the `websiteBasePath` is `/auth`) where they are asked to complete the OTP challenge. The UI for this screen looks like:
- [Factor Setup UI](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/passwordless-mfa--setup-email) (This is in case the first factor doesn't provide an email for the user. In this example, the first factor does provide an email since it's email password or social login).
- [Verification UI](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/passwordless-mfa--verification).

:::caution
If you are already using `Passwordless` or `ThirdPartyPasswordless` in your app as a first factor, you do not need to explicitly initialize the Passwordless recipe again. Ensure that the `contactMethod` is set correctly.
:::

</PrebuiltUIInstructions>

<CustomUIInstructions>

We start by initializing the MFA and Passwordless recipe on the frontend like this:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        Passwordless.init()
        // highlight-end
    ],
});
```

</Tab>

<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        supertokensMultiFactorAuth.init(),
        supertokensPasswordless.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

:::success
This step is not applicable for mobile apps. Please continue reading.
:::

</Tab>

</Tabs>

After the first factor login, you should start by [checking the access token payload and see if the MFA claim's `v` boolean is `false`](../frontend-setup#step-2-checking-the---custv-boolean-value-in-the-mfa-claim--cust). If it's not, then the user can redirect to the application page.

If it's `false`, the frontend then needs to [call the MFA endpoint](../frontend-setup#mfa-info-endpoint) to get information about which factor the user should complete next. Based on the backend configuration in this page, the `next` array contains `["otp-email"]`.

Two possibilities exist here:
- Case 1: The user needs to set up an email to send the OTP to. This only happens if the first factor doesn't provide an email from the user (for example, if you used phone-based `otp` as the first factor). In this example on this doc, an email is always obtained from the first factor, so you do not need to build UI for this step (but this will still be discussed later on).
- Case 2: The user already has an email associated with them and need to complete the OTP challenge.

We can know which case it is by checking if the `emails` object returned from [MFA Info endpoint](../frontend-setup#mfa-info-endpoint) contains any emails associated with the `otp-email` key. If the `emails["otp-email"]` property of the response is `undefined` or an empty array, then it's case 1, else it's case 2.

#### Case 1 implementation: User needs to enter their email
In this case, a form needs to be created wherein the user can enter their email. Once they submit the form, the [`createCode` API](/docs/passwordless/custom-ui/login-otp) needs to be called.

After this API call, you can show the user the enter OTP screen, and call the [`consumeCode` API](/docs/passwordless/custom-ui/login-otp#step-3-verifying-the-input-otp). If the API call returns a `RESTART_FLOW_ERROR`, you can handle this by asking the user to enter their email once again and then call the `createCode` function.

#### Case 2 implementation: User needs to complete the OTP challenge

This case is when the user already has an email associated with their account and you can directly send a code to that email. You can get the email to send the code to from the result of the [MFA Info endpoint](../frontend-setup#mfa-info-endpoint). Specifically, from the response, you can read the email from the `emails` property like this: `emails["otp-email"][0]`. The first item in the array of email is picked since the emails are ordered based on:
- Index 0 contains the email that belongs to the session's user. If the user's first factor was email password, the email in the 0th index of the array is that email.
- The other emails in the array (if they exist), are from other login methods for this user ordered based on the oldest login method first.

You can even show a UI here asking the user to pick an email from the array if you like. Either way, when you have an email, you can call the [`createCode` API](/docs/passwordless/custom-ui/login-otp) to send the code to that email.

After this API call, you can show the user the enter OTP screen, and call the [`consumeCode` API](/docs/passwordless/custom-ui/login-otp#step-3-verifying-the-input-otp). If the API call returns a `RESTART_FLOW_ERROR`, you can handle this by calling the `createCode` function once again in the background.

:::note
Notice that in Case 2, there is no UI for the user to enter an email. That happens. The user only sees the enter OTP screen.
:::

We recommend that you add a sign out button when showing the second factor (case 1 or case 2) so that users can use this to escape out of the flow in case they are unable to complete the second factor. When the sign out button is clicked, you want to:
- Call the `await clearLoginAttemptInfo()` function (if on web) to clear the state that's set in the browser storage when calling the `createCode` function.
- Call the sign out function / API to clear the tokens.

On successful verification of the code, the `otp-email` factor is marked as completed and the `v` value is updated in the session based on if there are any more factors that the user needs to complete. The next step would be to check this `v` value in the MFA claim and redirect the user to the application page, or get information about the next factor using the [MFA info endpoint](../frontend-setup#mfa-info-endpoint).

</CustomUIInstructions>

## Multi tenant setup

In a multi-tenancy setup, you may want to enable email / phone OTP for all users, across all tenants, or for all users within specific tenants. For enabling for all users across all tenants, it's the same steps as in the [single tenant setup](#single-tenant-setup) section above, so in this section, we will focus on enabling OTP for all users within specific tenants.

### Backend setup

To start, initialize the Passwordless and the MultiFactorAuth recipes in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE"
        }),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        MultiFactorAuth.init()
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, accountlinking
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import (
    AccountInfoWithRecipeIdAndUserId,
    ShouldNotAutomaticallyLink,
    ShouldAutomaticallyLink,
)
from supertokens_python.types import User
from typing import Dict, Any, Optional, Union

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any]
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()
    
    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the 
        # new_account_info to the session user, which means it's an MFA flow, so we enable 
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)
    
    return ShouldNotAutomaticallyLink()

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(),
        accountlinking.init(should_do_automatic_account_linking=should_do_automatic_account_linking)
    ],
)
```

</Tab>
</Tabs>

Unlike the single tenant setup, no configuration is provided to the `MultiFactorAuth` recipe because all the necessary configuration is done on a tenant level.

<Tabs additionalValues={[{ value: "curl", label: "cURL" }, { value: "dashboard", label: "Dashboard" }]}>

<Tab value="nodejs">

To configure otp-email requirement for a tenant, the following API can be called:

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: [
            MultiFactorAuth.FactorIds.EMAILPASSWORD,
            MultiFactorAuth.FactorIds.THIRDPARTY
        ],
        requiredSecondaryFactors: [MultiFactorAuth.FactorIds.OTP_EMAIL]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

- In the above, the `firstFactors` are set to `["emailpassword", "thirdparty"]` to indicate that the first factor can be either `emailpassword` or `thirdparty`.
- The `requiredSecondaryFactors` is set to `["otp-email"]` to indicate that OTP email is required for all users in this tenant. The default implementation of `getMFARequirementsForAuth` in the `MultiFactorAuth` takes this into account.

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def create_new_tenant():
    resp = await create_or_update_tenant(
        "customer1",
        TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            required_secondary_factors=[FactorIds.OTP_EMAIL],
        ),
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

def create_new_tenant():
    resp = create_or_update_tenant(
        "customer1",
        TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            required_secondary_factors=[FactorIds.OTP_EMAIL],
        ),
    )
    

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
</Tabs>

</Tab>

<Tab value="curl">

To configure otp-email requirement for a tenant, the following API can be called:

```bash
curl --location --request PUT 'http://localhost:3567/recipe/multitenancy/tenant/v2' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "customer1",
    "firstFactors": ["emailpassword", "thirdparty"],
    "requiredSecondaryFactors": ["otp-email"]
}'
```

- In the above, the `firstFactors` are set to `["emailpassword", "thirdparty"]` to indicate that the first factor can be either `emailpassword` or `thirdparty`.
- The `requiredSecondaryFactors` is set to `["otp-email"]` to indicate that OTP email is required for all users in this tenant. The default implementation of `getMFARequirementsForAuth` in the `MultiFactorAuth` takes this into account.

</Tab>

<Tab value="dashboard" className="tab-with-background">

<img src="/img/dashboard/tenant-management/enable-tp-ep-emailotp.png" alt="Enable EmailPassword and ThirdParty, OTP-Email"/>

As shown above, enable **Email Password** and **Third Party** in the Login methods section and enable **OTP - Email** in the Secondary Factors Section.

</Tab>

</Tabs>

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload looks like this:
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished otp-email challenge, the payload looks like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "otp-email": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

:::caution
If you are already using `Passwordless` or `ThirdPartyPasswordless` in your app as a first factor, you do not need to explicitly initialize the Passwordless recipe again. Ensure that the `contactMethod` and `flowType` are set correctly.
:::

### Frontend setup

<PrebuiltUIInstructions>

We start by modifying the `init` function call on the frontend like this:

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        Passwordless.init({
            contactMethod: "EMAIL"
        }),
        MultiFactorAuth.init(),
        Multitenancy.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getTenantId: async (context) => {
                            return "TODO"
                        }
                    }
                }
            }
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You have to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    // highlight-next-line
    usesDynamicLoginMethods: true,
    recipeList: [
        supertokensUIThirdParty.init({
            //...
        }),
        supertokensUIEmailPassword.init({
            //...
        }),
        // highlight-start
        supertokensUIPasswordless.init({
            contactMethod: "EMAIL"
        }),
        supertokensUIMultiFactorAuth.init(),
        supertokensUIMultitenancy.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getTenantId: async (context) => {
                            return "TODO"
                        }
                    }
                }
            }
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

supertokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // highlight-start
        Session.init(),
        MultiFactorAuth.init(),
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

- Like on the backend, the `Passwordless` recipe initializes in the `recipeList`. Make sure that the configuration for it is consistent with what's on the backend.
- The `MultiFactorAuth` recipe is also initialized. Notice that unlike the single tenant setup, the `firstFactors` are not specified here. That information is fetched based on the `tenantId` you provide the SDK with.
- `usesDynamicLoginMethods: true` is set so that the SDK knows to fetch the login methods dynamically based on the `tenantId`.
- Finally, the multi-tenancy recipe initializes and a method for getting the `tenantId` is provided.

Next, add the Passwordless pre-built UI when rendering the SuperTokens component:

<Tabs>

<Tab value="reactjs">

<Question
    question="Do you use react-router-dom?">
<Answer title="Yes">

```tsx

function App() {
  return (
    <SuperTokensWrapper>
      <div className="App">
        <Router>
          <div className="fill">
            <Routes>
              // highlight-start 
              {getSuperTokensRoutesForReactRouterDom(reactRouterDOM, [EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])}
              // highlight-end 
              // ... other routes
            </Routes>
          </div>
        </Router>
      </div>
    </SuperTokensWrapper>
  );
}
```

</Answer>

<Answer title="No">

```tsx

function App() {
  // highlight-start
  if (canHandleRoute([EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])) {
      return getRoutingComponent([EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])
  }
  // highlight-end
  return (
    <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
  );
}
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::success
This step is not required for non React apps, since all the pre-built UI components are already added into the bundle.
:::

</Tab>

</Tabs>

With the above configuration, users see the first and second factor based on the tenant configuration. For the tenant configured above, users see email password or social login first. After completing that, users redirect to `/auth/mfa/otp-email` (assuming that the `websiteBasePath` is `/auth`) where they are asked to complete the OTP challenge. The UI for this screen looks like:
- [Factor Setup UI](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/passwordless-mfa--setup-email) (This is in case the first factor doesn't provide an email for the user. In this example, the first factor does provide an email since it's email password or social login).
- [Verification UI](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/passwordless-mfa--verification).

:::caution
If you are already using `Passwordless` or `ThirdPartyPasswordless` in your app as a first factor, you do not need to explicitly initialize the Passwordless recipe again. Ensure that the `contactMethod` is set correctly.
:::

</PrebuiltUIInstructions>

<CustomUIInstructions>

The steps here are the same as in [the single tenant setup above](#frontend-setup).

</CustomUIInstructions>

## Protecting frontend and backend routes

See the section on [protecting frontend and backend routes](../protect-routes).

## Email / SMS sending and design
By default, the email template used for otp-email login is [as shown here](https://github.com/SuperTokens/email-sms-templates?tab=readme-ov-file#otp-login), and the default SMS template is [as shown here](https://github.com/SuperTokens/email-sms-templates?tab=readme-ov-file#otp-login-1). The method for sending them is via an email and SMS sending service that is provided.

If you would like to learn more about this, or change the content of the email, or the method by which they are sent, checkout the email / SMS delivery section in the recipe docs:
- [Email delivery configuration](/docs/platform-configuration/email-delivery)
- [SMS delivery configuration](/docs/platform-configuration/sms-delivery)

# Additional Verification - Multi Factor Authentication - OTP -  OTP for specific users
Source: https://supertokens.com/docs/additional-verification/mfa/email-sms-otp/otp-for-opt-in-users

:::important
Before reading the below, please first go through the setup for [OTP for all users](./otp-for-all-users) to understand the basics of how MFA with OTP works, and then come back here.
:::

This page shows how to implement an MFA policy that requires certain users to do the OTP challenge via email or SMS. You can decide which users based on any criteria. For example:
- Only users that have an `admin` role require to do OTP; OR
- Only users that have enabled OTP on their account require to do OTP; OR
- Only users that have a paid account require to do OTP.

Whatever the criteria is, the steps to implementing this type of a flow is the same.

:::note
Assume that the first factor is email password or social login, but the same set of steps applies to other first factor types as well.
:::

## Single tenant setup

### Backend setup

#### Example 1: Only enable OTP for users that have an `admin` role

To start with, configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        UserRoles.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE"
        }),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            let roles = await UserRoles.getRolesForUser(input.tenantId, (await input.user).id)
                            if (roles.roles.includes("admin")) {
                                // we only want otp-email for admins
                                return [MultiFactorAuth.FactorIds.OTP_EMAIL]
                            } else {
                                // no MFA for non admin users.
                                return []
                            }
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, accountlinking
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import (
    AccountInfoWithRecipeIdAndUserId,
    ShouldNotAutomaticallyLink,
    ShouldAutomaticallyLink,
)
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List, Optional, Union
from supertokens_python.recipe.userroles.asyncio import get_roles_for_user

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any],
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()

    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the
        # new_account_info to the session user, which means it's an MFA flow, so we enable
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)

    return ShouldNotAutomaticallyLink()

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # Get roles for the user
        roles = await get_roles_for_user(tenant_id, (await user()).id)

        if "admin" in roles.roles:
            # We only want OTP_EMAIL for admins
            return [FactorIds.OTP_EMAIL]
        else:
            # No MFA for non-admin users
            return []

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
        accountlinking.init(
            should_do_automatic_account_linking=should_do_automatic_account_linking
        ),
    ],
)
```

</Tab>
</Tabs>

Override the `getMFARequirementsForAuth` function to indicate that `otp-email` applies only to users with the `admin` role. You can also have any other criteria here.

#### Example 2: Ask for OTP only for users that have enabled OTP on their account

To start with, configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE",
            override: {
                apis: (oI) => {
                    return {
                        ...oI,
                        consumeCodePOST: async function (input) {
                            let response = await oI.consumeCodePOST!(input);
                            if (response.status === "OK" && input.session !== undefined) {
                                // We do this only if a session exists, which means that it's not being called for first factor login.
                                
                                // OTP challenge completed successfully. We save that this user has enabled otp-email in the user metadata.
                                // The multifactorauth recipe will pick this value up next time the user is trying to login, and
                                // ask them to enter the OTP code.
                                await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(input.session.getUserId(), MultiFactorAuth.FactorIds.OTP_EMAIL);
                            }
                            return response;
                        }
                    }
                }
            }
        }),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, accountlinking
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import (
    AccountInfoWithRecipeIdAndUserId,
    ShouldNotAutomaticallyLink,
    ShouldAutomaticallyLink,
)
from supertokens_python.types import User
from typing import Dict, Any, Optional, Union
from supertokens_python.recipe import passwordless
from supertokens_python.recipe.passwordless.interfaces import (
    RecipeInterface,
    ConsumeCodeOkResult,
)
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
)

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any],
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()

    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the
        # new_account_info to the session user, which means it's an MFA flow, so we enable
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)

    return ShouldNotAutomaticallyLink()

def override_functions(original_implementation: RecipeInterface):
    original_consume_code = original_implementation.consume_code

    async def consume_code(
        pre_auth_session_id: str,
        user_input_code: Union[str, None],
        device_id: Union[str, None],
        link_code: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):
        response = await original_consume_code(
            pre_auth_session_id,
            user_input_code,
            device_id,
            link_code,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            user_context,
        )

        if isinstance(response, ConsumeCodeOkResult) and session is not None:
            await add_to_required_secondary_factors_for_user(
                session.get_user_id(), FactorIds.OTP_EMAIL
            )

        return response

    original_implementation.consume_code = consume_code
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            contact_config=passwordless.ContactEmailOnlyConfig(),
            flow_type="USER_INPUT_CODE",
            override=passwordless.InputOverrideConfig(functions=override_functions),
        ),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
        ),
        accountlinking.init(
            should_do_automatic_account_linking=should_do_automatic_account_linking
        ),
    ],
)
```

</Tab>
</Tabs>

- Initialize the multi-factor auth recipe here without any override to `getMFARequirementsForAuth`. The default implementation of this function already checks what factors a user has enabled and returns those. All that is needed is to mark `otp-email` as enabled for a user as soon as they have completed the OTP challenge successfully. This happens in the `consumeCodePOST` API override as shown above. Once the code is consumed successfully, mark the `otp-email` factor as enabled for the user, and the next time they login, they will be asked to complete the OTP challenge.
- Notice that before calling `addToRequiredSecondaryFactorsForUser`, check if there is an input session or not. Only call `addToRequiredSecondaryFactorsForUser` function if there is a session which indicates that the user has finished some first factor already.

In both of the examples above, notice that the Passwordless recipe initializes in the `recipeList`. In this example, only email-based OTP is enabled, set the `contactMethod` to `EMAIL` and `flowType` to `USER_INPUT_CODE` (that is, OTP). If instead, you want to use phone SMS-based OTP, set the contact method to `PHONE`. If you want to give users both options, or for some users use email, and for others use phone, set `contactMethod` to `EMAIL_OR_PHONE`.

We have also enabled the account linking feature since it's required for MFA to work. The above enables account linking for second factor only, but if you also want to enable it for first factor, see [this section](/docs/post-authentication/account-linking/automatic-account-linking).

Notice that `shouldRequireVerification: false` configures account linking. It means that the second factor can link to the first factor even though the first factor is not verified. If you want to do email verification of the first factor before setting up the second factor (for example if the first factor is email password, and the second is phone OTP), then set this boolean to `true`, and also init the email verification recipe on the frontend and backend in `REQUIRED` mode.

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload looks like this (for those that require OTP):
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished otp-email, the payload looks like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "otp-email": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should access the app.

:::caution
If you are already using `Passwordless` or `ThirdPartyPasswordless` in your app as a first factor, you do not need to explicitly initialize the Passwordless recipe again.
:::

### Frontend setup

This consists of two parts:
- Configuring the frontend to show the OTP challenge UI when required during login / sign up
- Allowing users to enable / disable OTP challenge on their account via the settings page (If you are following Example 2 from above).

The first part is identical to the steps mentioned in [this section](./otp-for-all-users#frontend-setup), please follow that.

The second part, which is only applicable in case you want to allow users to enable / disable OTP themselves, can be done by creating the following flow on your frontend:
- When the user navigates to their settings page, you can show them if OTP challenge is active or not.
- If enabled, you can allow them to disable it, or vice versa.

To know if the user has enabled OTP, you can make an API your backend which calls the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function isOTPEmailEnabledForUser(userId: string) {
    let factors = await MultiFactorAuth.getRequiredSecondaryFactorsForUser(userId)
    return factors.includes(MultiFactorAuth.FactorIds.OTP_EMAIL)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python.recipe.multifactorauth.asyncio import get_required_secondary_factors_for_user
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def is_otp_email_factor_enabled_for_user(user_id: str) -> bool:
    factors = await get_required_secondary_factors_for_user(user_id, {})
    return FactorIds.OTP_EMAIL in factors
```

</Tab>
</Tabs>

If the user wants to enable or disable otp-email for them, you can make an API on your backend which calls the following function:

<Tabs>
<Tab value="nodejs">

```ts

async function enableMFAForUser(userId: string) {
    await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.OTP_EMAIL)
}

async function disableMFAForUser(userId: string) {
    await MultiFactorAuth.removeFromRequiredSecondaryFactorsForUser(userId, MultiFactorAuth.FactorIds.OTP_EMAIL)
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
    remove_from_required_secondary_factors_for_user,
)
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def enable_mfa_for_user(user_id: str) -> None:
    await add_to_required_secondary_factors_for_user(user_id, FactorIds.OTP_EMAIL)

async def disable_mfa_for_user(user_id: str) -> None:
    await remove_from_required_secondary_factors_for_user(user_id, FactorIds.OTP_EMAIL)
```

</Tab>
</Tabs>

:::note
If instead you want to work with `otp-phone`, you can replace `otp-email` with `otp-phone` in the above snippets. Also make sure that the `contactMethod` configures to `PHONE` in the Passwordless recipe on the frontend (for pre-built UI) and backend.
:::

## Multi tenant setup

### Backend setup
A user can be a part of multiple tenants. If you want OTP to be active for a specific user across all the tenants that they are a part of, the steps are the same as in the [Backend setup](#backend-setup) section above.

However, if you want OTP to be active for a specific user, for a specific tenant (or a subset of tenants that the user is a part of), then additional logic must be added to the `getMFARequirementsForAuth` function override. Modifying the example code from the [Backend setup](#backend-setup) section above:

#### Example 1: Only enable OTP for users that have an `admin` role

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        UserRoles.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-next-line
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE"
        }),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            let roles = await UserRoles.getRolesForUser(input.tenantId, (await input.user).id)
                            // highlight-next-line
                            if (roles.roles.includes("admin") && (await input.requiredSecondaryFactorsForTenant).includes(MultiFactorAuth.FactorIds.OTP_EMAIL)) {
                                // we only want otp-email for admins
                                return [MultiFactorAuth.FactorIds.OTP_EMAIL]
                            } else {
                                // no MFA for non admin users.
                                return []
                            }
                        }
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, accountlinking, passwordless
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.passwordless import ContactEmailOnlyConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import (
    AccountInfoWithRecipeIdAndUserId,
    ShouldNotAutomaticallyLink,
    ShouldAutomaticallyLink,
)
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List, Optional, Union
from supertokens_python.recipe.userroles.asyncio import get_roles_for_user

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any],
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()

    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the
        # new_account_info to the session user, which means it's an MFA flow, so we enable
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)

    return ShouldNotAutomaticallyLink()

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        # Get roles for the user
        roles = await get_roles_for_user(tenant_id, (await user()).id)

        if (
            "admin" in roles.roles
            and FactorIds.OTP_EMAIL in await required_secondary_factors_for_tenant()
        ):
            # We only want OTP_EMAIL for admins
            return [FactorIds.OTP_EMAIL]
        else:
            # No MFA for non-admin users
            return []

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            contact_config=ContactEmailOnlyConfig(), flow_type="USER_INPUT_CODE"
        ),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
        accountlinking.init(
            should_do_automatic_account_linking=should_do_automatic_account_linking
        ),
    ],
)
```

</Tab>
</Tabs>

- The implementation of `shouldRequireOTPEmailForTenant` is entirely up to you.

#### Example 2: Ask for OTP only for users that have enabled OTP on their account

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Passwordless.init({
            contactMethod: "EMAIL",
            flowType: "USER_INPUT_CODE",
            override: {
                apis: (oI) => {
                    return {
                        ...oI,
                        consumeCodePOST: async function (input) {
                            let response = await oI.consumeCodePOST!(input);
                            if (response.status === "OK" && input.session !== undefined) {
                                // We do this only if a session exists, which means that it's not being called for first factor login.
                                
                                // OTP challenge completed successfully. We save that this user has enabled otp-email in the user metadata.
                                // The multifactorauth recipe will pick this value up next time the user is trying to login, and
                                // ask them to enter the OTP code.
                                await MultiFactorAuth.addToRequiredSecondaryFactorsForUser(input.session.getUserId(), MultiFactorAuth.FactorIds.OTP_EMAIL);
                            }
                            return response;
                        }
                    }
                }
            }
        }),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: UserContext) => {
                if (session === undefined) {
                    // we do not want to do first factor account linking by default. To enable that,
                    // please see the automatic account linking docs in the recipe docs for your first factor.
                    return {
                        shouldAutomaticallyLink: false
                    };
                }
                if (user === undefined || session.getUserId() === user.id) {
                    // if it comes here, it means that a session exists, and we are trying to link the 
                    // newAccountInfo to the session user, which means it's an MFA flow, so we enable 
                    // linking here.
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: false
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                };
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
                            if ((await input.requiredSecondaryFactorsForUser).includes(MultiFactorAuth.FactorIds.OTP_EMAIL)) {
                                if ((await input.requiredSecondaryFactorsForTenant).includes(MultiFactorAuth.FactorIds.OTP_EMAIL)) {
                                    return [MultiFactorAuth.FactorIds.OTP_EMAIL]
                                }
                            }
                            // no otp-email required for input.user, with the input.tenant.
                            return []
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, accountlinking, passwordless
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.asyncio import (
    add_to_required_secondary_factors_for_user,
)
from supertokens_python.recipe.passwordless import ContactEmailOnlyConfig
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import (
    AccountInfoWithRecipeIdAndUserId,
    ShouldNotAutomaticallyLink,
    ShouldAutomaticallyLink,
)
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List, Optional, Union
from supertokens_python.recipe.passwordless.interfaces import (
    APIInterface,
    APIOptions,
    ConsumeCodePostOkResult,
)

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any],
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    if session is None:
        # We do not want to do first factor account linking by default.
        # To enable that, please see the automatic account linking docs
        # in the recipe docs for your first factor.
        return ShouldNotAutomaticallyLink()

    if user is None or session.get_user_id() == user.id:
        # If it comes here, it means that a session exists, and we are trying to link the
        # new_account_info to the session user, which means it's an MFA flow, so we enable
        # linking here.
        return ShouldAutomaticallyLink(should_require_verification=False)

    return ShouldNotAutomaticallyLink()

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
        if FactorIds.OTP_EMAIL in await required_secondary_factors_for_user():
            if FactorIds.OTP_EMAIL in await required_secondary_factors_for_tenant():
                return [FactorIds.OTP_EMAIL]
        # no otp-email required for input.user, with the input.tenant.
        return []

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

def passwordless_override(original_implementation: APIInterface):

    original_consume_code_post = original_implementation.consume_code_post

    async def consume_code_post(
        pre_auth_session_id: str,
        user_input_code: Union[str, None],
        device_id: Union[str, None],
        link_code: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        response = await original_consume_code_post(
            pre_auth_session_id,
            user_input_code,
            device_id,
            link_code,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

        if isinstance(response, ConsumeCodePostOkResult) and session is not None:
            await add_to_required_secondary_factors_for_user(
                session.get_user_id(), FactorIds.OTP_EMAIL
            )
        return response

    original_implementation.consume_code_post = consume_code_post

    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            contact_config=ContactEmailOnlyConfig(),
            flow_type="USER_INPUT_CODE",
            override=passwordless.InputOverrideConfig(apis=passwordless_override),
        ),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
        accountlinking.init(
            should_do_automatic_account_linking=should_do_automatic_account_linking
        ),
    ],
)
```

</Tab>
</Tabs>

An override for `getMFARequirementsForAuth` is available, which checks if otp-email is active for the user, and also considers the `tenantId` to decide if this user should go through the otp-email flow while logging into this tenant. The implementation of `shouldRequireOTPEmailForTenant` is entirely up to you.

### Frontend setup
The frontend setup is identical to the [frontend setup](#frontend-setup) section above.

## Protecting frontend and backend routes

See the section on [protecting frontend and backend routes](../protect-routes).

## Email / SMS sending and design
By default, the email template used for otp-email login is [as shown here](https://github.com/SuperTokens/email-sms-templates?tab=readme-ov-file#otp-login), and the default SMS template is [as shown here](https://github.com/SuperTokens/email-sms-templates?tab=readme-ov-file#otp-login-1). The method for sending them is via an email and SMS sending service that is available.

If you would like to learn more about this, or change the content of the email, or the method by which they send, checkout the email / SMS delivery section in the recipe docs:
- [Email delivery configuration](/docs/platform-configuration/email-delivery)
- [SMS delivery configuration](/docs/platform-configuration/sms-delivery)

# Additional Verification - Multi Factor Authentication -  Implement WebAuthn as a secondary factor
Source: https://supertokens.com/docs/additional-verification/mfa/webauthn-secondary-factor-setup

## Overview

This guide shows how to implement an MFA policy that requires all users to use WebAuthn before they get access to your application.

## Before you start

The tutorial assumes that the first factor is email password or social login, but the same set of steps are applicable for other first factor types.



## Steps

<TenantType.Switch />

### 1. Configure the backend

<TenantType.SingleTenantContent>

To start with, we configure the backend in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-next-line
        webauthn.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ],
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getMFARequirementsForAuth: async function (input) {
			    // Change this implementation if you want to require webauthn only for specific users
                            return [MultiFactorAuth.FactorIds.WEBAUTHN]
                        }
                    }
                }
            }
            // highlight-end
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, webauthn
from supertokens_python.recipe.multifactorauth.types import (
    FactorIds,
    OverrideConfig,
    MFARequirementList,
)
from supertokens_python.recipe.multifactorauth.interfaces import RecipeInterface
from supertokens_python.types import User
from typing import Dict, Any, Callable, Awaitable, List

def override_functions(original_implementation: RecipeInterface):
    async def get_mfa_requirements_for_auth(
        tenant_id: str,
        access_token_payload: Dict[str, Any],
        completed_factors: Dict[str, int],
        user: Callable[[], Awaitable[User]],
        factors_set_up_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_user: Callable[[], Awaitable[List[str]]],
        required_secondary_factors_for_tenant: Callable[[], Awaitable[List[str]]],
        user_context: Dict[str, Any],
    ) -> MFARequirementList:
	# Change this implementation if you want to require webauthn only for specific users
        return [FactorIds.WEBAUTHN]

    original_implementation.get_mfa_requirements_for_auth = (
        get_mfa_requirements_for_auth
    )
    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        webauthn.init(),
        multifactorauth.init(
            first_factors=[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY],
            override=OverrideConfig(functions=override_functions),
        ),
    ],
)
```

</Tab>
</Tabs>

The MFA recipe override is required to indicate that `webauthn` must be completed before the user can access the app.

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload will look like this:
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished `webauthn`, the payload will look like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "webauthn": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

</TenantType.SingleTenantContent>

<TenantType.MultiTenantContent>

In a multi tenancy setup, you may want to enable WebAuthn for all users, across all tenants, or for all users within specific tenants. For enabling for all users across all tenants, it's the same steps as in the [single tenant setup](#single-tenant-setup) section above, so in this section, we will focus on enabling WebAuthn for all users within specific tenants.

To start, we will initialise the WebAuthn and the MultiFactorAuth recipes in the following way:

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init(),
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        // highlight-start
        webauthn.init(),
        MultiFactorAuth.init()
        // highlight-end
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import multifactorauth, webauthn

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        webauthn.init(),
        multifactorauth.init(),
    ],
)
```

</Tab>
</Tabs>

Unlike the single tenant setup, we do not provide any config to the `MultiFactorAuth` recipe cause all the necessary configuration will be done on a tenant level.

<Tabs>

<Tab value="nodejs">

To configure WebAuthn requirement for a tenant, we can call the following API:

```tsx

async function createNewTenant() {
    let resp = await Multitenancy.createOrUpdateTenant("customer1", {
        firstFactors: [
            MultiFactorAuth.FactorIds.EMAILPASSWORD,
            MultiFactorAuth.FactorIds.THIRDPARTY
        ],
        requiredSecondaryFactors: [MultiFactorAuth.FactorIds.WEBAUTHN]
    });

    if (resp.createdNew) {
        // Tenant created successfully
    } else {
        // Existing tenant's config was modified.
    }
}
```

- In the above, we set the `firstFactors` to `["emailpassword", "thirdparty"]` to indicate that the first factor can be either `emailpassword` or `thirdparty`.
- We set the `requiredSecondaryFactors` to `["webauthn"]` to indicate that WebAuthn is required for all users in this tenant. The default implementation of `getMFARequirementsForAuth` in the `MultiFactorAuth` takes this into account.

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.multitenancy.asyncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

async def create_new_tenant():
    resp = await create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD],
            required_secondary_factors=[FactorIds.WEBAUTHN],
        )
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.multitenancy.syncio import create_or_update_tenant
from supertokens_python.recipe.multitenancy.interfaces import TenantConfigCreateOrUpdate
from supertokens_python.recipe.multifactorauth.types import FactorIds

def create_new_tenant():
    resp = create_or_update_tenant(
        "customer1", TenantConfigCreateOrUpdate(
            first_factors=[FactorIds.EMAILPASSWORD],
            required_secondary_factors=[FactorIds.WEBAUTHN],
        )
    )

    if resp.created_new:
        # Tenant created successfully
        pass
    else:
        # Existing tenant's config was modified
        pass
```

</Tab>
</Tabs>

</Tab>

</Tabs>

Once the user finishes the first factor (for example, with `emailpassword`), their session access token payload will look like this:
```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
        },
        "v": false
    }
}
```

The `v` being `false` indicates that there are still factors that are pending. After the user has finished `webauthn`, the payload will look like:

```json
{
    "st-mfa": {
        "c": {
            "emailpassword": 1702877939,
            "webauthn": 1702877999
        },
        "v": true
    }
}
```

Indicating that the user has finished all required factors, and should be allowed to access the app.

</TenantType.MultiTenantContent>

### 2. Configure the frontend



<PrebuiltUIInstructions>

We start by modifying the `init` function call on the frontend like so:

<TenantType.MultiTenantContent>

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes..
        // highlight-start
        webauthn.init(),
        MultiFactorAuth.init(),
        Multitenancy.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getTenantId: async (context) => {
                            return "TODO"
                        }
                    }
                }
            }
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You will have to make changes to the auth route config, as well as to the `supertokens-web-js` SDK config at the root of your application:

This change is in your auth route config.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes..
        // highlight-start
        supertokensUIWebAuthn.init(),
        supertokensUIMultiFactorAuth.init(),
        supertokensUIMultitenancy.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        getTenantId: async (context) => {
                            return "TODO"
                        }
                    }
                }
            }
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK config at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        WebAuthn.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

</TenantType.MultiTenantContent>

<TenantType.SingleTenantContent>

<Tabs>

<Tab value="reactjs">

```tsx

supertokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes..
        // highlight-start
        webauthn.init(),
        MultiFactorAuth.init({
            firstFactors: [
                MultiFactorAuth.FactorIds.EMAILPASSWORD,
                MultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

</Tab>

<Tab value="angular">

You will have to make changes to the auth route config, as well as to the `supertokens-web-js` SDK config at the root of your application:

This change is in your auth route config.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // other recipes..
        // highlight-start
        supertokensUIWebAuthn.init(),
        supertokensUIMultiFactorAuth.init({
            firstFactors: [
                supertokensUIMultiFactorAuth.FactorIds.EMAILPASSWORD,
                supertokensUIMultiFactorAuth.FactorIds.THIRDPARTY
            ]
        })
        // highlight-end
    ]
})
```

This change goes in the `supertokens-web-js` SDK config at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        WebAuthn.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

</TenantType.SingleTenantContent>

On the frontend, the `MultiFactorAuth` recipe intialization only requires the first factors to be configured.
The secondary factors will be determined based on a requiest to the backend.

Add the WebAuthn pre-built UI to render the SuperTokens component:

<Tabs>

<Tab value="reactjs">

<Question
    question="Do you use react-router-dom?">
<Answer title="Yes">

```tsx

function App() {
  return (
    <SuperTokensWrapper>
      <div className="App">
        <Router>
          <div className="fill">
            <Routes>
              // highlight-start 
              {getSuperTokensRoutesForReactRouterDom(reactRouterDOM, [/* ... */ WebauthnPreBuiltUI, MultiFactorAuthPreBuiltUI])}
              // highlight-end 
              // ... other routes
            </Routes>
          </div>
        </Router>
      </div>
    </SuperTokensWrapper>
  );
}
```

</Answer>

<Answer title="No">

```tsx

function App() {
  // highlight-start
  if (canHandleRoute([/* ... */ WebauthnPreBuiltUI, MultiFactorAuthPreBuiltUI])) {
      return getRoutingComponent([/* ... */ WebauthnPreBuiltUI, MultiFactorAuthPreBuiltUI])
  }
  // highlight-end
  return (
    <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
  );
}
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

:::success
This step is not required for non React apps, since all the pre-built UI components are already added into the bundle.
:::

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

We start by initialising the MFA and WebAuthn recipe on the frontend like so:

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        MultiFactorAuth.init(),
        WebAuthn.init()
        // highlight-end
    ],
});
```

</Tab>

<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        apiBasePath: "...",
        appName: "...",
    },
    recipeList: [
        // other recipes...
        // highlight-start
        supertokensMultiFactorAuth.init(),
        supertokensWebAuthn.init()
        // highlight-end
    ],
});
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

:::success
This step is not applicable for mobile apps. Please continue reading.
:::

</Tab>

</Tabs>

After the first factor login, you should start by checking the access token payload and see if the MFA claim's `v` boolean is `false`.
'If it's not, then you can redirect the user to the application page.

If it's `false`, the frontend then needs to [call the MFA endpoint](/docs/references/fdi/mfa/put-mfa-info) to get information about which factor the user should be asked to complete next.
Based on the initial backend configuration, the `next` array will contain `["webauthn"]`.

To complete the secondary factor you need to take into account if the users has previously configured a passkey or not.
You can determine this by checking if the `alreadySetup` array contains `"webauthn"`.

#### Sign up flow

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">

```ts

async function secondFactorSignUp(email: string, userContext: Record<string, any>) {
  const response = await Webauthn.registerCredentialWithSignUp({
      email,
      shouldTryLinkingWithSessionUser: true,
      userContext,
  });

  return response.status === "OK";
}
```

</Tab>

<Tab value="scripts">

```ts

async function secondFactorSignUp(email: string, userContext: Record<string, any>) {
  const response = await recipeImplementation.registerCredentialWithSignUp({
      email,
      shouldTryLinkingWithSessionUser: true,
      userContext,
  });

  return response.status === "OK";
}
```

</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

Support for this flow is not available in the mobile SDK.
You will have to call the [backend API](/docs/references/fdi/introduction) directly.

First, call the [**Register WebAuthn Credential**](/docs/references/fdi/webauthn/post-webauthn-credential) endpoint to register the passkey.
Afterwards call the [**Sign Up with WebAuthn**](/docs/references/fdi/webauthn/post-webauthn-signup) to complete the second factor sign up process.

</Tab>

</Tabs>

#### Sign in flow

<Tabs>

<Tab value="web">

<Tabs>

<Tab value="npm">
```ts

async function secondFactorSignUp(userContext: Record<string, any>) {
  const response = await recipeImplementation.authenticateCredentialWithSignIn({
      shouldTryLinkingWithSessionUser: true,
      userContext,
  });

  return response.status === "OK";
}
```
</Tab>

<Tab value="scripts">
```ts

async function secondFactorSignUp(userContext: Record<string, any>) {
  const response = await recipeImplementation.authenticateCredentialWithSignIn({
      shouldTryLinkingWithSessionUser: true,
      userContext,
  });

  return response.status === "OK";
}
```
</Tab>

</Tabs>

</Tab>

<Tab value="mobile">

Support for this flow is not available in the mobile SDK.
You will have to call the [backend API](/docs/references/fdi/introduction) directly.

Call the [**Sign in with WebAuthn**](/docs/references/fdi/webauthn/post-webauthn-signin) endpoint to complete the secondary factor flow.

</Tab>

</Tabs>

</CustomUIInstructions>

That's it! :tada:

Based on this configuration, users first access the authentication form which shows the `emailpassword` and `thirdparty` options.
After first factor completion, they access the WebAuthn form to finalize the authentication attempt.

# Additional Verification - Multi Factor Authentication -  Implement recovery codes
Source: https://supertokens.com/docs/additional-verification/mfa/backup-codes

## Overview

Backup codes is one of the ways in which end users can recover their account in case they lose their second factor device.
At the moment, SuperTokens does not have an in-built implementation for backup codes, however, you can customize the SDKs to add it.

:::info Note
[Here is an example](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes) of how you can implement backup codes in your application if you are using the pre-built UI.
:::

This guide shows you how to implement the following flow:
- After MFA setup users can generate backup codes.
- The backup code associates with the userID in the `UserMetadata` JSON.
- When a user wants to use their backup code, the application shows them a UI to enter the code.
This calls an API that verifies the backup code and adds a flag in their session, indicating that they have correctly supplied a backup code.
- After that, the flag allows users to create a new MFA device, even if they already have one registered on their account.
User can then go about adding a new device and completing MFA using that.

## Before you start



These instructions assume that you already have some knowledge of MFA.
If you are not familiar with terms like authentication factors and challenges, please go through the [MFA concepts page](/docs/additional-verification/mfa/important-concepts).

The guide below focuses on Time-based One-Time Password (TOTP) as a second factor, but you can implement something similar for Passwordless as well.

## Steps

### 1. Add an API to generate backup codes on the backend

Here is an [example API](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/index.ts#L52) for how you can create a recovery code.
In here, you create a secure random string and save the hashed version in the user metadata JSON.
This API returns the plain text recovery code to the frontend to display to the user.

### 2. Allow users to generate a backup code when they finish MFA setup



<PrebuiltUIInstructions>

After the user has successfully set up their second factor (during sign up or during recovery process), they navigate to a page which shows them their backup code.

The user can automatically redirect to this page (once they have completed their MFA setup) by adding a claim validator on the frontend. This enforces that the user always has a backup code associated with their account. Even if they consume the code in the future, this validator fails and redirects them to the create new backup code screen.
The idea here is to modify the access token payload on the backend to add a boolean value to it. This value is `true` if the user already has a backup code with their account, else it's `false`.
The frontend claim validator fails if the value is `false` and redirects them to the UI for creating a backup code.
You can see this validator implementation on the frontend in the [recoveryCodeExistsClaim.ts file](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/recoveryCodeExistsClaim.ts). This validator adds to the [Session.init on the frontend](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/config.tsx#L56) that it runs each time you protect a route with `<SessionAuth />`.

It is also necessary to add a claim validator on the backend to add the boolean value to the access token payload.
You can see the claim validator's implementation in the [recoveryCodeExistsClaim.ts file](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/recoveryCodeExistsClaim.ts).
This validator appears in a few places:
- [When creating a new backup code](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/index.ts#L61).
- [When consuming an existing backup code](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/config.ts#L55).
- [When creating a new session](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/config.ts#L127).

Once on the page, the UI calls the API created in the previous step to create a new recovery code for the user.
Note that calling this API replaces the older recovery code, but since it's all custom, you can change the logic.

[Here is an example](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/CreateRecoveryCode/index.tsx) of how to implement this page.

</PrebuiltUIInstructions>

<CustomUIInstructions>

For custom UI, the UI for where and how you show the recovery code page is up to you. It is advisable to show the user this page post sign up, or whenever they create a new MFA device successfully.

The user can automatically redirect to this page (once they have completed their MFA setup) by adding a claim validator on the frontend. This enforces that the user always has a backup code associated with their account. Even if they consume the code in the future, this validator fails and redirects them to the create new backup code screen.
The idea here is to modify the access token payload on the backend to add a boolean value to it. This value is `true` if the user already has a backup code with their account, else it's `false`.
The frontend claim validator fails if the value is `false` and redirects them to the UI for creating a backup code.
You can see this validator implementation on the frontend in the [recoveryCodeExistsClaim.ts file](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/recoveryCodeExistsClaim.ts). This validator adds to the [Session.init on the frontend](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/config.tsx#L56) that it runs each time you protect a route with `await Session.validateClaims` function call.

It is also necessary to add a claim validator on the backend to add the boolean value to the access token payload.
You can see the claim validator's implementation in the [recoveryCodeExistsClaim.ts file](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/recoveryCodeExistsClaim.ts).
This validator appears in a few places:
- [When creating a new backup code](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/index.ts#L61).
- [When consuming an existing backup code](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/config.ts#L55).
- [When creating a new session](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/config.ts#L127).

Once on the page, the UI calls the API created in the previous step to create a new recovery code for the user.
Note that calling this API replaces the older recovery code, but since it's all custom, you can change the logic.

[Here is an example](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/CreateRecoveryCode/index.tsx) of how to implement this page.

</CustomUIInstructions>

### 3. Show how to use backup codes on the MFA challenge UI

<PrebuiltUIInstructions>

You can achieve this by creating a "Lost device?" button in the pre-built UI that asks the user to enter the Time-based One-Time Password (TOTP) challenge.
Once they click on this, users redirect to a page where they can enter their backup code. After verification, they further redirect to the create a new Time-based One-Time Password (TOTP) device page.

[Here is how you can override the pre-built UI](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/App.tsx#L19) to display the "Lost device?" button.

[Here is an example implementation](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/RecoveryCode/index.tsx) of a page which asks the user to enter their backup code. It then calls an API (see next step) to check if the code is correct or not.

</PrebuiltUIInstructions>

<CustomUIInstructions>

You should make a UI that asks the user to enter their backup code and call the API to verify it and mark it as "in use" (see next step).
You want to give the option for users to enter their backup code when asked for the MFA challenge.

</CustomUIInstructions>

### 4. Modify the user's session to mark that they have verified their backup code

On the backend, you set up an API that accepts the recovery code entered by the user. It checks that it matches the hashed version stored in the user's metadata JSON. If it does, it marks as "in use" in the user's session payload.
You achieve this by saving the `recoverCodeHash` in the session payload, which is then checked in the next step to force enable Time-based One-Time Password (TOTP) device creation.

<PrebuiltUIInstructions>

On the frontend, once this API returns a success, the user should navigate to the create a new Time-based One-Time Password (TOTP) device screen.
You can see how this process completes in the [index.tsx file](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/frontend/src/RecoveryCode/index.tsx#L20).

</PrebuiltUIInstructions>

<CustomUIInstructions>

On the frontend, once this API returns a success, the user should navigate to the create a new Time-based One-Time Password (TOTP) device screen.

</CustomUIInstructions>

### 5. Force users to setup a new device

Here are the steps:
- Force enabling Time-based One-Time Password (TOTP) device creation if the `recoveryCodeHash` is in the user's session's access token payload.
- Deleting the recovery code from the user's metadata JSON once they have consumed it to create a new device. 
- Redirecting the user to the page that shows their new recovery code after they have set up their new device.

You can achieve the first step by overriding [this function](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/config.ts#L68) on the backend.
By default, the `assertAllowedToSetupFactorElseThrowInvalidClaimError` function throws an error if a Time-based One-Time Password (TOTP) device already exists. If the user tries to set up a new TOTP device during the sign-in process, it is for security reasons.
However, this modifies to check if the access token payload contains the `recoveryCodeHash` and that it matches the one in the user metadata JSON.
If it does, you allow new device setup, since it is known that the user had previously entered their recovery code successfully.

During the Time-based One-Time Password (TOTP) device setup, users call [this API](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-multifactorauth-recovery-codes/backend/config.ts#L45) from the frontend. If this API succeeds, then it means that a new TOTP device has been created for the user and they have completed the TOTP challenge for the current session.
On success, the old recovery code removes from the metadata in case the session has the `recoveryCodeHash` set.
This way, the old recovery code is no longer usable.

Finally, after successfully creating a new Time-based One-Time Password (TOTP) device, the frontend should redirect the user to the page which shows the new recovery code for the user. Refer to step 2 above.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/mfa/email-sms-otp/otp-for-all-users" label="Email & SMS OTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/totp/totp-for-all-users" label="TOTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/step-up-auth" label="Step-up Authentication" />
  <ReferenceCard href="/docs/additional-verification/mfa/protect-routes" label="Protect Routes with MFA" />
</ReferenceCard.Grid>

# Additional Verification - Multi Factor Authentication -  Implement step-up authentication
Source: https://supertokens.com/docs/additional-verification/mfa/step-up-auth

## Overview

Step-up authentication enforces the user to complete an authentication challenge before navigating to a page, or before doing a specific action.
You can implement it with **SuperTokens** as full page navigation, or as popups on the current page.

## Before you start



These instructions assume that you already have some knowledge of MFA.
If you are not familiar with terms like authentication factors and challenges, please go through the [MFA concepts page](/docs/additional-verification/mfa/important-concepts).

### Prerequisites

Step-up authentication supports the following factors:
- `TOTP`
- `WebAuthn/Passkeys`
- Password (available only for custom UI)
- Email or SMS `OTP`

If you are using **OAuth2** in your configuration, step-up authentication is not supported at the moment.

## Steps

### 1. Add the backend validators

To protect sensitive APIs with step up auth, you need to check that the user has completed the required auth challenge within a certain amount of time.
If they haven't, you should return a `403` to the frontend which highlights which factor is necessary.
The frontend can then consume this and show the auth challenge to the user.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post(
    "/update-blog",
    verifySession(),
    async (req: SessionRequest, res) => {
        let mfaClaim = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
        if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
            // this means that the user had completed the TOTP challenge more than 5 minutes ago
            // so we should ask them to complete it again
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: MultiFactorAuth.FactorIds.TOTP,
                    },
                }]
            })
        }
        // continue with API logic...
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession(),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let mfaClaim = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
        if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
            // this means that the user had completed the TOTP challenge more than 5 minutes ago
            // so we should ask them to complete it again
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: MultiFactorAuth.FactorIds.TOTP,
                    },
                }]
            })
        }
        // continue with API logic...

    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession(),
}, async (req: SessionRequest, res) => {
    let mfaClaim = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
    if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
        // this means that the user had completed the TOTP challenge more than 5 minutes ago
        // so we should ask them to complete it again
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User has not finished TOTP",
            payload: [{
                id: MultiFactorAuth.MultiFactorAuthClaim.key,
                reason: {
                    message: "Factor validation failed: totp not completed",
                    factorId: MultiFactorAuth.FactorIds.TOTP,
                },
            }]
        })
    }
    // continue with API logic...
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    let mfaClaim = await awsEvent.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
    if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
        // this means that the user had completed the TOTP challenge more than 5 minutes ago
        // so we should ask them to complete it again
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User has not finished TOTP",
            payload: [{
                id: MultiFactorAuth.MultiFactorAuthClaim.key,
                reason: {
                    message: "Factor validation failed: totp not completed",
                    factorId: MultiFactorAuth.FactorIds.TOTP,
                },
            }]
        })
    }
    // continue with API logic...
};

exports.handler = verifySession(updateBlog);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession(), async (ctx: SessionContext, next) => {
    let mfaClaim = await ctx.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
    if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
        // this means that the user had completed the TOTP challenge more than 5 minutes ago
        // so we should ask them to complete it again
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User has not finished TOTP",
            payload: [{
                id: MultiFactorAuth.MultiFactorAuthClaim.key,
                reason: {
                    message: "Factor validation failed: totp not completed",
                    factorId: MultiFactorAuth.FactorIds.TOTP,
                },
            }]
        })
    }
    // continue with API logic...
});
```

</Tab>
<Tab value="loopback">

```tsx

class Example {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession())
    @response(200)
    async handler() {
        let mfaClaim = await (this.ctx as any).session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
        if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
            // this means that the user had completed the TOTP challenge more than 5 minutes ago
            // so we should ask them to complete it again
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: MultiFactorAuth.FactorIds.TOTP,
                    },
                }]
            })
        }
        // continue with API logic...
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function example(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession()(req, res, next);
        },
        req,
        res
    )
    let mfaClaim = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
    if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
        // this means that the user had completed the TOTP challenge more than 5 minutes ago
        // so we should ask them to complete it again
        await superTokensNextWrapper(
            async (next) => {
                throw new STError({
                    type: "INVALID_CLAIMS",
                    message: "User has not finished TOTP",
                    payload: [{
                        id: MultiFactorAuth.MultiFactorAuthClaim.key,
                        reason: {
                            message: "Factor validation failed: totp not completed",
                            factorId: MultiFactorAuth.FactorIds.TOTP,
                        },
                    }]
                })
            },
            req,
            res
        )
    }
    // continue with API logic...
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        let mfaClaim = await session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
        if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
            // this means that the user had completed the TOTP challenge more than 5 minutes ago
            // so we should ask them to complete it again
            const error = new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: MultiFactorAuth.FactorIds.TOTP,
                    },
                }]
            })
            return NextResponse.json(error, { status: 403 });
        }
        // continue with API logic...
        return NextResponse.json({})
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
    @Post('example')
    @UseGuards(new AuthGuard())
    async postExample(@Session() session: SessionContainer): Promise<boolean> {
        let mfaClaim = await session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        const totpCompletedTime = mfaClaim!.c[MultiFactorAuth.FactorIds.TOTP];
        if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000*60*5)) {
            // this means that the user had completed the TOTP challenge more than 5 minutes ago
            // so we should ask them to complete it again
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: MultiFactorAuth.FactorIds.TOTP,
                    },
                }]
            })
        }
        // continue with API logic...
        return true;
    }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="fastapi">

```python

### 2. Prevent factor setup during step-up authentication

By default, SuperTokens allows a factor setup, such as creating a new TOTP device, as long as the user has a session and has completed all the MFA factors required during login.
This opens up a security issue when it comes to completing step up auth. Consider the following scenario:
- The user has logged in and completed TOTP
- After 5 minutes, the user tries to do a sensitive action and the API for that fails with a 403 (cause of the check in step 1, above).
- The user sees the TOTP challenge on the frontend. However, instead of completing that, they call the create TOTP device API which would succeed and then use the new TOTP device to complete the factor challenge required for the API.

This allows someone malicious to bypass step up auth.
To prevent this, override one of the MFA recipe functions on the backend. This enforces that the factor setup can only happen if the user is not in a step-up auth state.

<Tabs>
<Tab value="nodejs">

```ts

supertokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "..."
    },
    recipeList: [

        MultiFactorAuth.init({
            firstFactors: [/*...*/],
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // highlight-start
                        assertAllowedToSetupFactorElseThrowInvalidClaimError: async (input) => {
                            await originalImplementation.assertAllowedToSetupFactorElseThrowInvalidClaimError(input);

                            let claimValue = await input.session.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
                            if (claimValue === undefined || !claimValue.v) {
                                return
                            }

                            // if the above did not throw, it means that the user has logged in and has completed all the required
                            // factors for login. So now we check specifically for the step up auth case:
                            if (input.factorId === MultiFactorAuth.FactorIds.TOTP && (await input.factorsSetUpForUser).includes(MultiFactorAuth.FactorIds.TOTP)) {
                                // this is an example of checking for totp, but you can also use other factor IDs.
                                const totpCompletedTime = claimValue.c[MultiFactorAuth.FactorIds.TOTP];
                                if (totpCompletedTime === undefined || totpCompletedTime < (Date.now() - 1000 * 60 * 5)) {
                                    // this means that the user had completed the TOTP challenge more than 5 minutes ago
                                    // so we should ask them to complete it again
                                    throw new STError({
                                        type: "INVALID_CLAIMS",
                                        message: "User has not finished TOTP",
                                        payload: [{
                                            id: MultiFactorAuth.MultiFactorAuthClaim.key,
                                            reason: {
                                                message: "Factor validation failed: totp not completed",
                                                factorId: MultiFactorAuth.FactorIds.TOTP,
                                            },
                                        }]
                                    })
                                }
                            }
                        }
                        // highlight-end
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python

async function redirectToTotpSetupScreen() {
    MultiFactorAuth.redirectToFactor({
        factorId: "totp",
        stepUp: true,
        redirectBack: true,
    })
}
```

- In the snippet above, redirect to the [TOTP factor setup screen](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/totp-mfa--device-setup). Set the `stepUp` argument to `true` otherwise the MFA screen would detect that the user has already completed basic MFA requirements and would not show the verification screen. Set the `redirectBack` argument to `true` since the intention is to redirect back to the current page after the user has finished setting up the device.
- You can also redirect the user to `/{websiteBasePath}/mfa/totp?setup=true&redirectToPath={currentPath}` if you don't want to use the above function.

</Tab>

<Tab value="angular">

To add a new device, you can redirect the user to `/{websiteBasePath}/mfa/totp?setup=true&redirectToPath={currentPath}` from your settings page. This shows the [TOTP factor setup screen](https://master--6571be2867f75556541fde98.chromatic.com/?path=/story/totp-mfa--device-setup) to the user. The `redirectToPath` query parameter also tells the SDK to redirect the user back to the current page after they have finished creating the device.

</Tab>

</Tabs>

#### Show the factor in a popup

Checkout [the documentation](/docs/additional-verification/mfa/embed-the-prebuilt-ui) for embedding the pre-built UI factor components in a page or a popup.

</PrebuiltUIInstructions>

<CustomUIInstructions>

You can check for this structure and the `factorId` to decide what factor to show on the frontend.

</CustomUIInstructions>

### 4. Check for step-up authentication on page navigation

Sometimes, you may want to ask users to complete step up auth before displaying a page on the frontend.
This is a different scenario than the above steps cause. Here, you do not want to rely on an API call to fail. Instead, you want to check for the step-up auth condition before rendering the page itself.

To do this, read the access token payload on the frontend and check the completed time of the factor of interest before rendering the page.
If the completed time is older than 5 minutes (as an example), redirect the user to the factor challenge page.

<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

const VerifiedRoute = (props: React.PropsWithChildren<any>) => {
    return (
        <SessionAuth>
            <InvalidClaimHandler>
                {props.children}
            </InvalidClaimHandler>
        </SessionAuth>
    );
}

function InvalidClaimHandler(props: React.PropsWithChildren<any>) {
    let claimValue = useClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    if (claimValue.loading) {
        return null;
    }

    let totpCompletedTime = claimValue.value?.c[MultiFactorAuth.FactorIds.TOTP]
    if (totpCompletedTime === undefined || totpCompletedTime < (DateProviderReference.getReferenceOrThrow().dateProvider.now() - 1000 * 60 * 5)) {
        return <div>You need to complete TOTP before seeing this page. Please <a href={"/auth/mfa/totp?stepUp=true&redirectToPath=" + window.location.pathname}>click here</a> to finish to proceed.</div>
    }

    // the user has finished TOTP, so we can render the children
    return <div>{props.children}</div>;
}
```
- Check if the user has completed TOTP within the last 5 minutes or not. If not, show a message to the user, and ask them to complete TOTP.
- Notice that the `DateProviderReference` class exported by SuperTokens replaces `Date.now()`. This accounts for any clock skew that may exist between the frontend and the backend server.

</Tab>

<Tab value="angular">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        let validationErrors = await Session.validateClaims();

        if (validationErrors.length === 0) {
            // since all default claim validators have passed, we now check for if the user has finished TOTP
            // within the last 5 mins
            let mfaClaimValue = await Session.getClaimValue({ claim: MultiFactorAuthClaim });
            let totpCompletedTime = mfaClaimValue?.c["totp"];
            if (totpCompletedTime === undefined || totpCompletedTime < (DateProviderReference.getReferenceOrThrow().dateProvider.now() - 1000 * 60 * 5)) {
                // ths user needs to complete TOTP since it's been more than 5 mins since they completed it.
                return false;
            }
            return true;
        } else {
            // handle other validation failure events...
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

- In your protected routes, you need to first check if a session exists, and then call the Session.validateClaims function as shown above. If that passes, it means all the default claim validators have passed (checks applied to all routes in general), and then perform the step-up auth check.
- For checking for step-up auth, get the MFA claim value from the session and then check if TOTP completed within the last 5 minutes. Only if it did, return true, else return false.
- Notice that the `DateProviderReference` class exported by SuperTokens replaces `Date.now()`. This accounts for any clock skew that may exist between the frontend and the backend server.

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>

<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        let validationErrors = await Session.validateClaims();

        if (validationErrors.length === 0) {
            // since all default claim validators have passed, we now check for if the user has finished TOTP
            // within the last 5 mins
            let mfaClaimValue = await Session.getClaimValue({ claim: MultiFactorAuthClaim });
            let totpCompletedTime = mfaClaimValue?.c["totp"];
            if (totpCompletedTime === undefined || totpCompletedTime < (DateProviderReference.getReferenceOrThrow().dateProvider.now() - 1000 * 60 * 5)) {
                // ths user needs to complete TOTP since it's been more than 5 mins since they completed it.
                return false;
            }
            return true;
        } else {
            // handle other validation failure events...
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

</Tab>
<Tab value="scripts">

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {
        let validationErrors = await supertokensSession.validateClaims();

        if (validationErrors.length === 0) {
            // since all default claim validators have passed, we now check for if the user has finished TOTP
            // within the last 5 mins
            let mfaClaimValue = await supertokensSession.getClaimValue({ claim: supertokensMultiFactorAuth.MultiFactorAuthClaim });
            let totpCompletedTime = mfaClaimValue?.c["totp"];
            if (totpCompletedTime === undefined || totpCompletedTime < (supertokensDateProviderReference.DateProviderReference.getReferenceOrThrow().dateProvider.now() - 1000 * 60 * 5)) {
                // ths user needs to complete TOTP since it's been more than 5 mins since they completed it.
                return false;
            }
            return true;
        } else {
            // handle other validation failure events...
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

</Tab>
</Tabs>

- In your protected routes, you need to first check if a session exists, and then call the Session.validateClaims function as shown above. If that passes, it means all the default claim validators have passed (checks applied to all routes in general), and then perform the step-up auth check.
- For checking for step-up auth, get the MFA claim value from the session and then check if TOTP completed within the last 5 minutes. Only if it did, return true, else return false.
- Notice that the `DateProviderReference` class exported by SuperTokens replaces `Date.now()`. This accounts for any clock skew that may exist between the frontend and the backend server.

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function checkIfMFAIsCompleted() {
    if (await SuperTokens.doesSessionExist()) {

        // highlight-start
        let isMFACompleted: boolean = (await SuperTokens.getAccessTokenPayloadSecurely())["st-mfa"].v;
        if (isMFACompleted) {
            let completedFactors = (await SuperTokens.getAccessTokenPayloadSecurely())["st-mfa"].c;
            if (completedFactors["totp"] === undefined || completedFactors["totp"] < (Date.now() - 1000*60*5)) {
                // user has not finished TOTP MFA in the last 5 minutes
            }
        } else {
            // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
        }
        // highlight-end
    }
}
```

</Tab>

<Tab value="android">

```kotlin
                }
            }
        } catch (e: Exception) {
            // Handle exceptions such as ClassCastException or JSONException
        }
    }
}
```

</Tab>

<Tab value="ios">

```swift
            if isMFACompleted {
                // All required factors for MFA have been completed
                if let mfaCompletedFactors = mfaObject["c"] as? [String: Any], let totpTime = mfaCompletedFactors["totp"] as? Double {
                    // Corrected unwrapping of mfaCompletedFactors and casting of totpTime
                    if totpTime < (Date().timeIntervalSince1970 - 1000*60*5) {
                        // user has not finished TOTP MFA in the last 5 minutes
                    }
                }
            } else {
                // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
            }
        }
    }
}
```

</Tab>

<Tab value="flutter">

```dart

Future<void> checkIfMFAIsCompleted() async {
  var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();

  if (accessTokenPayload.containsKey("st-mfa")) {
    Map<String, dynamic> mfaObject = accessTokenPayload["st-mfa"];

    if (mfaObject.containsKey("v")) {
      bool isMFACompleted = mfaObject["v"] as bool; // Casting to bool

      if (isMFACompleted) {
        // All required factors for MFA have been completed
        Map<String, dynamic> mfaCompletedFactors = mfaObject["c"];
        if (mfaCompletedFactors["totp"] == null ||
            mfaCompletedFactors["totp"] <
                (DateTime.now().millisecondsSinceEpoch - 1000 * 60 * 5)) {
          // user has not finished TOTP MFA in the last 5 minutes
        }
      } else {
        // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
      }
    }
  }
}
```

</Tab>

</Tabs>

- In your protected routes, you need to first check if a session exists, and then check that the user has finished all the basic MFA factors for logging in (by checking the value of the `v` boolean in the MFA claim session). If that passes, then perform the step-up auth check.
- For checking for step-up auth, get the MFA claim value from the session, and then check if TOTP completed within the last 5 minutes. Only if it did, return true, else return false.

</Tab>
</Tabs>

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/mfa/email-sms-otp/otp-for-all-users" label="Email & SMS OTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/totp/totp-for-all-users" label="TOTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/backup-codes" label="Backup Codes" />
  <ReferenceCard href="/docs/additional-verification/mfa/protect-routes" label="Protect Routes with MFA" />
</ReferenceCard.Grid>

# Additional Verification - Multi Factor Authentication -  Embed the pre-built UI component
Source: https://supertokens.com/docs/additional-verification/mfa/embed-the-prebuilt-ui

## Overview

## Before you start

These instructions only apply to interfaces that use the pre-built UI components.
If you are using a custom UI, the embed instructions depend on your implementation details.

The tutorial configures `TOTP` as a secondary factor, but the same set of steps are applicable for other secondary factor types.

--- 

## Render the TOTP Widget in a page

The following example shows the scenario where you have a dedicated route, such as `/totp`, for rendering the TOTP Widget. Upon a successful login, the user will be automatically redirected to the return value of `getRedirectionURL` (defaulting to `/`).

<Tabs>
<Tab value="reactjs">

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">
<Answer title="Yes">

<ReactRouterVersionTabs>

<ReactRouterVersionTabs.Tab value="v6">

```tsx
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        TOTP.init({
            totpMFAScreen: {
                disableDefaultUI: true,
            }
        }),
        MultiFactorAuth.init({
            // highlight-start
            getRedirectionURL: async (context) => {
                if (context.action === "GO_TO_FACTOR") {
                    if (context.factorId === "totp") {
                        return "/totp"
                    }
                }
            }
            // highlight-end
        })
        // ...
    ],
});

function TOTPPage() {
    const navigate = useNavigate();
    return (
        <div>
            <Header />
            // highlight-next-line
            <MFATOTP navigate={navigate} />
            <Footer />
        </div>
    );
}
```

</ReactRouterVersionTabs.Tab>

<ReactRouterVersionTabs.Tab value="v5">

```tsx
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        TOTP.init({
            totpMFAScreen: {
                disableDefaultUI: true,
            },
        }),
        MultiFactorAuth.init({
            // highlight-start
            getRedirectionURL: async (context) => {
                if (context.action === "GO_TO_FACTOR") {
                    if (context.factorId === "totp") {
                        return "/totp"
                    }
                }
            }
            // highlight-end
        })
        // ...
    ],
});

function TOTPPage() {
    const history = useHistory();
    return (
        <div>
            <Header />
            // highlight-next-line
            <MFATOTP navigate={history} />
            <Footer />
        </div>
    );
}
```

</ReactRouterVersionTabs.Tab>

</ReactRouterVersionTabs>

</Answer>
<Answer title="No">

```tsx
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        TOTP.init({
            totpMFAScreen: {
                disableDefaultUI: true,
            },
        }),
        MultiFactorAuth.init({
            getRedirectionURL: async (context) => {
                if (context.action === "GO_TO_FACTOR") {
                    if (context.factorId === "totp") {
                        return "/totp"
                    }
                }
            }
        })
        // ...
    ],
});

function TOTPPage() {
    return (
        <div>
            <Header />
            // highlight-next-line
            <MFATOTP />
            <Footer />
        </div>
    )
}
```
</Answer>
</Question>

In the above code snippet, we:

1. Disabled the default TOTP UI by setting `disableDefaultUI` to `true` inside the TOTP recipe config.
2. Overrode the `getRedirectionURL` function inside the MFA recipe config to redirect to `/totp` whenever we want to show the TOTP factor.

Feel free to customize the redirection URLs as needed.

</Tab>

<Tab value="angular">

:::caution
Not applicable to non-react apps. Please build your own custom UI instead.
:::

</Tab>

</Tabs>

---

## Render the TOTP Widget in a popup

The following example shows the scenario where you embed the TOTP Widget in a popup, and upon successful login, you aim to close the popup. This is especially useful for step up auth.

<Tabs>

<Tab value="reactjs">

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">
<Answer title="Yes">

<ReactRouterVersionTabs>

<ReactRouterVersionTabs.Tab value="v6">

```tsx
// highlight-start
// highlight-end

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "..."
  },
  recipeList: [
    TOTP.init(/* ... */),
    MultiFactorAuth.init(/* ... */)
    // ...
  ],
});

function TOTPPopup() {
  let sessionContext = Session.useSessionContext();
  const navigate = useNavigate();
  const [isModalOpen, setIsModalOpen] = useState(false);

  const openModal = () => setIsModalOpen(true);
  const closeModal = () => setIsModalOpen(false);

  if (sessionContext.loading) {
    return null;
  }

  return (
    <div style={{ textAlign: "center" }}>
      {
        <Session.SessionAuth>
          <h2>You are logged In! </h2>
          <h3>UserId: {sessionContext.userId}</h3>
          <button onClick={() => Session.signOut()}>Sign Out</button>
        </Session.SessionAuth>
      }

      <Modal
        isOpen={isModalOpen}
        contentLabel="TOTP Modal"
      >
        {/* highlight-next-line */}
        <MFATOTP navigate={navigate} />
      </Modal>
    </div>
  );
}
```

</ReactRouterVersionTabs.Tab>

<ReactRouterVersionTabs.Tab value="v5">

```tsx
// highlight-start
// highlight-end

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "..."
  },
  recipeList: [
    TOTP.init(/* ... */),
    MultiFactorAuth.init(/* ... */)
    // ...
  ],
});

function TOTPPopup() {
  let sessionContext = Session.useSessionContext();
  const history = useHistory();
  const [isModalOpen, setIsModalOpen] = useState(false);

  const openModal = () => setIsModalOpen(true);
  const closeModal = () => setIsModalOpen(false);

  if (sessionContext.loading) {
    return null;
  }

  return (
    <div style={{ textAlign: "center" }}>
      {
        <Session.SessionAuth>
          <h2>You are logged In! </h2>
          <h3>UserId: {sessionContext.userId}</h3>
          <button onClick={() => Session.signOut()}>Sign Out</button>
        </Session.SessionAuth>
      }

      <Modal
        isOpen={isModalOpen}
        contentLabel="TOTP Modal"
      >
        {/* highlight-next-line */}
        <MFATOTP navigate={history} />
      </Modal>
    </div>
  );
}
```

</ReactRouterVersionTabs.Tab>

</ReactRouterVersionTabs>

</Answer>
<Answer title="No">

```tsx
// highlight-start
// highlight-end

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "..."
  },
  recipeList: [
    TOTP.init(/* ... */),
    MultiFactorAuth.init(/* ... */)
    // ...
  ],
});

function TOTPPopup() {
  let sessionContext = Session.useSessionContext();
  const [isModalOpen, setIsModalOpen] = useState(false);

  const openModal = () => setIsModalOpen(true);
  const closeModal = () => setIsModalOpen(false);

  if (sessionContext.loading) {
    return null;
  }

  return (
    <div style={{ textAlign: "center" }}>
      {
        <Session.SessionAuth>
          <h2>You are logged In! </h2>
          <h3>UserId: {sessionContext.userId}</h3>
          <button onClick={() => Session.signOut()}>Sign Out</button>
        </Session.SessionAuth>
      }

      <Modal
        isOpen={isModalOpen}
        contentLabel="TOTP Modal"
      >
        {/* highlight-next-line */}
        <MFATOTP />
      </Modal>
    </div>
  );
}
```
</Answer>
</Question>

</Tab>

<Tab value="angular">

:::caution
Not applicable to non-react apps. Please build your own custom UI instead.
:::

</Tab>

</Tabs>

# Additional Verification - Multi Factor Authentication -  Protect frontend and backend routes
Source: https://supertokens.com/docs/additional-verification/mfa/protect-routes

## Overview

This page shows you how to protect your frontend and backend routes to make them accessible only when the user has finished all the MFA challenges configured for them.
In both the backend and the frontend, routes are protected based on value of the MFA claim, in the session's access token payload.

## Before you start



One thing to note here is that, with **OAuth2 Access Tokens**, you don't need to check the MFA claims. You will get the token once the MFA flow is done.

---

## Protect API routes

When you call `MultiFactorAuth.init` in the `supertokens.init` on the backend, SuperTokens **automatically adds a session claim validator globally**.
This validator checks that the value of `v` in the [MFA claim](./important-concepts#factors) is `true` before allowing the request to proceed.
If the value of `v` is `false`, the validator will send a 403 error to the frontend.

:::important
This validator is added globally, which means that every time you use `Verify Session` or `Get Session` from the backend SDKs, this check will happen.
This means that you don't need to add any extra code on a per API level to enforce MFA.
:::

### Exclude routes from the default check

To exclude the default validator check in a certain backend route, you have to update `Verify Session` call.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post(
    "/update-blog",
    verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }),
    async (req: SessionRequest, res) => {
        // The user may or may not have completed the MFA required factors since we exclude
        // that from the globalValidators
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    overrideGlobalClaimValidators: async (globalValidators) => {
                        return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
                    },
                }),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // The user may or may not have completed the MFA required factors since we exclude
        // that from the globalValidators
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }),
}, async (req: SessionRequest, res) => {
    // The user may or may not have completed the MFA required factors since we exclude
    // that from the globalValidators
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    // The user may or may not have completed the MFA required factors since we exclude
    // that from the globalValidators
};

exports.handler = verifySession(updateBlog, {
    overrideGlobalClaimValidators: async (globalValidators) => {
        return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
    },
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }), async (ctx: SessionContext, next) => {
    // The user may or may not have completed the MFA required factors since we exclude
    // that from the globalValidators
});
```

</Tab>
<Tab value="loopback">

```tsx

class Example {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }))
    @response(200)
    async handler() {
        // The user may or may not have completed the MFA required factors since we exclude
        // that from the globalValidators
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function example(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                overrideGlobalClaimValidators: async (globalValidators) => {
                    return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
                },
            })(req, res, next);
        },
        req,
        res
    )
    // The user may or may not have completed the MFA required factors since we exclude
    // that from the globalValidators
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        // The user may or may not have completed the MFA required factors since we exclude
        // that from the globalValidators
        return NextResponse.json({})
    },
    {
        // highlight-start
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
        // highlight-end
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard({
    overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => {
        return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
    },
  }))
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    // The user may or may not have completed the MFA required factors since we exclude
    // that from the globalValidators
    return true;
  }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="fastapi">

```python
from supertokens_python.recipe.session.framework.fastapi import verify_session
from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import MultiFactorAuthClaim
from supertokens_python.recipe.session import SessionContainer
from fastapi import Depends

@app.post('/like_comment')  # type: ignore
async def like_comment(session: SessionContainer = Depends(
        verify_session(
            # highlight-start
            # We keep all validators except for the EmailVerification ones
            override_global_claim_validators=lambda global_validators, session, user_context: [
                validators for validators in global_validators if validators.id != MultiFactorAuthClaim.key]
            # highlight-end
        )
)):
    # All validator checks have passed and the user has a verified email address
    pass
```

</Tab>
<Tab value="flask">

```python
from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import MultiFactorAuthClaim

@app.route('/update-jwt', methods=['POST'])  # type: ignore
@verify_session(
    # highlight-start
    # We keep all validators except for the EmailVerification ones
    override_global_claim_validators=lambda global_validators, session, user_context: [
        validators for validators in global_validators if validators.id != MultiFactorAuthClaim.key]
    # highlight-end
)
def like_comment():
    # All validator checks have passed and the user has a verified email address
    pass
```

</Tab>
<Tab value="django">

```python
from supertokens_python.recipe.session.framework.django.asyncio import verify_session
from django.http import HttpRequest
from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import MultiFactorAuthClaim

@verify_session(
    # highlight-start
    # We keep all validators except for the EmailVerification ones
    override_global_claim_validators=lambda global_validators, session, user_context: [
        validators for validators in global_validators if validators.id != MultiFactorAuthClaim.key]
    # highlight-end
)
async def like_comment(request: HttpRequest):
    # All validator checks have passed and the user has a verified email address
    pass
```

</Tab>
</Tabs>

</Tab>
</Tabs>

The same modification can be done for `getSession` as well.

### Check MFA claim manually

To account for a more complex logic when you check the MFA claim (other than checking if `v` is `true`), look over the next code snippet.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post(
    "/update-blog",
    verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }),
    async (req: SessionRequest, res) => {
        let mfaClaimValue = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        if (mfaClaimValue === undefined) {
            // this means that there is no MFA claim information in the session. This can happen if the session was created
            // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
            // in the following way:
            await req.session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
            mfaClaimValue = (await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
        }

        let completedFactors = mfaClaimValue.c;
        if ("totp" in completedFactors) {
            // the user has finished totp
        } else {
            // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
            // claim validation error in the following way:
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: "totp",
                    },
                }]
            })
        }
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    overrideGlobalClaimValidators: async (globalValidators) => {
                        return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
                    },
                }),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let mfaClaimValue = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        if (mfaClaimValue === undefined) {
            // this means that there is no MFA claim information in the session. This can happen if the session was created
            // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
            // in the following way:
            await req.session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
            mfaClaimValue = (await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
        }

        let completedFactors = mfaClaimValue.c;
        if ("totp" in completedFactors) {
            // the user has finished totp
        } else {
            // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
            // claim validation error in the following way:
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: "totp",
                    },
                }]
            })
        }
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }),
}, async (req: SessionRequest, res) => {
    let mfaClaimValue = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    if (mfaClaimValue === undefined) {
        // this means that there is no MFA claim information in the session. This can happen if the session was created
        // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
        // in the following way:
        await req.session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
        mfaClaimValue = (await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
    }

    let completedFactors = mfaClaimValue.c;
    if ("totp" in completedFactors) {
        // the user has finished totp
    } else {
        // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
        // claim validation error in the following way:
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User has not finished TOTP",
            payload: [{
                id: MultiFactorAuth.MultiFactorAuthClaim.key,
                reason: {
                    message: "Factor validation failed: totp not completed",
                    factorId: "totp",
                },
            }]
        })
    }
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    let mfaClaimValue = await awsEvent.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    if (mfaClaimValue === undefined) {
        // this means that there is no MFA claim information in the session. This can happen if the session was created
        // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
        // in the following way:
        await awsEvent.session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
        mfaClaimValue = (await awsEvent.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
    }

    let completedFactors = mfaClaimValue.c;
    if ("totp" in completedFactors) {
        // the user has finished totp
    } else {
        // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
        // claim validation error in the following way:
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User has not finished TOTP",
            payload: [{
                id: MultiFactorAuth.MultiFactorAuthClaim.key,
                reason: {
                    message: "Factor validation failed: totp not completed",
                    factorId: "totp",
                },
            }]
        })
    }
};

exports.handler = verifySession(updateBlog, {
    overrideGlobalClaimValidators: async (globalValidators) => {
        return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
    },
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession({
    overrideGlobalClaimValidators: async (globalValidators) => {
        return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
    },
}), async (ctx: SessionContext, next) => {
    let mfaClaimValue = await ctx.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    if (mfaClaimValue === undefined) {
        // this means that there is no MFA claim information in the session. This can happen if the session was created
        // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
        // in the following way:
        await ctx.session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
        mfaClaimValue = (await ctx.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
    }

    let completedFactors = mfaClaimValue.c;
    if ("totp" in completedFactors) {
        // the user has finished totp
    } else {
        // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
        // claim validation error in the following way:
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User has not finished TOTP",
            payload: [{
                id: MultiFactorAuth.MultiFactorAuthClaim.key,
                reason: {
                    message: "Factor validation failed: totp not completed",
                    factorId: "totp",
                },
            }]
        })
    }
});
```

</Tab>
<Tab value="loopback">

```tsx

class Example {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }))
    @response(200)
    async handler() {
        let mfaClaimValue = await (this.ctx as any).session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        if (mfaClaimValue === undefined) {
            // this means that there is no MFA claim information in the session. This can happen if the session was created
            // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
            // in the following way:
            await (this.ctx as any).session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
            mfaClaimValue = (await (this.ctx as any).session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
        }

        let completedFactors = mfaClaimValue.c;
        if ("totp" in completedFactors) {
            // the user has finished totp
        } else {
            // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
            // claim validation error in the following way:
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: "totp",
                    },
                }]
            })
        }
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function example(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                overrideGlobalClaimValidators: async (globalValidators) => {
                    return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
                },
            })(req, res, next);
        },
        req,
        res
    )
    let mfaClaimValue = await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
    if (mfaClaimValue === undefined) {
        // this means that there is no MFA claim information in the session. This can happen if the session was created
        // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
        // in the following way:
        await req.session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
        mfaClaimValue = (await req.session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
    }

    let completedFactors = mfaClaimValue.c;
    if ("totp" in completedFactors) {
        // the user has finished totp
    } else {
        // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
        // claim validation error in the following way:
        await superTokensNextWrapper(
            async (next) => {
                throw new STError({
                    type: "INVALID_CLAIMS",
                    message: "User has not finished TOTP",
                    payload: [{
                        id: MultiFactorAuth.MultiFactorAuthClaim.key,
                        reason: {
                            message: "Factor validation failed: totp not completed",
                            factorId: "totp",
                        },
                    }]
                })
            },
            req,
            res
        )
    }
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        let mfaClaimValue = await session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        if (mfaClaimValue === undefined) {
            // this means that there is no MFA claim information in the session. This can happen if the session was created
            // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
            // in the following way:
            await session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
            mfaClaimValue = (await session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
        }

        let completedFactors = mfaClaimValue.c;
        if ("totp" in completedFactors) {
            // the user has finished totp
        } else {
            // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
            // claim validation error in the following way:
            const error = new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: "totp",
                    },
                }]
            })
            return NextResponse.json(error, { status: 403 });
        }
        return NextResponse.json({})
    },
        {
            // highlight-start
            overrideGlobalClaimValidators: async (globalValidators) => {
                return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
            },
            // highlight-end
        });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
    @Post('example')
    @UseGuards(new AuthGuard({
        overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => {
            return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.key);
        },
    }))
    async postExample(@Session() session: SessionContainer): Promise<boolean> {
        let mfaClaimValue = await session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim);
        if (mfaClaimValue === undefined) {
            // this means that there is no MFA claim information in the session. This can happen if the session was created
            // prior to you enabling the MFA recipe on the backend. So here, we can add the value of the MFA claim to the session
            // in the following way:
            await session!.fetchAndSetClaim(MultiFactorAuth.MultiFactorAuthClaim);
            mfaClaimValue = (await session!.getClaimValue(MultiFactorAuth.MultiFactorAuthClaim))!;
        }

        let completedFactors = mfaClaimValue.c;
        if ("totp" in completedFactors) {
            // the user has finished totp
        } else {
            // the user has not finished totp. You can choose to do anything you like here, for example, we may throw a 
            // claim validation error in the following way:
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User has not finished TOTP",
                payload: [{
                    id: MultiFactorAuth.MultiFactorAuthClaim.key,
                    reason: {
                        message: "Factor validation failed: totp not completed",
                        factorId: "totp",
                    },
                }]
            })
        }
        return true;
    }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="fastapi">

```python
from fastapi import Depends

from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import (
    MultiFactorAuthClaim,
)
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.exceptions import (
    ClaimValidationError,
    raise_invalid_claims_exception,
)
from supertokens_python.recipe.session.framework.fastapi import verify_session

@app.post("/update-blog")  # type: ignore
async def update_blog_api(session: SessionContainer = Depends(verify_session())):
    # highlight-start
    mfa_claim_value = await session.get_claim_value(MultiFactorAuthClaim)
    if mfa_claim_value is None:
        # This means that there is no MFA claim information in the session.
        # This can happen if the session was created prior to enabling the MFA recipe on the backend.
        # So here, we add the value of the MFA claim to the session:
        await session.fetch_and_set_claim(MultiFactorAuthClaim)
        mfa_claim_value = await session.get_claim_value(MultiFactorAuthClaim)
    assert mfa_claim_value is not None
    completed_factors = mfa_claim_value.c
    if "totp" not in completed_factors:
        # The user has not finished TOTP. We throw a claim validation error:
        raise_invalid_claims_exception(
            "User has not finished TOTP",
            [
                ClaimValidationError(
                    MultiFactorAuthClaim.key,
                    {
                        "message": "Factor validation failed: totp not completed",
                        "factorId": "totp",
                    },
                )
            ],
        )
    # If we reach here, it means the user has completed TOTP
    # highlight-end
```

</Tab>
<Tab value="flask">

```python
from flask import Flask, g

from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import (
    MultiFactorAuthClaim,
)
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.exceptions import (
    ClaimValidationError,
    raise_invalid_claims_exception,
)
from supertokens_python.recipe.session.framework.flask import verify_session

app = Flask(__name__)

@app.route('/update-blog', methods=['POST'])  # type: ignore
@verify_session()
def check_mfa_api():
    session: SessionContainer = g.supertokens  # type: ignore
    # highlight-start
    mfa_claim_value = session.sync_get_claim_value(MultiFactorAuthClaim)
    if mfa_claim_value is None:
        # This means that there is no MFA claim information in the session.
        # This can happen if the session was created prior to enabling the MFA recipe on the backend.
        # So here, we add the value of the MFA claim to the session:
        session.sync_fetch_and_set_claim(MultiFactorAuthClaim)
        mfa_claim_value = session.sync_get_claim_value(MultiFactorAuthClaim)
    assert mfa_claim_value is not None
    completed_factors = mfa_claim_value.c
    if "totp" not in completed_factors:
        # The user has not finished TOTP. We throw a claim validation error:
        raise_invalid_claims_exception("User has not finished TOTP", [
            ClaimValidationError(MultiFactorAuthClaim.key, {
                "message": "Factor validation failed: totp not completed",
                "factorId": "totp",
            })
        ])
    # If we reach here, it means the user has completed TOTP
    # highlight-end
```

</Tab>
<Tab value="django">

```python
from typing import cast

from django.http import HttpRequest

from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import (
    MultiFactorAuthClaim,
)
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.exceptions import (
    ClaimValidationError,
    raise_invalid_claims_exception,
)
from supertokens_python.recipe.session.framework.django.asyncio import verify_session

@verify_session()
async def get_user_info_api(request: HttpRequest):
    session: SessionContainer = cast(SessionContainer, request.supertokens) # type: ignore
    # highlight-start
    mfa_claim_value = await session.get_claim_value(MultiFactorAuthClaim)
    if mfa_claim_value is None:
        # This means that there is no MFA claim information in the session.
        # This can happen if the session was created prior to enabling the MFA recipe on the backend.
        # So here, we add the value of the MFA claim to the session:
        await session.fetch_and_set_claim(MultiFactorAuthClaim)
        mfa_claim_value = await session.get_claim_value(MultiFactorAuthClaim)
    assert mfa_claim_value is not None
    completed_factors = mfa_claim_value.c
    if "totp" not in completed_factors:
        # The user has not finished TOTP. We throw a claim validation error:
        raise_invalid_claims_exception(
            "User has not finished TOTP",
            [
                ClaimValidationError(
                    MultiFactorAuthClaim.key,
                    {
                        "message": "Factor validation failed: totp not completed",
                        "factorId": "totp",
                    },
                )
            ],
        )
    # If we reach here, it means the user has completed TOTP
    # highlight-end
```

</Tab>
</Tabs>

</Tab>
</Tabs>

- In the code snippet above, we remove the default validator that was added to the global validators (which checks if the `v` value in the claim is true or not). You don't need to do this, but in the code snippet above, we show it anyway.
- Then in the API logic, we manually fetch the claim value, and then check if TOTP has been completed or not. If it hasn't, we send back a 403 error to the frontend.

You can use a similar approach as shown above to do any kind of check.

:::info important
If you are doing JWT verification manually, then post verification, you should check the payload of the JWT and make sure that the `v` value in the [MFA claim](./important-concepts#how-are-auth-factors-marked-as-completed) is `true`.
This would be equivalent to doing a check as our default claim validator mentioned above.

Make sure to also do other checks on the JWT payload. For example, if you require all users to have finished email verification, then we need to check for that claim as well in the JWT.
:::

---

## Protect frontend routes



<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

When you call `MultiFactorAuth.init` in the `supertokens.init` on the frontend, SuperTokens will add a default validator check that runs whenever you use the `SessionAuth` component. This validator checks if the `v` value in the [MFA claim](./important-concepts#how-are-auth-factors-marked-as-completed) is `true` or not.
If it is not, then the user will be redirected to the MFA auth screen.

### Other forms of authorization

If you do not want to run our default validator on a specific route, you can modify the use of `SessionAuth` in the following way:

```tsx

const VerifiedRoute = (props: React.PropsWithChildren<any>) => {
    return (
        <SessionAuth
            overrideGlobalClaimValidators={(globalValidators) => {
                return globalValidators.filter(validator => validator.id !== MultiFactorAuth.MultiFactorAuthClaim.id);
            }}>
            <InvalidClaimHandler>
                {props.children}
            </InvalidClaimHandler>
        </SessionAuth>
    );
}

function InvalidClaimHandler(props: React.PropsWithChildren<any>) {

    const claimValue = useClaimValue(MultiFactorAuth.MultiFactorAuthClaim);

    if (claimValue.loading) {
        return null;
    }

    if (claimValue.value === undefined || !("totp" in claimValue.value.c)) {
        return <div>You do not have access to this page because you have not completed TOTP. Please <a href="/auth/mfa/totp">click here</a> to finish to proceed.</div>
    }

    // the user has finished TOTP, so we can render the children
    return <div>{props.children}</div>;
}
```
- In the snippet above, we remove the default claim validator that is added to `SessionAuth`, and add out own logic that reads from the session's payload.
- Finally, we check if the user has completed TOTP or not. If not, we show a message to the user, and ask them to complete TOTP. Of course, if this is all you want to do, then the default validator already does that. But the above has the boilerplate for how you can do more complex checks.

</Tab>

<Tab value="angular">

By default, when you do `MultiFactorAuth.init` in `supertokens.init` on the frontend, SuperTokens will add a default validator check that runs whenever you call the `Session.validateClaims` function. This validator checks if the `v` value in the [MFA claim](./important-concepts#how-are-auth-factors-marked-as-completed) is `true` or not.

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        let validationErrors = await Session.validateClaims();

        if (validationErrors.length === 0) {
            // user has finished all MFA factors.
            return true;
        } else {
            for (const err of validationErrors) {
                if (err.id === MultiFactorAuthClaim.id) {
                    // user has not finished MFA factors.
                    let mfaClaimValue = await Session.getClaimValue({
                        claim: MultiFactorAuthClaim
                    });
                    if (mfaClaimValue === undefined || !("totp" in mfaClaimValue.c)) {
                        // the user has not finished totp
                        return false;
                    }
                }
            }
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

In your protected routes, you need to first check if a session exists, and then call the Session.validateClaims function as shown above. This function inspects the session's contents and runs claim validators on them. If a claim validator fails, it will be reflected in the `validationErrors` variable. The `MultiFactorAuthClaim` validator will be automatically checked by this function since you have initialized the MFA recipe.

In case the claim fails, you can get the claim value and check which factor is not completed. In the above code, we check that if it's the TOTP factor that is missing when the claim fails and return `false` from this function. However, it's really up to you for what you want to do next. For example, you could redirect the user to the TOTP factor screen.

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>

<Tab value="web">

By default, when you do `MultiFactorAuth.init` in `supertokens.init` on the frontend, SuperTokens will add a default validator check that runs whenever you call the `Session.validateClaims` function. This validator checks if the `v` value in the [MFA claim](./important-concepts#how-are-auth-factors-marked-as-completed) is `true` or not.

<Tabs>
<Tab value="npm">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        let validationErrors = await Session.validateClaims();

        if (validationErrors.length === 0) {
            // user has finished all MFA factors.
            return true;
        } else {
            for (const err of validationErrors) {
                if (err.id === MultiFactorAuthClaim.id) {
                    // user has not finished MFA factors.
                    let mfaClaimValue = await Session.getClaimValue({
                        claim: MultiFactorAuthClaim
                    });
                    if (mfaClaimValue === undefined || !("totp" in mfaClaimValue.c)) {
                        // the user has not finished totp
                        return false;
                    }
                }
            }
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

</Tab>
<Tab value="scripts">

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {
        let validationErrors = await supertokensSession.validateClaims();

        if (validationErrors.length === 0) {
            // user has finished all MFA factors.
            return true;
        } else {
            for (const err of validationErrors) {
                if (err.id === supertokensMultiFactorAuth.MultiFactorAuthClaim.id) {
                    // user has not finished MFA factors.
                    let mfaClaimValue = await supertokensSession.getClaimValue({
                        claim: supertokensMultiFactorAuth.MultiFactorAuthClaim
                    });
                    if (mfaClaimValue === undefined || !("totp" in mfaClaimValue.c)) {
                        // the user has not finished totp
                        return false;
                    }
                }
            }
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

</Tab>
</Tabs>

In your protected routes, you need to first check if a session exists, and then call the Session.validateClaims function as shown above. This function inspects the session's contents and runs claim validators on them. If a claim validator fails, it will be reflected in the `validationErrors` variable. The `MultiFactorAuthClaim` validator will be automatically checked by this function since you have initialized the MFA recipe.

In case the claim fails, you can get the claim value and check which factor is not completed. In the above code, we check that if it's the TOTP factor that is missing when the claim fails and return `false` from this function. However, it's really up to you for what you want to do next. For example, you could redirect the user to the TOTP factor screen.

</Tab>

<Tab value="mobile">

In your app, you can check the [MFA claim](./important-concepts#how-are-auth-factors-marked-as-completed) values to know which factors have been completed by the user and take action based on that. 



<Tabs>

<Tab value="reactnative">

```tsx

async function checkIfMFAIsCompleted() {
    if (await SuperTokens.doesSessionExist()) {

        // highlight-start
        let isMFACompleted: boolean = (await SuperTokens.getAccessTokenPayloadSecurely())["st-mfa"].v;

        if (isMFACompleted) {
            // All required factors for MFA have been completed
        } else {
            // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
        }
        // highlight-end
    }
}
```

</Tab>

<Tab value="android">

```kotlin
        val isMFACompleted: Boolean = (accessTokenPayload.get("st-mfa") as JSONObject).get("v") as Boolean
        if (isMFACompleted) {
            // All required factors for MFA have been completed
        } else {
            // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
        }
    }
}
```

</Tab>

<Tab value="ios">

```swift
            if let mfaObject: [String: Any] = accessTokenPayload["st-mfa"] as? [String: Any] {
                // Determine if MFA has been completed
                if let isMFACompleted: Bool = mfaObject["v"] as? Bool {
                    if isMFACompleted {
                        // All required factors for MFA have been completed
                    } else {
                        // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
                    }
                }
            }
        }
    }
}
```

</Tab>

<Tab value="flutter">

```dart

Future<void> checkIfMFAIsCompleted() async {
    var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();

    if (accessTokenPayload.containsKey("st-mfa")) {
      Map<String, dynamic> mfaObject = accessTokenPayload["st-mfa"];

      if (mfaObject.containsKey("v")) {
        bool isMFACompleted = mfaObject["v"];

        if (isMFACompleted) {
            // All required factors for MFA have been completed
        } else {
            // You can check the `c` object from ["st-mfa"] prop to see which factors have been completed by the user
        }
      }
    }
}
```

</Tab>

</Tabs>

If the MFA claim value is missing in the access token payload, then it means that the session was created before you enabled MFA on the backend. In this case, you can call the [MFA Info](./frontend-setup#mfa-info-endpoint) endpoint which will add the MFA claim to the session and check again.

</Tab>
</Tabs>

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/mfa/email-sms-otp/otp-for-all-users" label="Email & SMS OTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/totp/totp-for-all-users" label="TOTP" />
  <ReferenceCard href="/docs/additional-verification/mfa/step-up-auth" label="Step-up Authentication" />
  <ReferenceCard href="/docs/additional-verification/mfa/backup-codes" label="Backup Codes" />
</ReferenceCard.Grid>

# Additional Verification - Multi Factor Authentication -  Hooks and overrides
Source: https://supertokens.com/docs/additional-verification/mfa/hooks-and-overrides

**SuperTokens** exposes a set of constructs that allow you to trigger different actions during the authentication lifecycle or to even fully customize the logic based on your use case. 
The following sections describe how you can modify adjust the `mfa` recipe to your needs.

Explore the [references pages](/docs/references) for a more in depth guide on hooks and overrides.

## Frontend event hooks

The pre-built UI emits a few events that you can listen to on the frontend. As an example, you can use these for analytics:

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        Passwordless.init({
            contactMethod: "EMAIL_OR_PHONE",
            onHandleEvent: (context) => {
                if (context.action === "PASSWORDLESS_CODE_SENT") {
                    // this event is fired when the user has successfully sent out an OTP email / SMS
                } else if (context.action === "PASSWORDLESS_RESTART_FLOW") {
                    // This event is fired when the user's OTP has expired, or
                    // they have reached the max limit of number of failed OTP attempts.
                } else if (context.action === "SUCCESS" && !context.createdNewSession) {
                    // this event is fired when successfully completing the OTP email / SMS challenge
                    // and if it's not used in first factor (cause we do !context.createdNewSession)
                }
            }
        }),
        TOTP.init({
            onHandleEvent: (context) => {
                if (context.action === "TOTP_DEVICE_CREATED") {
                    // this event is fired during factor setup, when the user has successfully created the TOTP device. They still have to verify it by entering the TOTP.
                } else if (context.action === "TOTP_DEVICE_VERIFIED") {
                    // this event is fired during factor setup, when the user has successfully verified the TOTP device
                } else if (context.action === "TOTP_CODE_VERIFIED") {
                    // this event is fired when the user has successfully verified the TOTP code
                    // marking the TOTP factor as completed
                }
            }
        }),
        MultiFactorAuth.init({
            firstFactors: [/*...*/],
            onHandleEvent: (context) => {
                if (context.action === "FACTOR_CHOOSEN") {
                    let chosenFactorId = context.factorId;
                    // this event is fired when the user is shown the screen for 
                    // picking one factor out of a choice of multiple factors
                }
            }
        })
    ]
})
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
        supertokensUIPasswordless.init({
            contactMethod: "EMAIL_OR_PHONE",
            onHandleEvent: (context) => {
                if (context.action === "PASSWORDLESS_CODE_SENT") {
                    // this event is fired when the user has successfully sent out an OTP email / SMS
                } else if (context.action === "PASSWORDLESS_RESTART_FLOW") {
                    // This event is fired when the user's OTP has expired, or
                    // they have reached the max limit of number of failed OTP attempts.
                } else if (context.action === "SUCCESS" && !context.createdNewSession) {
                    // this event is fired when successfully completing the OTP email / SMS challenge
                    // and if it's not used in first factor (cause we do !context.createdNewSession)
                }
            }
        }),
        supertokensUITOTP.init({
            onHandleEvent: (context) => {
                if (context.action === "TOTP_DEVICE_CREATED") {
                    // this event is fired during factor setup, when the user has successfully created the TOTP device. They still have to verify it by entering the TOTP.
                } else if (context.action === "TOTP_DEVICE_VERIFIED") {
                    // this event is fired during factor setup, when the user has successfully verified the TOTP device
                } else if (context.action === "TOTP_CODE_VERIFIED") {
                    // this event is fired when the user has successfully verified the TOTP code
                    // marking the TOTP factor as completed
                }
            }
        }),
        supertokensUIMultiFactorAuth.init({
            firstFactors: [/*...*/],
            onHandleEvent: (context) => {
                if (context.action === "FACTOR_CHOOSEN") {
                    let chosenFactorId = context.factorId;
                    // this event is fired when the user is shown the screen for 
                    // picking one factor out of a choice of multiple factors
                }
            }
        })
    ]
})
```

</Tab>

</Tabs>

## Backend overrides

It's a common use case to want to override the default behavior of SuperTokens after a user signs up or signs in.
For example, you may want to change your database state whenever someone signs up.
You can do this by overriding the sign up / sign in recipe functions in the backend SDK:
- [Passwordless recipe](/docs/authentication/passwordless/hooks-and-overrides)
- [EmailPassword recipe](/docs/authentication/email-password/hooks-and-overrides)
- [ThirdParty recipe](/docs/authentication/social/hooks-and-overrides)

Since the sign up / sign in APIs share functionality for first factor and second factor login, your override applies to both first and second factor login. If you want to have different behavior for first and second factor login, you can use the `input` argument to the function to determine if the user is doing first or second factor login.

The `input` argument contains the `session` object using which you can determine if the user is doing first or second factor login. If the `session` property is `undefined`, it means it's a first factor login, else it's a second factor login. In the links above, the code snippets check for `input.session === undefined` to determine if it's a first factor login.

# Additional Verification - Multi Factor Authentication - Migration -  Migration from legacy MFA to new MFA method
Source: https://supertokens.com/docs/additional-verification/mfa/migration/legacy-to-new

This page only applies if you have used our [legacy MFA method](/docs/additional-verification/mfa/legacy-mfa/how-it-works) and want to migrate to the new MFA method.

From a code point of view, [here is the diff](https://github.com/supertokens/supertokens-auth-react/commit/f96e11a527ccd9df71c25798c316dd3de770dde1) of all changes required:
- We no longer need the custom `secondFactoeClaim` since the MFA recipe adds its own MFA claim.
- On the backend, we initialise the MFA recipe:
    - In the example app, we use email password and social login as the first factor, so the we set `firstFactors` variable to to `[FactorIds.EMAILPASSWORD, FactorIds.THIRDPARTY]`.
    - We also set the required second factor to return OTP phone, but you can set it to OTP email as well.
    - We override the `resyncSessionAndFetchMFAInfoPUT` API to sync old session claim with the new one. This API is called from the frontend during sign in, and also whenever you use `<SessionAuth>` (for the pre-built UI) or call `await Session.validateClaims()` for your custom UI.
    - We remove the custom overrides for Passwordless.init and for Session.init since those are now handled by the new MFA recipe.
    - We initialise the AccountLinking recipe with the config that enables account linking for first and second factors.
    - A side effect of using our multi factor auth is that if you have enabled the email verification recipe, we will ask users to complete email verification before completing any secondary factors.
- On the frontend for pre-built UI:
    - You will no longer need to use the custom SecondFactorClaim, and also no longer need to create a SecondFactor component (since we provide a pre-built one).
    - We initialise the MultiFactorAuth recipe, and remove the Session.init override from before as well.
- On the frontend for custom UI:
    - You no longer will need to use the custom SecondFactorClaim and instead, you can see our guide for email / SMS OTP in the above sections.

## Understanding the override code for `resyncSessionAndFetchMFAInfoPUT`
We start by getting the user object from of the session's user ID along with the user's metadata. If the user object does not already contain a passwordless login method, it means we have not linked the passwordless user yet. If also, the metadata has the `passwordlessUserId` prop in it, it means that this user had previously setup email / SMS OTP as a second factor. In this case, we now attempt to link the passwordless user to the session user.

For linking, we need to first ensure that the session user is a primary user, and if not, we call the `createPrimaryUser` function from the account linking recipe. After that, we call the `linkAccounts` function with the session user id and the passwordless user ID (pulled from the metadata). We are now in a state where the session user has two login methods:
- The first factor login method
- The passwordless login method for 2FA

Finally, we update the session claim value to contain the MFA claim and also mark the `OTP_PHONE` factor as completed (you can use `OTP_EMAIL`). This will prevent users from being asked to complete the second factor again if they have already done so in the current session.

# Additional Verification - Multi Factor Authentication - Migration -  Migration from an older SuperTokens SDK to a newer one
Source: https://supertokens.com/docs/additional-verification/mfa/migration/old-sdk-to-new

This section is applicable to those who want to enable MFA for the first time and are already using SuperTokens in production. The following are the steps you need to take:
- Make sure that you have updated your SuperTokens core, backend SDK and frontend SDK that supports MFA (you can find these versions in the CHANGELOG.md files in their respective GitHub repository). Make sure to read the migration guide for each of the breaking version upgrades. You should aim to get your existing feature set working with the new version of SuperTokens before you enable MFA.
- Follow the backend and frontend setup we have in this guide along with the factor specific setup (TOTP or email / SMS OTP).

## If enabling MFA for all users at once

If you have enabled MFA for all users, then existing logged in users will asked to complete the secondary factor as soon as they visit your app / website once you have pushed the changes to production. This happens because their existing session is modified to add the MFA claim into it, however, the `v` value in the claim will be `false` since they have not completed MFA yet. This would fail the validators on the frontend which would redirect the user to the MFA login screen.

If you have clients like mobile apps, which take time to upgrade across your entire user base, then you may want to remove the global MFA validator on the backend and make it run only when you know that the request is coming from an updated client:

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // other recipes..
        Session.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // highlight-start
                        getGlobalClaimValidators: (input) => {
                            // We remove the existing default MFA validator which checks that
                            // the client has finished MFA.
                            let newValidatorsArray = input.claimValidatorsAddedByOtherRecipes.filter(v => v.id !== MultiFactorAuth.MultiFactorAuthClaim.key);

                            // We create an instance of the default validator that is added
                            // by SuperTokens so that we can make modificationts to it
                            let originalValidator = MultiFactorAuth.MultiFactorAuthClaim.validators.hasCompletedMFARequirementsForAuth();

                            // We create a custom validator based on the default validator
                            let customValidator = {
                                ...originalValidator,
                                validate: async (payload: any, userContext: UserContext): Promise<ClaimValidationResult> => {
                                    // We only want to run the validation check
                                    // if we know that the client is not an older one.
                                    // In this example, we do this based on the header
                                    // in the API request, but the logic here can be
                                    // anything that you like.
                                    let request = getRequestFromUserContext(userContext);
                                    if (request !== undefined) {
                                        let isOlderClient = request.getHeaderValue("clilent-version") !== "2.0";
                                        if (isOlderClient) {
                                            // we return true early for older clients.
                                            return {
                                                isValid: true
                                            }
                                        }
                                    }

                                    // for newer clients, we call the original validate function
                                    // which will check the claim value in the session.
                                    return originalValidator.validate(payload, userContext);
                                }
                            }

                            return [customValidator, ...newValidatorsArray];
                        }
                        // highlight-end
                    }
                }
            }
        })
    ]
})
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import session
from supertokens_python.recipe.session.utils import InputOverrideConfig
from supertokens_python.recipe.session.interfaces import RecipeInterface
from supertokens_python.recipe.session.interfaces import (
    SessionClaimValidator,
    ClaimValidationResult,
)
from typing import Dict, Any, List
from supertokens_python.types import RecipeUserId
from supertokens_python.recipe.multifactorauth.multi_factor_auth_claim import (
    MultiFactorAuthClaim,
)
from supertokens_python import get_request_from_user_context

def override_functions(
    original_implementation: RecipeInterface,
) -> RecipeInterface:

    def get_global_claim_validators(
        tenant_id: str,
        user_id: str,
        recipe_user_id: RecipeUserId,
        claim_validators_added_by_other_recipes: List[SessionClaimValidator],
        user_context: Dict[str, Any],
    ):
        # Remove the existing default MFA validator
        new_validators = [
            v
            for v in claim_validators_added_by_other_recipes
            if v.id != MultiFactorAuthClaim.key
        ]

        # Create an instance of the default validator
        original_validator = (
            MultiFactorAuthClaim.validators.has_completed_mfa_requirements_for_auth()
        )
        original_validator_validate_func = original_validator.validate

        # Create a custom validator based on the default validator
        async def custom_validate(
            payload: Any, user_context: Dict[str, Any]
        ) -> ClaimValidationResult:
            # Check if the client is an older one based on the header
            request = get_request_from_user_context(user_context)
            if request is not None:
                is_older_client = request.get_header("client-version") != "2.0"
                if is_older_client:
                    # Return true early for older clients
                    return ClaimValidationResult(is_valid=True)

            # For newer clients, call the original validate function
            return await original_validator_validate_func(payload, user_context)

        original_validator.validate = custom_validate

        return [original_validator, *new_validators]

    original_implementation.get_global_claim_validators = get_global_claim_validators

    return original_implementation

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework="...",  # type: ignore
    recipe_list=[
        session.init(override=InputOverrideConfig(functions=override_functions))
    ],
)
```

</Tab>
</Tabs>

The code above will still result in the MFA claim being added to all sessions, with the `v` boolean in it being `false`, however, for older clients, we will not run the validator that checks if the `v` value is true on the backend since those clients have no way to show the MFA UI without updating the app.

:::caution
You want to add the above exception only for a certain amount of time until you force all users to update their mobile app. This is because the exception method can be used as a way for malicious users to bypass MFA by spoofing that they are using an older client.
:::

# Additional Verification - Multi Factor Authentication - Legacy method -  Legacy vs New method
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/legacy-vs-new

The legacy method for MFA requires you to customise the auth recipes we have to add MFA on top of it. Since it does not use the MFA recipe we have, it's free.

The limitations of using the legacy method are:
- It does not support TOTP, but only email / SMS OTP
- When the end user completes the email / SMS OTP factor, there will be a separate user that's created for that login method which is not linked to the first factor login method for that user. This means that you will see two SuperTokens users for every single end use that goes through the MFA flow.
- It requires multiple customisations on top of the basic auth setup, which adds scope for error.

When should you use the legacy method?
- If you are not using our Node backend SDK, then you have to use this, since we do not yet support the MFA recipe for non Node SDKs.
- If you are price sensitive and do not want to pay for the MFA recipe then you can use this method. That being said, if you are using our managed service, then depending on your end user's login pattern, the number of MAUs you will be charged for is double (assuming all users complete 2FA each month) than the actual MAU count. This in turn is more expensive than using the MFA recipe.

# Additional Verification - Multi Factor Authentication - Legacy method -  How it works
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/how-it-works

:::info Caution
This is the legacy method of implementing MFA. It has multiple [disadvantages](./legacy-vs-new) compared to using our MFA recipe.
:::


You need to start by choosing your first factor auth. This can be any of the [auth recipes](https://supertokens.com/docs/guides) we support. A common choice is to combine the `thirdparty` and `emailpassword` recipes, which allows users to sign in with social or email / password login.

For the second factor, whilst you can choose any of our auth recipes as well, the most common choice is the [Passwordless recipe](https://supertokens.com/docs/passwordless/introduction), using which, you can send SMS or email OTP (or magic links) to the user.

You will also need to use our Session recipe which can be used to store information about which factors have been completed by the user for the current session. This will be integral to our implementation.

As a high level flow, we will customise these recipes in the following way:
- After the first factor is completed, we will override the `createNewSession` function in the Session recipe to store the fact that only the first factor is complete. We do this by adding the `SecondFactorClaim` to the session which will default to false.
- After the second factor is completed, we will update the session and set `SecondFactorClaim` to true.
- To make sure that application APIs are only accessible post 2FA is completed, we will add a `SecondFactorClaim` validator to the global validators by overriding `getGlobalClaimValidators` in the Session recipe. This will check if the second factor has been completed whenever `verifySession` or `getSession` is called.
- Similarly, to protect frontend routes, we will add the `SecondFactorClaim` validator to the global validators ensuring that all components wrapped with the `SessionAuth` component will check that 2FA is completed. If not, we can then reroute the user to the second factor screen.
- We also need to use the `UserMetadata` recipe to store information about the second factor authentication's identification. In the example app, we use phone number SMS OTP as the second factor, therefore we store the user's phone number using the `UserMetadata` recipe, and only send OTPs to that number during sign in. The phone number itself is obtained during the sign up flow.

:::info Important
In the subsequent sections, we will see how to implement 2fa with the first factor being social and email / password login, and the second factor being phone SMS OTP.

If you require a different set of factors or behaviour, you can take inspiration from this guide.
:::

# Additional Verification - Multi Factor Authentication - Legacy method - Backend Setup -  Setting up the 1st factor
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/backend-setup/first-factor

## 1. Initialisation

Start by following the recipe guide for the first factor. In this guide, we will take the example of `thirdparty` and `emailpassword` recipes as being the first factor.

After following the [backend quick setup section](/docs/quickstart/backend-setup) (or any of the framework specific integration guides), you should have all the auth APIs exposed to the frontend via the SuperTokens middleware. The `supertokens.init` code on the server would look like this:



<Tabs>
<Tab value="nodejs">

<Tabs exclude={["awsLambda", "nextjs", "nestjs"]} showAppTypeSelect>
<Tab value="express">

```tsx

supertokens.init({
    framework: "express",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/thirdpartyemailpassword/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init(), // initializes session features
        UserMetadata.init() // initializes the user metadata feature
    ]
});
```
</Tab>

<Tab value="hapi">

```tsx

supertokens.init({
    framework: "hapi",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init(), // initializes session features
        UserMetadata.init() // initializes the user metadata feature
    ]
});
```
</Tab>

<Tab value="fastify">

```tsx

supertokens.init({
    framework: "fastify",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init(), // initializes session features
        UserMetadata.init() // initializes the user metadata feature
    ]
});
```
</Tab>

<Tab value="koa">

```tsx

supertokens.init({
    framework: "koa",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init(), // initializes session features
        UserMetadata.init() // initializes the user metadata feature
    ]
});
```
</Tab>

<Tab value="loopback">

```tsx

supertokens.init({
    framework: "loopback",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init(), // initializes session features
        UserMetadata.init() // initializes the user metadata feature
    ]
});
```
</Tab>
// <Tab value="serverless">
//
// :::important
// Please refer the **serverless deployment** section in the ThirdParty + EmailPassword recipe guide
// :::
//
// </Tab>
// <Tab value="nextjs">
//
// :::important
// Please refer the **NextJS** section in the ThirdParty + EmailPassword recipe guide
// :::
//
// </Tab>
// <Tab value="nestjs">
//
// :::important
// Please refer the **NestJS** section in the ThirdParty + EmailPassword recipe guide
// :::
//
// </Tab>
</Tabs>
</Tab>

<Tab value="go">

```go showAppTypeSelect

/*
This will be used to modify the session's access token payload
to add {"2fa-completed": false} into it.
*/
// highlight-start
export const SecondFactorClaim = new BooleanClaim({
    fetchValue: () => false,
    key: "2fa-completed",
});
// highlight-end

Session.init({
    override: {
        functions: (originalImplementation) => {
            return {
                ...originalImplementation,
                /* This function is called after signing in or signing up via the first factor */
                createNewSession: async function (input) {
                    return originalImplementation.createNewSession({
                        ...input,
                        accessTokenPayload: {
                            ...input.accessTokenPayload,
                            // highlight-next-line
                            ...(await SecondFactorClaim.build(input.userId, input.recipeUserId, input.tenantId, undefined, input.userContext)),
                        },
                    });
                },
            };
        },
    },
})
```

</Tab>
<Tab value="go">

```go

# Additional Verification - Multi Factor Authentication - Legacy method - Backend Setup -  Setting up the 2nd factor
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/backend-setup/second-factor

## 1. Initialisation

We use the [Passwordless recipe](https://supertokens.com/docs/passwordless/introduction) with SMS OTP as the second factor. You can follow the recipe's [backend quick setup guide](https://supertokens.com/docs/passwordless/quick-setup/backend) to configure a different method as well (for example with email magic links).

The `Passwordless.init` function should look something like this:



<Tabs>
<Tab value="nodejs">

<Tabs exclude={["awsLambda", "nextjs", "nestjs"]} showAppTypeSelect>
<Tab value="express">

```tsx

supertokens.init({
    framework: "express",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/thirdpartyemailpassword/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE"
        }),
        // highlight-end
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init({/*Override from previous step*/})
    ]
});
```
</Tab>

<Tab value="hapi">

```tsx

supertokens.init({
    framework: "hapi",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE"
        }),
        // highlight-end
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init({ /*Override from previous step*/ })
    ]
});
```
</Tab>

<Tab value="fastify">

```tsx

supertokens.init({
    framework: "fastify",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE"
        }),
        // highlight-end
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init({/*Override from previous step*/})
    ]
});
```
</Tab>

<Tab value="koa">

```tsx

supertokens.init({
    framework: "koa",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE"
        }),
        // highlight-end
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init({/*Override from previous step*/})
    ]
});
```
</Tab>

<Tab value="loopback">

```tsx

supertokens.init({
    framework: "loopback",
    supertokens: {
        connectionURI: "<CORE_URI>",
        apiKey: "^{coreInfo.key}",
    },
    appInfo: {
        // learn more about this on https://supertokens.com/docs/session/appinfo
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        // highlight-start
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE"
        }),
        // highlight-end
        ThirdParty.init({
            //...
        }),
        EmailPassword.init({
            //...
        }),
        Session.init({/*Override from previous step*/})
    ]
});
```
</Tab>
<Tab value="serverless">

:::important
Please refer the **serverless deployment** section in the Passwordless recipe guide
:::

</Tab>
<Tab value="nextjs">

:::important
Please refer the **NextJS** section in the Passwordless recipe guide
:::

</Tab>
<Tab value="nestjs">

:::important
Please refer the **NestJS** section in the Passwordless recipe guide
:::

</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go showAppTypeSelect
			}),
		},
	})

	if err != nil {
		panic(err.Error())
	}
}
```
</Tab>
<Tab value="python">
<Tabs showAppTypeSelect>
<Tab value="fastapi">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import thirdparty, emailpassword, session, passwordless
from supertokens_python.recipe.passwordless import ContactPhoneOnlyConfig

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="<CORE_URI>",
        api_key="^{coreInfo.key}"
    ),
    framework='fastapi',
    recipe_list=[
	    session.init(), # contains the override from the previous step
        thirdparty.init(
           # ...
        ),
        emailpassword.init(
            # ...
        ),
        # highlight-start
        passwordless.init(
            flow_type="USER_INPUT_CODE",
            contact_config=ContactPhoneOnlyConfig()
        )
        # highlight-end
    ],
    mode='asgi' # use wsgi if you are running using gunicorn
)
```

</Tab>
<Tab value="flask">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import thirdparty, emailpassword, session, passwordless
from supertokens_python.recipe.passwordless import ContactPhoneOnlyConfig

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="<CORE_URI>",
        api_key="^{coreInfo.key}"
    ),
    framework='flask',
    recipe_list=[
	    session.init(), # contains the override from the previous step
        thirdparty.init(
           # ...
        ),
        emailpassword.init(
            # ...
        ),
        # highlight-start
        passwordless.init(
            flow_type="USER_INPUT_CODE",
            contact_config=ContactPhoneOnlyConfig()
        )
        # highlight-end
    ]
)
```

</Tab>
<Tab value="django">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import thirdparty, emailpassword, session, passwordless
from supertokens_python.recipe.passwordless import ContactPhoneOnlyConfig

init(
    app_info=InputAppInfo(
        app_name="<APP_NAME>",
        api_domain="<API_DOMAIN>",
        website_domain="<WEBSITE_DOMAIN>",
        api_base_path="<API_BASE_PATH>",
        website_base_path="<WEBSITE_BASE_PATH>"
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="<CORE_URI>",
        api_key="^{coreInfo.key}"
    ),
    framework='django',
    recipe_list=[
	    session.init(), # contains the override from the previous step
        thirdparty.init(
           # ...
        ),
        emailpassword.init(
            # ...
        ),
        # highlight-start
        passwordless.init(
            flow_type="USER_INPUT_CODE",
            contact_config=ContactPhoneOnlyConfig()
        )
        # highlight-end
    ],
    mode='asgi' # use wsgi if you are running django server in sync mode
)
```

</Tab>
</Tabs>
</Tab>
</Tabs>

The above exposes all the APIs to the frontend that can be used to create and verify the OTP.

## 2. Saving the user's phone number post second factor auth

During sign up, once the user has completed the second factor, we want to save their phone number against their profile. For this, we use the `UserMetadata` recipe.

:::important
Make sure to add the User Metadata in the recipe list.
:::

The passwordless recipe creates a new `userId` for the user against which it saves the phone number. We can associate the passwordless `userId` with the `userId` of the first factor, and this way, we associate a phone number to the user:

<Tabs>
<Tab value="nodejs">

```tsx

Passwordless.init({
    flowType: "USER_INPUT_CODE",
    contactMethod: "PHONE",
    override: {
        apis: (oI) => {
            return {
                ...oI,
                // this API is called when the user enters the OTP
                consumeCodePOST: async function (input) {
                    // - We should already have a session here since this is called after first factor login
                    // - We set the claims to check to be [] here, since this needs to be callable 
                    // without the second factor completed
                    let session = await Session.getSession(input.options.req, input.options.res, {
                        overrideGlobalClaimValidators: () => [],
                    });
                    
                    let resp = await oI.consumeCodePOST!(input);

                    if (resp.status === "OK") {
                        // OTP verification was successful. We can now associate 
                        // the passwordless user ID with the thirdpartyemailpassword
                        // user ID, so that later on, we can fetch the phone number.
                        await UserMetadata.updateUserMetadata(
                            session!.getUserId(), // this is the userId of the first factor login
                            {
                                passwordlessUserId: resp.user.id,
                            }
                        );
                    }

                    return resp;
                },
            };
        },
    }
})
```

</Tab>
<Tab value="go">

```go
declare const SecondFactorClaim: BooleanClaim; // REMOVE_FROM_OUTPUT

Passwordless.init({
    flowType: "USER_INPUT_CODE",
    contactMethod: "PHONE",
    override: {
        apis: (oI) => {
            return {
                ...oI,
                // this API is called when the user enters the OTP
                consumeCodePOST: async function (input) {
                    // A session should already exist since this should be called after the first factor is completed.
                    // We set the claims to check to be [] here, since this needs to be callable 
                    // without the second factor completed
                    let session = await Session.getSession(input.options.req, input.options.res, {
                        overrideGlobalClaimValidators: () => [],
                    });
                    
                    // highlight-start
                    // we add the existing session to the user context so that the createNewSession
                    // function doesn't create a new session
                    input.userContext.session = session;
                    // highlight-end

                    let resp = await oI.consumeCodePOST!(input);

                    if (resp.status === "OK") {
                        // highlight-start
                        // OTP verification was successful. 
                        // We can now set the SecondFactorClaim in the session to true.
                        // the user has access to API routes and the frontend UI
                        await resp.session.setClaimValue(SecondFactorClaim, true);
                        // highlight-end

                        // We can now associate 
                        // the passwordless user ID with the thirdpartyemailpassword
                        // user ID, so that later on, we can fetch the phone number.
                        await UserMetadata.updateUserMetadata(
                            session!.getUserId(), // this is the userId of the first factor login
                            {
                                passwordlessUserId: resp.user.id,
                            }
                        );
                    }

                    return resp;
                },
            };
        },
    }
})

Session.init({
    override: {
        functions: (originalImplementation) => {
            return {
                ...originalImplementation,
                /* This function is called after signing in or signing up via the first factor */
                createNewSession: async function (input) {
                    // highlight-start
                    if (input.userContext.session !== undefined) {
                        /**
                        * This is true for the second factor login.
                        * So instead of creating a new session, we return the already existing one.
                        */
                        return input.userContext.session;
                    }
                    // highlight-end
                    return originalImplementation.createNewSession({
                        ...input,
                        accessTokenPayload: {
                            ...input.accessTokenPayload,
                            ...(await SecondFactorClaim.build(input.userId, input.recipeUserId, input.tenantId, undefined, input.userContext)),
                        },
                    });
                },
            };
        },
    },
})
```

</Tab>
<Tab value="go">

```go
						/**
						 * This will be true for the second factor login.
						 * So instead of creating a new session, we return the already existing one.
						 */
						return session, nil
					}
					// highlight-end

					if accessTokenPayload == nil {
						accessTokenPayload = map[string]interface{}{}
					}
					accessTokenPayload, err := SecondFactorClaim.Build(userID, tenantId, accessTokenPayload, userContext)
					if err != nil {
						return nil, err
					}
					return oCreateNewSession(userID, accessTokenPayload, sessionDataInDatabase, disableAntiCsrf, tenantId, userContext)
				}
				return originalImplementation
			},
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python.recipe.passwordless.interfaces import (
    APIInterface,
    APIOptions,
    ConsumeCodePostOkResult,
)
from typing import Union, Dict, Any, Optional
from supertokens_python.recipe.session.asyncio import get_session
from supertokens_python.recipe.usermetadata.asyncio import update_user_metadata
from supertokens_python.recipe.session.interfaces import (
    SessionContainer,
    RecipeInterface,
)
from supertokens_python.recipe.session.claims import BooleanClaim
from supertokens_python.types import RecipeUserId

SecondFactorClaim = BooleanClaim(
    key="2fa-completed", fetch_value=lambda _, __, ___, ____, _____: False
)

def override_passwordless_apis(original_implementation: APIInterface):
    original_consume_code_post = original_implementation.consume_code_post

    async def consume_code_post(
        pre_auth_session_id: str,
        user_input_code: Union[str, None],
        device_id: Union[str, None],
        link_code: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        # this API is called when the user enters the OTP

        # A session should already exist since this should be called after the first factor is completed.
        # We set the claims to check to be [] here, since this needs to be callable
        # without the second factor completed
        _session = await get_session(
            api_options.request, override_global_claim_validators=lambda _, __, ___: []
        )
        assert _session is not None

        # we should add the existing session to the user_context
        # so that the create_new_session function
        # doesn't create a new session
        # highlight-next-line
        user_context["session"] = _session

        res = await original_consume_code_post(
            pre_auth_session_id,
            user_input_code,
            device_id,
            link_code,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

        if isinstance(res, ConsumeCodePostOkResult):
            # highlight-start
            # OTP verification was successful. We can now mark the
            # session's payload as {"is2faComplete": True} so that
            # the user has access to API routes and the frontend UI
            await _session.set_claim_value(SecondFactorClaim, True)
            # highlight-end

            # We can now associate
            # the passwordless user ID with the thirdpartyemailpassword
            # user ID, so that later on, we can fetch the phone number.
            await update_user_metadata(
                _session.get_user_id(),  # userId of the first factor login
                {"passwordlessUserId": res.user.id},
            )

        return res

    original_implementation.consume_code_post = consume_code_post
    return original_implementation

def override_session_functions(original_implementation: RecipeInterface):
    original_create_new_session = original_implementation.create_new_session

    async def create_new_session(
        user_id: str,
        recipe_user_id: RecipeUserId,
        access_token_payload: Optional[Dict[str, Any]],
        session_data_in_database: Optional[Dict[str, Any]],
        disable_anti_csrf: Optional[bool],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):
        # This function is called after signing in or
        # signing up via the first factor

        # highlight-start
        _session = user_context.get("session")
        if _session and isinstance(_session, SessionContainer):
            # This is true for the second factor login.
            # So instead of creating a new session, we return the already existing one.
            return _session
        # highlight-end

        if access_token_payload is None:
            access_token_payload = {}

        access_token_payload = {
            **access_token_payload,
            **(
                await SecondFactorClaim.build(
                    user_id,
                    recipe_user_id,
                    tenant_id,
                    access_token_payload,
                    user_context,
                )
            ),
        }
        return await original_create_new_session(
            user_id,
            recipe_user_id,
            access_token_payload,
            session_data_in_database,
            disable_anti_csrf,
            tenant_id,
            user_context,
        )

    original_implementation.create_new_session = create_new_session
    return original_implementation
```

</Tab>
</Tabs>

## 4. Validating the phone number

By default, the Passwordless API for sending an OTP (`createCodePOST`) sends the OTP to the input phone number, and if we don't modify that, the attack below is be possible:

- Alice (user) signs up using a weak password and their phone number.
- Mallory (attacker) successfully guesses Alice's password and queries the OTP sending API manually, to inject their phone number for the second factor auth.
- OTP is sent to Mallory's phone number and they can pass the second factor challenge.

To make it secure, we override the `createCodePOST` API and check that the input phone number is the same as the phone number associated with the user. If it's not the same, we throw an error, and if it is the same, we continue:

<Tabs>
<Tab value="nodejs">

```tsx

Passwordless.init({
    flowType: "USER_INPUT_CODE",
    contactMethod: "PHONE",
    override: {
        apis: (oI) => {
            return {
                ...oI,
                /*This API is called to send an OTP*/
                createCodePOST: async function (input) {
                    /**
                    * We want to make sure that the OTP being generated is for the
                    * same number that belongs to this user.
                    */

                    // A session should already exist since this should be called after the first factor is completed.
                    // We set the claims to check to be [] here, since this needs to be callable 
                    // without the second factor completed
                    let session = await Session.getSession(input.options.req, input.options.res, {
                        overrideGlobalClaimValidators: () => [],
                    });

                    // We try and get the phone number associated with this user. It is
                    // defined if this is a sign in attempt, in which case, we check that
                    // it is equal to the input phone number
                    let userMetadata = await UserMetadata.getUserMetadata(session!.getUserId());
                    let phoneNumber: string | undefined = undefined;
                    if (userMetadata.metadata.passwordlessUserId !== undefined) {
                        // the flow comes here during a login attempt, since we
                        // associate the passwordless userId to the user on sign up
                        let passwordlessUserInfo = await SuperTokens.getUser(
                            userMetadata.metadata.passwordlessUserId as string,
                            input.userContext,
                        );
                        phoneNumber = passwordlessUserInfo?.phoneNumbers[0];
                    }

                    if (phoneNumber !== undefined) {
                        // this means we found a phone number associated to this user.
                        // we check if the input phone number is the same as this one.
                        if (!("phoneNumber" in input) || input.phoneNumber !== phoneNumber) {
                            throw new Error("Input phone number is not the same as the one saved for this user");
                        }
                    }

                    return oI.createCodePOST!(input);
                },
                consumeCodePOST: async function (input) {
                    /*...Modifications from previous step */
                    let resp = await oI.consumeCodePOST!(input);
                    /*...Modifications from previous step */
                    return resp;
                },
            };
        },
    }
})
```

</Tab>
<Tab value="go">

```go
						// the flow comes here during a login attempt, since we
						// associate the passwordless userId to the user on sign up
						passwordlessUserInfo, err := passwordless.GetUserByID(passwordlessUserId, userContext)
						if err != nil {
							return plessmodels.CreateCodePOSTResponse{}, err
						}
						userPhoneNumber = passwordlessUserInfo.PhoneNumber
					}
					if userPhoneNumber != nil {
						// this means we found a phone number associated to this user.
						// we will check if the input phone number is the same as this one.
						if phoneNumber == nil || *phoneNumber != *userPhoneNumber {
							return plessmodels.CreateCodePOSTResponse{}, errors.New("Input phone number is not the same as the one saved for this user")
						}
					}

					return oCreateCodePOST(email, phoneNumber, tenantId, options, userContext)
				}
				// highlight-end
				*originalImplementation.CreateCodePOST = nCreateCodePOST

				oConsumeCodePOST := *originalImplementation.ConsumeCodePOST
				nConsumeCodePost := func(userInput *plessmodels.UserInputCodeWithDeviceID, linkCode *string, preAuthSessionID string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.ConsumeCodePOSTResponse, error) {
					/*...mofications from previous step */
					resp, err := oConsumeCodePOST(userInput, linkCode, preAuthSessionID, tenantId, options, userContext)
					/*...mofications from previous step */
					return resp, err
				}
				*originalImplementation.ConsumeCodePOST = nConsumeCodePost

				return originalImplementation
			},
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python.recipe.passwordless.interfaces import APIInterface, APIOptions
from typing import Union, Dict, Any, Optional
from supertokens_python.recipe.session.asyncio import get_session
from supertokens_python.recipe.usermetadata.asyncio import get_user_metadata
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.asyncio import get_user

def override_passwordless_apis(original_implementation: APIInterface):
    original_consume_code_post = original_implementation.consume_code_post
    original_create_code_post = original_implementation.create_code_post

    # highlight-start
    async def create_code_post(
        email: Union[str, None],
        phone_number: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        # This API is called to send an OTP

        # We want to make sure that the OTP being generated is for the
        # same number that belongs to this user.

        # A session should already exist since this should be called after the first factor is completed.
        # We set the claims to check to be [] here, since this needs to be callable
        # without the second factor completed
        _session = await get_session(
            api_options.request, override_global_claim_validators=lambda _, __, ___: []
        )
        assert _session is not None

        # We try to get the phone number associated with this user. It is
        # defined if this is a sign in attempt, in which case, we check that
        # it is equal to the input phone number
        user_metadata = await get_user_metadata(_session.get_user_id())
        user_metadata_phone_number: Optional[str] = None
        if user_metadata.metadata.get("passwordlessUserId"):
            # the flow comes here during a login attempt, since we
            # associate the passwordless userId to the user on sign up
            passwordless_user_info = await get_user(
                user_metadata.metadata["passwordlessUserId"], user_context
            )
            if passwordless_user_info is not None:
                user_metadata_phone_number = passwordless_user_info.phone_numbers[0]

        if user_metadata_phone_number is not None:
            # this means we found a phone number associated to this user
            # we will check if the input phone number is the same as this one.
            if (phone_number is None) or (phone_number != user_metadata_phone_number):
                raise Exception(
                    "Input phone number is not the same as the one saved for this user"
                )

        return await original_create_code_post(
            email,
            phone_number,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

    # highlight-end

    async def consume_code_post(
        pre_auth_session_id: str,
        user_input_code: Union[str, None],
        device_id: Union[str, None],
        link_code: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        # ...Modifications from previous step
        res = await original_consume_code_post(
            pre_auth_session_id,
            user_input_code,
            device_id,
            link_code,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )
        # ...Modifications from previous step
        return res

    original_implementation.create_code_post = create_code_post
    original_implementation.consume_code_post = consume_code_post
    return original_implementation
```

</Tab>
</Tabs>

## 5. Storing the user's phone number in the session

When the session is first created (after the first factor is completed), we store the user's phone number in the session (if it exists), so that the frontend can call the `createCodePOST` API (to initiate the second factor challenge) without asking the user for their phone number again.

We do this by modifying the `createNewSession` function in the `Session.init` call:

<Tabs>
<Tab value="nodejs">

```tsx
declare const SecondFactorClaim: BooleanClaim; // REMOVE_FROM_OUTPUT

Session.init({
    override: {
        functions: (originalImplementation) => {
            return {
                ...originalImplementation,
                /* This function is called after signing in or signing up via the first factor */
                createNewSession: async function (input) {
                    if (input.userContext.session !== undefined) {
                        /**
                        * This is true for the second factor login.
                        * So instead of creating a new session, we return the already existing one.
                        */
                        return input.userContext.session;
                    }

                    // highlight-start
                    // we first get the passwordless userId associated with this user
                    // using the UserMetadata recipe
                    let userMetadata = await UserMetadata.getUserMetadata(input.userId);
                    let phoneNumber: string | undefined = undefined;
                    if (userMetadata.metadata.passwordlessUserId !== undefined) {
                        // We get the phone number associated with the passwordless userId.
                        let passwordlessUserInfo = await SuperTokens.getUser(
                            userMetadata.metadata.passwordlessUserId as string,
                            input.userContext,
                        );
                        phoneNumber = passwordlessUserInfo?.phoneNumbers[0];
                    }
                    // highlight-end

                    return originalImplementation.createNewSession({
                        ...input,
                        accessTokenPayload: {
                            ...input.accessTokenPayload,
                            ...(await SecondFactorClaim.build(input.userId, input.recipeUserId, input.tenantId, undefined, input.userContext)),
                            // highlight-next-line
                            phoneNumber,
                        },
                    });
                },
            };
        },
    },
})
```

</Tab>
<Tab value="go">

```go
						/**
						 * This will be true for the second factor login.
						 * So instead of creating a new session, we return the already existing one.
						 */
						return session, nil
					}

					// highlight-start
					// we first get the passwordless userId associated with this user
					// using the UserMetadata recipe
					userMetadata, err := usermetadata.GetUserMetadata(userID, userContext)
					if err != nil {
						return nil, err
					}
					var userPhoneNumber *string
					if passwordlessUserId, ok := userMetadata["passwordlessUserId"].(string); ok {
						passwordlessUserInfo, err := passwordless.GetUserByID(passwordlessUserId, userContext)
						if err != nil {
							return nil, err
						}
						userPhoneNumber = passwordlessUserInfo.PhoneNumber
					}
					// highlight-end

					if accessTokenPayload == nil {
						accessTokenPayload = map[string]interface{}{}
					}
					accessTokenPayload, err = SecondFactorClaim.Build(userID, tenantId, accessTokenPayload, userContext)
					if err != nil {
						return nil, err
					}
					// highlight-start
					if userPhoneNumber != nil {
						accessTokenPayload["phoneNumber"] = *userPhoneNumber
					}
					// highlight-end
					return oCreateNewSession(userID, accessTokenPayload, sessionDataInDatabase, disableAntiCsrf, tenantId, userContext)
				}
				return originalImplementation
			},
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from typing import Dict, Any, Optional
from supertokens_python.recipe.usermetadata.asyncio import get_user_metadata
from supertokens_python.asyncio import get_user
from supertokens_python.recipe.session.interfaces import (
    SessionContainer,
    RecipeInterface,
)
from supertokens_python.recipe.session.claims import BooleanClaim
from supertokens_python.types import RecipeUserId

SecondFactorClaim = BooleanClaim(
    key="2fa-completed", fetch_value=lambda _, __, ___, ____, _____: False
)

def override_session_functions(original_implementation: RecipeInterface):
    original_create_new_session = original_implementation.create_new_session

    async def create_new_session(
        user_id: str,
        recipe_user_id: RecipeUserId,
        access_token_payload: Optional[Dict[str, Any]],
        session_data_in_database: Optional[Dict[str, Any]],
        disable_anti_csrf: Optional[bool],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):
        # This function is called after signing in
        # or signing up via the first factor

        _session = user_context.get("session")
        if _session and isinstance(_session, SessionContainer):
            # This is true for the second factor login.
            # So instead of creating a new session, we return the already existing one.
            return _session

        if access_token_payload is None:
            access_token_payload = {}

        # highlight-start
        # we first get the passwordless user id associated with this user
        # using the user_metadata recipe
        user_metadata = await get_user_metadata(user_id)
        phone_number: Optional[str] = None
        if user_metadata.metadata.get("passwordlessUserId") is not None:
            # We get the phone number associated with the passwordless userId
            passwordless_user_info = await get_user(
                user_metadata.metadata["passwordlessUserId"], user_context
            )
            if passwordless_user_info is not None:
                phone_number = passwordless_user_info.phone_numbers[0]
        # highlight-end

        # Insert "is2faComplete" and "phoneNumber" in the access token payload
        access_token_payload = {
            **access_token_payload,
            **(
                await SecondFactorClaim.build(
                    user_id,
                    recipe_user_id,
                    tenant_id,
                    access_token_payload,
                    user_context,
                )
            ),
            # highlight-next-line
            "phoneNumber": phone_number,
        }
        return await original_create_new_session(
            user_id,
            recipe_user_id,
            access_token_payload,
            session_data_in_database,
            disable_anti_csrf,
            tenant_id,
            user_context,
        )

    original_implementation.create_new_session = create_new_session
    return original_implementation
```

</Tab>
</Tabs>

We can then further modify the customisation in step (4) to simply read from the session's payload making it more efficient:

<Tabs>
<Tab value="nodejs">

```tsx

Passwordless.init({
    flowType: "USER_INPUT_CODE",
    contactMethod: "PHONE",
    override: {
        apis: (oI) => {
            return {
                ...oI,
                /*This API is called to send an OTP*/
                createCodePOST: async function (input) {
                    /**
                    * We want to make sure that the OTP being generated is for the
                    * same number that belongs to this user.
                    */

                    // A session should already exist since this should be called after the first factor is completed.
                    // We remove claim checking here, since this needs to be callable without the second factor completed
                    let session = await Session.getSession(input.options.req, input.options.res, {
                        overrideGlobalClaimValidators: () => [],
                    });

                    // highlight-next-line
                    let phoneNumber: string = session!.getAccessTokenPayload().phoneNumber;

                    if (phoneNumber !== undefined) {
                        // this means we found a phone number associated to this user.
                        // we check if the input phone number is the same as this one.
                        if (!("phoneNumber" in input) || input.phoneNumber !== phoneNumber) {
                            throw new Error("Input phone number is not the same as the one saved for this user");
                        }
                    }

                    return oI.createCodePOST!(input);
                },
                consumeCodePOST: async function (input) {
                    /*...Modifications from previous step */
                    let resp = await oI.consumeCodePOST!(input);
                    /*...Modifications from previous step */
                    return resp;
                },
            };
        },
    }
})
```

</Tab>
<Tab value="go">

```go
						userPhoneNumber = &phoneNumber
					}
					// highlight-end

					if userPhoneNumber != nil {
						// this means we found a phone number associated to this user.
						// we will check if the input phone number is the same as this one.
						if phoneNumber == nil || *phoneNumber != *userPhoneNumber {
							return plessmodels.CreateCodePOSTResponse{}, errors.New("Input phone number is not the same as the one saved for this user")
						}
					}

					return oCreateCodePOST(email, phoneNumber, tenantId, options, userContext)
				}
				*originalImplementation.CreateCodePOST = nCreateCodePOST

				oConsumeCodePOST := *originalImplementation.ConsumeCodePOST
				nConsumeCodePost := func(userInput *plessmodels.UserInputCodeWithDeviceID, linkCode *string, preAuthSessionID string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.ConsumeCodePOSTResponse, error) {
					/*...mofications from previous step */
					resp, err := oConsumeCodePOST(userInput, linkCode, preAuthSessionID, tenantId, options, userContext)
					/*...mofications from previous step */
					return resp, err
				}
				*originalImplementation.ConsumeCodePOST = nConsumeCodePost

				return originalImplementation
			},
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python.recipe.passwordless.interfaces import APIInterface, APIOptions
from typing import Union, Dict, Any, Optional
from supertokens_python.recipe.session.asyncio import get_session
from supertokens_python.recipe.session.interfaces import SessionContainer

def override_passwordless_apis(original_implementation: APIInterface):
    original_create_code_post = original_implementation.create_code_post

    async def create_code_post(
        email: Union[str, None],
        phone_number: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        # This API is called to send an OTP

        # We want to make sure that the OTP being generated is for the
        # same number that belongs to this user.

        # A session should already exist since this should be called after the first factor is completed.
        # We set the claims to check to be [] here, since this needs to be callable
        # without the second factor completed
        _session = await get_session(
            api_options.request, override_global_claim_validators=lambda _, __, ___: []
        )
        assert _session is not None

        # highlight-next-line
        payload_phone_number = _session.get_access_token_payload().get("phoneNumber")

        if payload_phone_number is not None:
            # this means we found a phone number associated to this user
            # we will check if the input phone number is the same as this one.
            if (phone_number is None) or (phone_number != payload_phone_number):
                raise Exception(
                    "Input phone number is not the same as the one saved for this user"
                )

        return await original_create_code_post(
            email,
            phone_number,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

    original_implementation.create_code_post = create_code_post
```

</Tab>
</Tabs>

# Additional Verification - Multi Factor Authentication - Legacy method - Backend Setup -  Protecting API routes
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/backend-setup/protecting-api

In the previous steps, we saw the a session is created after the first factor, with `SecondFactorClaim` set to false, and then after the second factor is completed, we update that value to true.

## 1. Protecting all APIs

We want to protect all the application APIs such that they are accessible only when `SecondFactorClaim` is `true` - indicating that the user has completed 2FA. We can do this by by overriding the `getGlobalClaimValidators` function in the Session recipe.

<Tabs>
<Tab value="nodejs">

```tsx
declare const SecondFactorClaim: BooleanClaim; // REMOVE_FROM_OUTPUT

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                getGlobalClaimValidators: (input) => [
                    ...input.claimValidatorsAddedByOtherRecipes,
                    SecondFactorClaim.validators.hasValue(true),
                ],
            };
        },
    }
})

```

</Tab>
<Tab value="go">

```go
declare const SecondFactorClaim: BooleanClaim; // REMOVE_FROM_OUTPUT

let app = express();

app.post("/like-comment", verifySession({
    // highlight-start
    overrideGlobalClaimValidators: (globalValidators) => [
        ...globalValidators, 
        SecondFactorClaim.validators.hasValue(true),
    ]
    // highlight-end
}), (req: SessionRequest, res) => {
    //....
});
```

</Tab>
<Tab value="go">

```go

# Additional Verification - Multi Factor Authentication - Legacy method -  Using a custom UI
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/frontend-custom

## 1. First factor recipe init

Start by following the recipe guide for first factor login. To continue building our example app, we will use the `thirdparty` and the `emailpassword` recipes as the first factor.

After following the [frontend quick setup section](/docs/quickstart/introduction) and the [social login guide](/docs/authentication/social/initial-setup), you should have the following `supertokens.init`:

<Tabs>
<Tab value="npm">



```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        EmailPassword.init(),
        ThirdParty.init()
    ],
});
```

</Tab>
<Tab value="scripts">



```tsx
supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init(),
        supertokensEmailPassword.init(),
        supertokensThirdParty.init()
    ],
});
```

</Tab>
</Tabs>

From here on, you can continue to build out the first factor's login form using the functions exposed from the `supertokens-web-js` SDK. 

## 2. Second factor recipe init

For the second factor, we will be using the [passwordless recipe](https://supertokens.com/docs/passwordless/introduction). After following the [frontend quick setup section](https://supertokens.com/docs/passwordless/quick-setup/frontend), you should have the following `supertokens.init`:

<Tabs>
<Tab value="npm">



```tsx
// highlight-next-line

SuperTokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        Session.init(),
        EmailPassword.init(),
        ThirdParty.init(),
        // highlight-next-line
        Passwordless.init(),
    ],
});
```

</Tab>
<Tab value="scripts">



```tsx
supertokens.init({
    appInfo: {
        apiDomain: "<API_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init(),
        supertokensEmailPassword.init(),
        supertokensThirdParty.init(),
        // highlight-next-line
        supertokensPasswordless.init()
    ],
});
```

</Tab>
</Tabs>

You can use the passwordless recipe function to build the second factor UI.

## 3. Reading 2FA completion information from the session for routing

You will want to handle the routing of `webapp` to make sure that the correct login factor is being shown. This can be done by reading the session information.

### Checking if the first factor login should be shown

<Tabs>
<Tab value="npm">

```tsx

async function shouldShowFirstFactor() {
    return !(await Session.doesSessionExist());
}
```

</Tab>
<Tab value="scripts">

```tsx
async function shouldShowFirstFactor() {
    return !(await supertokensSession.doesSessionExist());
}
```

</Tab>
</Tabs>

If a session does not exist, this means that the user has not completed the first factor. In this case, you want to route them to the `thirdparty` + `emailpassword` login screen.

### Checking if the second factor login should be shown

<Tabs>
<Tab value="npm">

```tsx

// highlight-start
export const SecondFactorClaim = new BooleanClaim({
    id: "2fa-completed",
    refresh: async () => {
        // no-op
    },
});

async function shouldShowSecondFactor() {
    if(await shouldShowFirstFactor()) {
        return false;
    }

    return !(await Session.getClaimValue({ claim: SecondFactorClaim }));
}
// highlight-end

async function shouldShowFirstFactor() {
    return !(await Session.doesSessionExist());
}
```

</Tab>
<Tab value="scripts">

```tsx
// highlight-start
// This could be moved into a separate file...
export const SecondFactorClaim = new supertokensSession.BooleanClaim({
    id: "2fa-completed",
    refresh: async () => {
        // This is something we have no way of refreshing, so this is a no-op
    },
});

async function shouldShowSecondFactor() {
    if(await shouldShowFirstFactor()) {
        return false;
    }
    if (await supertokensSession.getClaimValue({ claim: SecondFactorClaim })) {
        return false;
    }
    return true;
}
// highlight-end

async function shouldShowFirstFactor() {
    return !(await supertokensSession.doesSessionExist());
}
```

</Tab>
</Tabs>

- If a session does not exist, it means that the user has not finished the first factor yet.
- If a session exists, but the `SecondFactorClaim` value is `true`, it means that the user has finished both the factors.
- Otherwise the user has finished the first factor, but not the second one.

### Protecting a website route that requires both the factors
You can check if a user has finished both the login factors using the two functions above:

```tsx
async function areBothLoginFactorsCompleted(): Promise<boolean> {
    // @ts-ignore
    return !(await shouldShowFirstFactor()) && !(await shouldShowSecondFactor())
}

areBothLoginFactorsCompleted().then(async (bothFactorsCompleted) => {
    if (bothFactorsCompleted) {
        // update state to show UI
    } else {
        // @ts-ignore
        if (await shouldShowFirstFactor()) {
            // redirect user to first factor
        } else {
            // redirect user to second factor screen
        }
    }
})
```

## 4. Getting the user's phone number for the second factor

Once the user has finished the sign up process, we save their phone number in the session (as seen in the backend setup steps). This can be accessed on the frontend to send the OTP to the user without asking them to re-enter their phone after sign in:

<Tabs>
<Tab value="npm">

```tsx

async function getUsersPhoneNumber(): Promise<string | undefined> {
    if (!(await Session.doesSessionExist())) {
        // the user has not finished the first factor.
        return undefined;
    }
    let accessTokenPayload = await Session.getAccessTokenPayloadSecurely();
    if (accessTokenPayload.phoneNumber === undefined) {
        // this means that the user is still signing up, or it means that the user
        // had previously tried to sign up, but didn't complete the second factor step,
        // and has now just signed in.

        // In this case, we should ask the user to enter their phone number.
        return undefined;
    }

    // An OTP can be sent to this phone for the second factor. 
    // No need to ask the user to enter their phone number again. 
    return accessTokenPayload.phoneNumber;
}
```

</Tab>
<Tab value="scripts">

```tsx
async function getUsersPhoneNumber(): Promise<string | undefined> {
    if (!(await supertokensSession.doesSessionExist())) {
        // the user has not finished the first factor.
        return undefined;
    }
    let accessTokenPayload = await supertokensSession.getAccessTokenPayloadSecurely();
    if (accessTokenPayload.phoneNumber === undefined) {
        // this means that the user is still signing up, or it means that the user
        // had previously tried to sign up, but didn't complete the second factor step,
        // and has now just signed in.

        // In this case, we should ask the user to enter their phone number.
        return undefined;
    }

    // An OTP can be sent to this phone for the second factor. 
    // No need to ask the user to enter their phone number again. 
    return accessTokenPayload.phoneNumber;
}
```

</Tab>
</Tabs>

## 5. Implementing logout

If the user has completed both the factors, implementing the sign out feature can be done by:

<Tabs>
<Tab value="npm">

```tsx

async function signOut() {
    await Session.signOut();
    // redirect the user to the first factor login screen
}
```

</Tab>
<Tab value="scripts">

```tsx
async function signOut() {
    await supertokensSession.signOut();
    // redirect the user to the first factor login screen
}
```

</Tab>
</Tabs>

You should also implement a sign out button on the second factor screen, otherwise the user would be in a stuck state if they are unable to complete the second factor. To do this, you will need to call the `signOut` function as well as a function to clear the passwordless login state:

<Tabs>
<Tab value="npm">

```tsx

async function signOut() {
    // @ts-ignore
    if (await shouldShowSecondFactor()) {
        // this means we are on the second factor screen now.
        // calling the function below clears the login attempt info that is 
        // saved on the browser during passwordless login. This is needed so that
        // future login attempts are not affected by the current one.
        await Passwordless.clearLoginAttemptInfo();
    }
    await Session.signOut();
    // redirect the user to the first factor login screen
}
```

</Tab>
<Tab value="scripts">

```tsx
async function signOut() {
    // @ts-ignore
    if (await shouldShowSecondFactor()) {
        // this means we are on the second factor screen now.
        // calling the function below clears the login attempt info that is 
        // saved on the browser during passwordless login. This is needed so that
        // future login attempts are not affected by the current one.
        await supertokensPasswordless.clearLoginAttemptInfo();
    }
    await supertokensSession.signOut();
    // redirect the user to the first factor login screen
}
```

</Tab>
</Tabs>

# Additional Verification - Multi Factor Authentication - Legacy method - Using prebuilt UI -  1. Recipe init
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/prebuilt-ui/init

:::info Caution
This is the legacy method of implementing MFA. It has multiple [disadvantages](../legacy-vs-new) compared to using our MFA recipe.
:::


To start, we want to initialise the [ThirdParty + EmailPassword](https://supertokens.com/docs/thirdpartyemailpassword/quick-setup/frontend), the [Passwordless](https://supertokens.com/docs/passwordless/quick-setup/frontend) and the MFA recipes:



```tsx

SuperTokens.init({
    appInfo: {
        appName: "<APP_NAME>",
        apiDomain: "<API_DOMAIN>",
        websiteDomain: "<WEBSITE_DOMAIN>",
        apiBasePath: "<API_BASE_PATH>",
        websiteBasePath: "<WEBSITE_BASE_PATH>"
    },
    recipeList: [
        // first factor method
        EmailPassword.init(),
        ThirdParty.init({
            // ...
        }),
        // second factor method
        Passwordless.init({
            contactMethod: "PHONE"
        }),
        Session.init(),
        MultiFactorAuth.init({
            firstFactors: ["emailpassword", "thirdparty"],
        }),
    ]
});
```

Notice that in the `MultiFactorAuth` init, we pass in the list of `firstFactors`. This will tell SuperTokens to only show email password + third party login in the pre-built UI for the first factor, even though we have also added `Passwordless.init` in the recipe list.

In the subsequent sections, we will be seeing how to modify theses `init` calls to achieve the flow we want. On a high level, we will be:
- Rendering the Passwordless login UI on a custom path.
- Auto skipping the screen which asks the user to input their phone number if we already have it - post sign in.
- Implementing a logout button on the second factor pre-built UI screen.

:::info Important
In the guide, we will assume that the first factor path is `/auth`, and the second factor path is `/second-factor`.
:::

# Additional Verification - Multi Factor Authentication - Legacy method - Using prebuilt UI -  2. Showing the first and second factor UI
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/prebuilt-ui/showing-login-ui

:::info Caution
This is the legacy method of implementing MFA. It has multiple [disadvantages](../legacy-vs-new) compared to using our MFA recipe.
:::




## First factor UI

You should see the third party + email password login UI when you visit `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>`. 

No further step is required for the first factor.

## Create and add the `SecondFactor` claim validator

We will create a [custom claim](https://github.com/supertokens/supertokens-auth-react/blob/master/examples/with-legacy-2fa/src/secondFactorClaim.tsx) called `SecondFactorClaim` which will be responsible to check if the second factor has been completed or not. Then we can use the result in various places to protect frontend routes (in the subsequent steps).

Create a file called `SecondFactorClaim.tsx` in which you can add the following code:
```tsx

const SecondFactorClaim = new BooleanClaim({
    id: "2fa-completed",
    refresh: async () => {
        // This is something we have no way of refreshing, so this is a no-op
    },
    onFailureRedirection: () => "/second-factor",
});

export default SecondFactorClaim
```

Then in the main `session.init` in the `supertokens.init` block, add this claim's validator to run the check on each route.

```tsx

// @ts-ignore

SuperTokens.init({
    appInfo: {
        appName: "<YOUR_APP_NAME>",
        apiDomain: "<YOUR_API_DOMAIN>",
        websiteDomain: "<YOUR_WEBSITE_DOMAIN>",
        apiBasePath: "/auth",
        websiteBasePath: "/auth"
    },
    recipeList: [
        // other recipes..
        Session.init({
            override: {
                functions: (oI) => ({
                    ...oI,
                    // highlight-start
                    getGlobalClaimValidators: ({ claimValidatorsAddedByOtherRecipes }) => {
                        return [
                            SecondFactorClaim.validators.isTrue(),
                            ...claimValidatorsAddedByOtherRecipes.filter(
                                (v) => v.id !== MultiFactorAuth.MultiFactorAuthClaim.id
                            ),
                        ];
                    },
                    // highlight-end
                }),
            },
        })
    ]
});
```

In the above, we add the `SecondFactorClaim.validators.isTrue()` validator ensuring that whenever you use `SessionAuth`, we check that the second factor claim is set to true, if not, it will redirect to `/second-factor` (as defined in the claim validator). We also remove the in build `MultiFactorAuth.MultiFactorAuthClaim` since we are not using the full in built MFA recipe (as this is the legacy method).

## Second factor UI

For this guide, we will be showing the second factor UI on `/second-factor`.

### 1. Create the second factor UI on `/second-factor`

Copy & paste the code for the second-factor UI from [our demo app right here](https://github.com/supertokens/supertokens-auth-react/blob/master/examples/with-legacy-2fa/src/SecondFactor/index.tsx).

This component customises the `AuthPageTheme` component to:
- Renders the pre-built `AuthPage` with passwordless, `otp-phone` factor.
- Add a button to "login with another account" which allows users to redo the first factor.
- Redirects the user to the `/` route in case the second factor has already been completed.
- Auto sends the OTP to the user in case they are signing in and we already know their phone number. 

### 2. Override the passwordless UI components to change the header text and disable the change phone number button

Copy / Paste the following override customisations in the `Passwordless.init` function call:

```tsx

function App() {
    return (
        <SuperTokensWrapper>
            <AuthRecipeComponentsOverrideContextProvider
                components={{
                    AuthPageHeader_Override: ({ DefaultComponent, ...props }) => {
                        if (props.factorIds.includes("otp-phone")) {
                            <div
                                style={{
                                    fontSize: "30px",
                                    marginBottom: "10px",
                                }}>
                                Second factor auth
                            </div>;
                        }
                        return <DefaultComponent {...props} />;
                    },
                }}>
                <PasswordlessComponentsOverrideProvider
                    components={{
                        // we override the component which shows the change phone number button
                        PasswordlessUserInputCodeFormFooter_Override: ({ DefaultComponent, ...props }) => {
                            const session = useSessionContext();

                            if (session.loading !== true && session.accessTokenPayload.phoneNumber === undefined) {
                                // this will show the change phone number button
                                return <DefaultComponent {...props} />;
                            }

                            // this will hide the change phone number button
                            return null;
                        },
                    }}>
                    {/* Rest of the JSX */}
                </PasswordlessComponentsOverrideProvider>
            </AuthRecipeComponentsOverrideContextProvider>
        </SuperTokensWrapper>
    );
}
export default App;
```

### 3. Display the second factor component on your app's router

Finally, we add the custom component we copy / pasted before to our router:

```tsx

// @ts-ignore

function App() {
    return (
        <SuperTokensWrapper>
            <div className="App">
                <div className="fill">
                    <Routes>
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [ThirdPartyPreBuiltUI, EmailPasswordPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])}
                        // highlight-start
                        <Route
                            path="/second-factor"
                            element={
                                <SessionAuth key="/second-factor">
                                    <SecondFactor />
                                </SessionAuth>
                            }
                        />
                        // highlight-end
                    </Routes>
                </div>
            </div>
        </SuperTokensWrapper>
    );
}
```

# Additional Verification - Multi Factor Authentication - Legacy method - Using prebuilt UI -  3. Protecting routes
Source: https://supertokens.com/docs/additional-verification/mfa/legacy-mfa/prebuilt-ui/protecting-routes

:::info Caution
This is the legacy method of implementing MFA. It has multiple [disadvantages](../legacy-vs-new) compared to using our MFA recipe.
:::


Now we can wrap your application routes with the `SessionAuth` component, which should check for MFA completion by default:

```tsx
// @ts-ignore
// @ts-ignore

function App() {
    return (
        <SuperTokensWrapper>
            <div className="App">
                <div className="fill">
                    <Routes> 
                        {getSuperTokensRoutesForReactRouterDom(reactRouterDom, [ThirdPartyPreBuiltUI, EmailPasswordPreBuiltUI, PasswordlessPreBuiltUI, MultiFactorAuthPreBuiltUI])}
                        // highlight-start
                        <Route
                            path="/"
                            element={
                                <SessionAuth key="/">
                                    <Home />
                                </SessionAuth>
                            }
                        />
                        // highlight-end
                        <Route
                            path="/second-factor"
                            element={
                                <SessionAuth key="/second-factor">
                                    <SecondFactor />
                                </SessionAuth>
                            }
                        />
                    </Routes>
                </div>
            </div>
        </SuperTokensWrapper>
    );
}
```

# Additional Verification - Email Verification -  Enable email verification
Source: https://supertokens.com/docs/additional-verification/email-verification/initial-setup

## Overview

Email verification needs to be explicitly configured to work in your **SuperTokens** integration.
The functionality offers two ways to set it up:
- `REQUIRED`: The user needs to verify before they can access any protected routes.
- `OPTIONAL`: The sessions include information about the email verification status, but it is up to you to enforce the requirement based on your business logic.

## Before you start

<TokensCallout>

If you are implementing [**Unified Login**](/docs/authentication/unified-login/introduction) you must manually check the `email_verified` claim on the **OAuth2 Access Tokens**.
Please read the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to verify the token.

</TokensCallout>

For passwordless login, with email, a user's email is automatically marked as verified when they login.
Therefore, this flow only triggers if a user changes their email during a session.

## Steps

### 1. Initialize the backend recipe 

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    // highlight-start
    EmailVerification.init({
      mode: "REQUIRED", // or "OPTIONAL"
    }),
    // highlight-end
    Session.init(),
  ],
});
```

</Tab>
<Tab value="go">

```go

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    // highlight-start
    EmailVerification.init({
      mode: "REQUIRED", // or "OPTIONAL"
    }),
    // highlight-end
    Session.init(),
  ],
});

function App() {
  return (
    <SuperTokensWrapper>
      <div className="App">
        <Router>
          <div className="fill">
            <Routes>
              // highlight-start 
              {getSuperTokensRoutesForReactRouterDom(reactRouterDOM, [/* Other pre-built UI */ EmailVerificationPreBuiltUI])}
              // highlight-end 
              // ... other routes
            </Routes>
          </div>
        </Router>
      </div>
    </SuperTokensWrapper>
  );
}
```

</Answer>

<Answer title="No">

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    // highlight-start
    EmailVerification.init({
      mode: "REQUIRED", // or "OPTIONAL"
    }),
    // highlight-end
    Session.init(),
  ],
});

function App() {
  // highlight-start
  if (canHandleRoute([/* Other pre-built UI */ EmailVerificationPreBuiltUI])) {
      return getRoutingComponent([/* Other pre-built UI */ EmailVerificationPreBuiltUI])
  }
  // highlight-end
  return (
    <SuperTokensWrapper>{/*Your app*/}</SuperTokensWrapper>
  );
}
```

</Answer>

</Question>

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.
```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    // highlight-start
    supertokensUIEmailVerification.init({
      mode: "REQUIRED", // or "OPTIONAL"
    }),
    // highlight-end
  ],
});
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
  },
  recipeList: [
    // highlight-next-line
    EmailVerification.init(),
    Session.init(),
  ],
});
```

</Tab>

</Tabs>

:::important

SuperTokens triggers verification emails by redirecting the user to the email verification path when the mode is `REQUIRED`.
If you have set the mode to `OPTIONAL` or are **NOT** using the `SessionAuth` wrapper, you need to manually trigger the verification email.
The guide on [protecting API and website routes](./protecting-routes) covers the changes that you need to make. 

Additionally, note that SuperTokens does not send verification emails post user sign up.
Redirect the user to the email verification path to trigger the sending of the verification email.
This happens automatically when using the prebuilt UI and in `REQUIRED` mode. 
:::

</PrebuiltUIInstructions>

<CustomUIInstructions>

### 2. Initialize the frontend recipe



<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
  },
  recipeList: [
    // highlight-start
    EmailVerification.init(),
    Session.init(),
  ],
});
```

</Tab>
<Tab value="scripts">

Add the following `<script>` element along with the other ones in your app

```bash
# ...other script tags in the frontend init section
<script src="^{webJsVersions.emailverification}"></script>
```

Then call the `supertokensEmailVerification.init` function as shown below 

```tsx
supertokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
  },
  recipeList: [
    // highlight-start
    supertokensEmailVerification.init(),
    supertokensSession.init(),
  ],
});
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

:::success
No specific action required here.
:::

</Tab>
</Tabs>

### 3. Send the email verification email

After a user signs up, or when the email verification validators fail, you need to tell the user about the email verification process.
Redirect them to a screen that informs them about the current status and call the verification API.

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function sendEmail() {
    try {
        let response = await sendVerificationEmail();
        if (response.status === "EMAIL_ALREADY_VERIFIED_ERROR") {
            // This can happen if the info about email verification in the session was outdated.
            // Redirect the user to the home page
            window.location.assign("/home");
        } else {
            // email was sent successfully.
            window.alert("Please check your email and click the link in it")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx

async function sendEmail() {
    try {
        let response = await supertokensEmailVerification.sendVerificationEmail();
        if (response.status === "EMAIL_ALREADY_VERIFIED_ERROR") {
            // This can happen if the info about email verification in the session was outdated.
            // Redirect the user to the home page
            window.location.assign("/home");
        } else {
            // email was sent successfully.
            window.alert("Please check your email and click the link in it")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">



Create a new screen on your app that asks the user to enter their email to receive an email. This screen should ideally link to the sign in form.
Once the user has enters their email, you can call the following API to send an email verification email to that user:

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/user/email/verify/token' \
--header 'Authorization: Bearer ...'
```

The response body from the API call has a `status` property in it:
- `status: "OK"`: An email was successfully sent to the user.
- `status: "EMAIL_ALREADY_VERIFIED_ERROR"`: This status can return if the info about email verification in the session was outdated. Redirect the user to the home page.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.

:::info Multi Tenancy

You do not need to add the tenant ID to the path here because the backend fetches the `tenantId` of the user from the session token.

:::

</Tab>
</Tabs>

:::note

The API for sending an email verification email requires an active session. If you are using the frontend SDKs, then the session tokens should automatically get attached to the request.
:::

#### Change the email verification link 

By default, the email verification link points to the `websiteDomain` configured on the backend.
That would be the `/auth/verify-email` route if `/auth` is the value of `websiteBasePath`.
If you want to change this to something different, follow the next example:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailVerification.init({
            mode: "OPTIONAL",
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail(input) {
                            return originalImplementation.sendEmail({
                                ...input,
                                emailVerifyLink: input.emailVerifyLink.replace(
                                    // This is: `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/verify-email`
                                    "http://localhost:3000/auth/verify-email",
                                    "http://localhost:3000/your/path"
                                    )
                                }
                            )
                        },
                    }
                }
            }
            // highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function consumeVerificationCode() {
    try {
        let response = await verifyEmail();
        if (response.status === "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR") {
            // This can happen if the verification code is expired or invalid.
            // You should ask the user to retry
            window.alert("Oops! Seems like the verification link expired. Please try again")
            window.location.assign("/auth/verify-email") // back to the email sending screen.
        } else {
            // email was verified successfully.
            window.location.assign("/home")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
<Tab value="scripts">

```tsx

async function consumeVerificationCode() {
    try {
        let response = await supertokensEmailVerification.verifyEmail();
        if (response.status === "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR") {
            // This can happen if the verification code is expired or invalid.
            // You should ask the user to retry
            window.alert("Oops! Seems like the verification link expired. Please try again")
            window.location.assign("/auth/verify-email") // back to the email sending screen.
        } else {
            // email was verified successfully.
            window.location.assign("/home")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">



When the user clicks the email verification link, and it opens as a deep link into your mobile app, you can remove the token and call the verification API.

```bash
curl --location --request POST '<API_DOMAIN><API_BASE_PATH>/user/email/verify' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "method": "token",
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
}'
```

:::info Multi Tenancy

For a multi tenancy setup, the `<TENANT_ID>` value can fetch from `tenantId` query parameter from the email verification link. If it's not there in the link, you can use the value `"public"` (which is the default tenant).

:::

The response body from the API call has a `status` property in it:
- `status: "OK"`: Email verification was successful.
- `status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`: This can happen if the verification code expires or is invalid. You should ask the user to retry.
- `status: "GENERAL_ERROR"`: This is only possible if you have overridden the backend API to send back a custom error message which should display on the frontend.

</Tab>
</Tabs>

:::caution
- This API doesn't require an active session to succeed.
- If you are calling the above API on page load, there is an edge case in which email clients might open the verification link in the email (for scanning purposes) and consume the token in the URL. This would lead to issues in which an attacker could sign up using someone else’s email and end up with a verified status!

    To prevent this, on page load, you should check if a session exists, and if it does, only then call the above API. If a session does not exist, you should first show a button, which when clicked would call the above API (email clients do not automatically click on this button). The button text could be something like "Click here to verify your email". 
:::

</CustomUIInstructions>

## References

### Verification email

This is how the email that the user receives looks like:

<img alt="UI of the verification email sent to the registered user" width="450px" src="/img/emailpassword/email-verify-email.png" />

You can find the [source code of this template on GitHub](https://github.com/supertokens/email-sms-templates/blob/master/email-html/email-verification.html)
To understand more about how you can customize the check the [email delivery](/docs/platform-configuration/email-delivery) section. 

### Verification link lifetime

By default, the email verification link's lifetime is **1 day**.
This can change via a core's configuration (time in milliseconds):

<Tabs>
  <Tabs.ManagedContent>
<Tabs.Section py="0" px="4">
      - Go to the SuperTokens SaaS dashboard.
      - Click "Edit Configuration" on the environment you want to change.
    - Find the `email_verification_token_lifetime` property and change it.
    - Click "Save".
</Tabs.Section>
  </Tabs.ManagedContent>
  <Tabs.SelfHostedContent value="with-docker">

```bash
# Here we set the lifetime to 2 hours.

docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e EMAIL_VERIFICATION_TOKEN_LIFETIME=7200000 \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```

  </Tabs.SelfHostedContent>

  <Tabs.SelfHostedContent value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

email_verification_token_lifetime: 7200000
```

  </Tabs.SelfHostedContent>
</Tabs>


<ReferenceCard.Grid>
<ReferenceCard href="/docs/additional-verification/email-verification/manual-actions#mark-the-email-as-verified">
Change the email verification status manually
</ReferenceCard>
<ReferenceCard href="/docs/additional-verification/email-verification/manual-actions">
Generate email verification links manually
</ReferenceCard>
<ReferenceCard href="/docs/additional-verification/email-verification/protecting-routes">
Protect routes based on the email verification status
</ReferenceCard>
<ReferenceCard href="/docs/additional-verification/email-verification/hooks-and-overrides#backend-override">
Post email verification action
</ReferenceCard>
<ReferenceCard href="/docs/platform-configuration/email-delivery">
Customize the email delivery method
</ReferenceCard>
<ReferenceCard href="/docs/additional-verification/session-verification/claim-validation">
Session claim validators
</ReferenceCard>
</ReferenceCard.Grid>

# Additional Verification - Email Verification -  Protecting backend and frontend routes
Source: https://supertokens.com/docs/additional-verification/email-verification/protecting-routes

## Overview

The `EmailVerification` claim shows the status of the email verification process.
Follow this page to understand how to limit access based on whether the user has confirmed their email address.

## Before you start

<TokensCallout>

If you are implementing [**Unified Login**](/docs/authentication/unified-login/introduction), you must manually check the `email_verified` claim on the **OAuth2 Access Tokens**.
Please read the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to verify the token.

</TokensCallout>

---

## Protect backend routes

### Add email verification checks on all routes

If you want to protect all your backend API routes with email verification checks, set the `mode` to `REQUIRED` in the `EmailVerification` configuration.
Routes protected with the `verifySession` middleware additionally check for email verification status.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        EmailVerification.init({
            // This means that verifySession will now only allow calls if the user has verified their email
            mode: "REQUIRED",
        }),
        // highlight-end
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

let app = express();

app.post(
    "/update-blog",
    verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key),
    }),
    async (req: SessionRequest, res) => {
        // All validator checks have passed and the user has a verified email address
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    // highlight-next-line
                    overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key),
                }),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // All validator checks have passed and the user has a verified email address
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key),
    }),
}, async (req: SessionRequest, res) => {
    // All validator checks have passed and the user has a verified email address
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    // All validator checks have passed and the user has a verified email address
};

exports.handler = verifySession(updateBlog, {
    // highlight-next-line
    overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key)
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key)
    }), async (ctx: SessionContext, next) => {
    // All validator checks have passed and the user has a verified email address
});
```

</Tab>
<Tab value="loopback">

```tsx

class SetRole {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key)
    }))
    @response(200)
    async handler() {
        // All validator checks have passed and the user has a verified email address
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function setRole(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                // highlight-next-line
                overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key)
            })(req, res, next);
        },
        req,
        res
    )
    // All validator checks have passed and the user has a verified email address
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export async function POST(request: NextRequest) {
  return withSession(request, async (err, session) => {
    if (err) {
        return NextResponse.json(err, { status: 500 });
    }
    // We skipped checking the email verification claim 
    return NextResponse.json({});
  },
  {
    // highlight-next-line
    overrideGlobalClaimValidators: async (globalValidators) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key)
  }
  );
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard({
    // highlight-next-line
    overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => globalValidators.filter(v => v.id !== EmailVerificationClaim.key)
  }))
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    // All validator checks have passed and the user has a verified email address
    return true;
  }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="http">

```go

let app = express();

app.post(
    "/update-blog",
    verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()],
    }),
    async (req: SessionRequest, res) => {
        // All validator checks have passed and the user has a verified email address
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    // highlight-next-line
                    overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()],
                }),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // All validator checks have passed and the user has a verified email address
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()],
    }),
}, async (req: SessionRequest, res) => {
    // All validator checks have passed and the user has a verified email address
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    // All validator checks have passed and the user has a verified email address
};

exports.handler = verifySession(updateBlog, {
    // highlight-next-line
    overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()]
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()]
    }), async (ctx: SessionContext, next) => {
    // All validator checks have passed and the user has a verified email address
});
```

</Tab>
<Tab value="loopback">

```tsx

class SetRole {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession({
        // highlight-next-line
        overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()]
    }))
    @response(200)
    async handler() {
        // All validator checks have passed and the user has a verified email address
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function setRole(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                // highlight-next-line
                overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()]
            })(req, res, next);
        },
        req,
        res
    )
    // All validator checks have passed and the user has a verified email address
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export async function POST(request: NextRequest) {
  return withSession(request, async (err, session) => {
    if (err) {
        return NextResponse.json(err, { status: 500 });
    }
    // All validator checks have passed and the user has a verified email address
    return NextResponse.json({});
  },
  {
    // highlight-next-line
    overrideGlobalClaimValidators: async (globalValidators) => [...globalValidators, EmailVerificationClaim.validators.isVerified()]
  }
  );
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard({
    // highlight-next-line
    overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => [...globalValidators, EmailVerificationClaim.validators.isVerified()]
  }))
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    // All validator checks have passed and the user has a verified email address
    return true;
  }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="http">

```go

const VerifiedRoute = (props: React.PropsWithChildren<any>) => {
    return (
        <SessionAuth>
            <InvalidClaimHandler>
                {props.children}
            </InvalidClaimHandler>
        </SessionAuth>
    );
}

function InvalidClaimHandler(props: React.PropsWithChildren<any>) {
    let sessionContext = useSessionContext();
    if (sessionContext.loading) {
        return null;
    }

    if (sessionContext.invalidClaims.some(i => i.id === EmailVerificationClaim.id)) {
        // Alternatively you could redirect the user to the email verification screen to trigger the verification email
        // Note: /auth/verify-email is the default email verification path
        // window.location.assign("/auth/verify-email")
        return <div>You cannot access this page because your email address is not verified.</div>
    }

    // We show the protected route since all claims validators have
    // passed implying that the user has verified their email.
    return <div>{props.children}</div>;
}
```
In the `VerifiedRoute` component, use the `SessionAuth` wrapper to ensure that the session exists.
The `<SessionAuth>` component automatically adds the `EmailVerificationClaim` validator if you initialize the `EmailVerification` recipe.

Finally, check the result of the validation in the `InvalidClaimHandler` component which displays `"You cannot access this page because your email address is not verified.
"` if the `EmailVerificationClaim` validator failed. Alternatively you could also redirect the user to the default email verification path to trigger the sending of the verification email.

:::note
You can extend the `VerifiedRoute` component to check for other types of validators as well.
This component can then reuse to protect all your app's components (In this case, you may want to rename this component to something more appropriate, like `ProtectedRoute`).
:::

### Check the verification status manually

If you want to have more complex access control, you can either create your own validator, or you can get the boolean from the session as follows. Check it yourself:

```tsx

function ProtectedComponent() {
    let claimValue = Session.useClaimValue(EmailVerificationClaim)
    if (claimValue.loading || !claimValue.doesSessionExist) {
        return null;
    }
    let isEmailVerified = claimValue.value;
    if (isEmailVerified !== undefined && isEmailVerified) {
        //...
    } else {
        // Redirect the user the email verification path to send the verification email
        // Note: /auth/verify-email is the default email verification path
        window.location.assign("/auth/verify-email")
    }
}
```

</Tab>

<Tab value="angular">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        let validationErrors = await Session.validateClaims();

        if (validationErrors.length === 0) {
            // user has verified their email address
            return true;
        } else {
          for (const err of validationErrors) {
              if (err.id === EmailVerificationClaim.id) {
                  // email is not verified
              }
          }
        }
    }
    // a session does not exist, or email is not verified
    return false
}
```

In your protected routes, you need to first check if a session exists, and then call the `Session.validateClaims` function as shown above.
This function inspects the session's contents and runs claim validators on them.
If a claim validator fails, it reflects in the `validationErrors` variable.
The `EmailVerificationClaim` validator is automatically checked by this function since you have initialized the email verification recipe.

### Validation errors

In case the `validationErrors` array is not empty, you can loop through the errors to know which claim has failed:

```tsx

async function shouldLoadRoute() {
    let validationErrors = await Session.validateClaims(/*{...}*/);
    // highlight-start
    for (const err of validationErrors) {
        if (err.id === EmailVerificationClaim.id) {
            // email verification claim check failed
        } else {
            // some other claim check failed (from the global validators list)
        }
    }
    // highlight-end
}
```

### Check the verification status manually

If you want to have more complex access control, you can either create your own validator, or you can get the boolean from the session as follows. Check it yourself:

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        // highlight-start
        let isVerified = await Session.getClaimValue({claim: EmailVerificationClaim});
        if (isVerified) {
            // user has verified their email address
            return true;
        }
        // highlight-end
    }
    // either a session does not exist, or the user has not verified their email address
    return false
}
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

## Protect frontend routes



<Tabs>

<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        // highlight-start
        let validationErrors = await Session.validateClaims();

        if (validationErrors.length === 0) {
            // user has verified their email address
            return true;
        } else {
          for (const err of validationErrors) {
              if (err.id === EmailVerificationClaim.id) {
                  // email is not verified
                  // Send the verification email to the user
                  await sendEmail();
              }
          }
        }
        // highlight-end
    }
    // a session does not exist, or email is not verified
    return false
}

async function sendEmail() {
    try {
        let response = await sendVerificationEmail();
        if (response.status === "EMAIL_ALREADY_VERIFIED_ERROR") {
            // This can happen if the info about email verification in the session was outdated.
            // Redirect the user to the home page
            window.location.assign("/home");
        } else {
            // email was sent successfully.
            window.alert("Please check your email and click the link in it")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}

```

</Tab>
<Tab value="scripts">

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {
        // highlight-start
        let validationErrors = await supertokensSession.validateClaims();

        if (validationErrors.length === 0) {
            // user has verified their email address
            return true;
        } else {
          for (const err of validationErrors) {
              if (err.id === supertokensEmailVerification.EmailVerificationClaim.id) {
                  // email is not verified
                  // Send the verification email to the user
                  await sendEmail();
              }
          }
        }
        // highlight-end
    }
    // a session does not exist, or email is not verified
    return false
}

async function sendEmail() {
    try {
        let response = await supertokensEmailVerification.sendVerificationEmail();
        if (response.status === "EMAIL_ALREADY_VERIFIED_ERROR") {
            // This can happen if the info about email verification in the session was outdated.
            // Redirect the user to the home page
            window.location.assign("/home");
        } else {
            // email was sent successfully.
            window.alert("Please check your email and click the link in it")
        }
    } catch (err: any) {
        if (err.isSuperTokensGeneralError === true) {
            // this may be a custom error message sent from the API by you.
            window.alert(err.message);
        } else {
            window.alert("Oops! Something went wrong.");
        }
    }
}
```

</Tab>

:::note
The API for sending an email verification email requires an active session.
If you are using the frontend SDKs, then the session tokens should automatically get attached to the request.
:::

</Tabs>

In your protected routes, you need to first check if a session exists, and then call the `Session.validateClaims` function as shown above.
This function inspects the session's contents and runs claim validators on them.
If a claim validator fails, it reflects in the `validationErrors` variable.
The `EmailVerificationClaim` validator is automatically checked by this function since you have initialized the email verification recipe.

### Handle 403 responses on the frontend



If your frontend queries a protected API on your backend and it fails with a 403, you can call the `validateClaims` function. Loop through the errors to know which claim has failed:

```tsx

async function callProtectedRoute() {
    try {
        let response = await axios.get("<API_DOMAIN>/protectedroute");
    } catch (error) {
        // highlight-start
        if (axios.isAxiosError(error) && error.response?.status === 403) {
            let validationErrors = await Session.validateClaims();
            for (let err of validationErrors) {
                if (err.id === EmailVerificationClaim.id) {
                    // email verification claim check failed
                    // We call the sendEmail function defined in the previous section to send the verification email.
                    // await sendEmail();
                } else {
                    // some other claim check failed (from the global validators list)
                }
            }
            // highlight-end

        }
    }
}
```

</Tab>

<Tab value="mobile">



<Tabs>

<Tab value="reactnative">

```tsx

async function checkIfEmailIsVerified() {
    if (await SuperTokens.doesSessionExist()) {

        // highlight-start
        let isVerified: boolean = (await SuperTokens.getAccessTokenPayloadSecurely())["st-ev"].v;

        if (isVerified) {
            // TODO..
        } else {
            // You can trigger the sending of the verification email by calling `<API_DOMAIN><API_BASE_PATH>/user/email/verify/token`
        }
        // highlight-end
    }
}
```

</Tab>

<Tab value="android">

```kotlin
        val isVerified: Boolean = (accessTokenPayload.get("st-ev") as JSONObject).get("v") as Boolean
        if (isVerified) {
            // TODO..
        } else {
            // You can trigger the sending of the verification email by calling `<API_DOMAIN><API_BASE_PATH>/user/email/verify/token`
        }
    }
}
```

</Tab>

<Tab value="ios">

```swift

Future<void> checkIfEmailIsVerified() async {
    var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();

    if (accessTokenPayload.containsKey("st-ev")) {
      Map<String, dynamic> emailVerificationObject = accessTokenPayload["st-ev"];

      if (emailVerificationObject.containsKey("v")) {
        bool isVerified = emailVerificationObject["v"];

        if (isVerified) {
          // Email is verified
        } else {
          // You can trigger the sending of the verification email by calling `<API_DOMAIN><API_BASE_PATH>/user/email/verify/token`
        }
      }
    }
}
```

</Tab>

</Tabs>

### Handle 403 responses on the frontend

If your frontend queries a protected API on your backend and it fails with a 403, you can check the value of the `st-ev` claim in the access token payload.
If it is false you can send the verification email

</Tab>
</Tabs>

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/email-verification/manual-actions" label="Manual actions" />
  <ReferenceCard href="/docs/additional-verification/email-verification/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Backend session validation" />
</ReferenceCard.Grid>

# Additional Verification - Email Verification -  Manual actions
Source: https://supertokens.com/docs/additional-verification/email-verification/manual-actions

## Overview

Although the **SuperTokens** covers the entire email verification process you can also intervene manually in the process.
The following page shows you what SDK methods you can use to adjust the verification flow. 

---

## Generate a link

You can use the backend SDK to generate the email verification link as shown below:

<Tabs>
<Tab value="nodejs">

```tsx

async function createEmailVerificationLink(recipeUserId: supertokens.RecipeUserId, email: string) {
    try {
        // Create an email verification link for the user
        const linkResponse = await EmailVerification.createEmailVerificationLink("public", recipeUserId, email);

        if (linkResponse.status === "OK") {
            console.log(linkResponse.link);
        } else {
            // user's email is already verified
        }
    } catch (err) {
        console.error(err);
    }
}
```

</Tab>
<Tab value="go">

```go

:::

---

## Mark the email as verified

To manually mark an email as verified, you need to first create an email verification token for the user and then use the token to verify the user's email.

<Tabs>
<Tab value="nodejs">

```tsx

async function manuallyVerifyEmail(recipeUserId: supertokens.RecipeUserId) {
    try {
        // Create an email verification token for the user
        const tokenRes = await EmailVerification.createEmailVerificationToken("public", recipeUserId);

        // If the token creation is successful, use the token to verify the user's email
        if (tokenRes.status === "OK") {
            await EmailVerification.verifyEmailUsingToken("public", tokenRes.token);
        }
    } catch (err) {
        console.error(err);
    }
}
```

</Tab>
<Tab value="go">

```go

async function manuallyUnverifyEmail(recipeUserId: supertokens.RecipeUserId) {
    try {
        // Set email verification status to false
        await EmailVerification.unverifyEmail(recipeUserId);
    } catch (err) {
        console.error(err);
    }
}
```

</Tab>
<Tab value="go">

```go

# Additional Verification - Email Verification -  Embed in a page
Source: https://supertokens.com/docs/additional-verification/email-verification/embed-in-page

## Overview

If you are looking to render the email verification UI in a different page follow this guide.

## Before you start

Most of the updates require your attention if you are using the **pre-built UI** components.
If you are working with a **custom UI** you need to update the backend configuration, like in step **3.1**.

## Steps

### 1. Disable the default implementation 

:::note no-title
If you are using a **custom UI** implementation, then you can skip this step.
:::

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailVerification.init({
            mode: "REQUIRED",
            // highlight-start
            disableDefaultUI: true
            // highlight-end
        }),
    ]
});
```

If you navigate to `/auth/verify-email`, you should not see the widget anymore.

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailVerification.init({
            mode: "REQUIRED",
            // highlight-start
            disableDefaultUI: true
            // highlight-end
        }),
    ]
});
```

If you navigate to `/auth/verify-email`, you should not see the widget anymore.

</Tab>
</Tabs>

### 2. Render the component yourself 

:::note no-title
If you are using a **custom UI** implementation, then you can skip this step.
:::

<Tabs>
<Tab value="reactjs">

Add the `EmailVerification` component in your app:

```tsx
// highlight-next-line

class EmailVerificationPage extends React.Component {
    render() {
        return (
            <div>
                // highlight-next-line
                <EmailVerification />
            </div>
        )
    }
}
```
</Tab>

<Tab value="angular">

:::caution
You have to build your own UI instead.
:::

</Tab>
</Tabs>

### 3. Change the website path for the email verification UI {{optional}}

The default path for this is component is `/{websiteBasePath}/verify-email`.

If you are displaying this at some custom path, then you need add additional configuration on the backend and frontend:

#### 3.1 Update the backend configuration

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailVerification.init({
            mode: "OPTIONAL",
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail(input) {
                            return originalImplementation.sendEmail({
                                ...input,
                                emailVerifyLink: input.emailVerifyLink.replace(
                                    // This is: `<WEBSITE_DOMAIN><WEBSITE_BASE_PATH>/verify-email`
                                    "http://localhost:3000/auth/verify-email",
                                    "http://localhost:3000/your/path"
                                    )
                                }
                            )
                        },
                    }
                }
            }
            // highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        EmailVerification.init({
            mode: "REQUIRED",
            //highlight-start

            // The user will be taken to the custom path when they need to get their email verified.
            getRedirectionURL: async (context) => {
                if (context.action === "VERIFY_EMAIL") {
                    return "/custom-email-verification-path";
                };
            }
            //highlight-end
        })
    ]
})
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        supertokensUIEmailVerification.init({
            mode: "REQUIRED",
            //highlight-start

            // The user will be taken to the custom path when they need to get their email verified.
            getRedirectionURL: async (context) => {
                if (context.action === "VERIFY_EMAIL") {
                    return "/custom-email-verification-path";
                };
            }
            //highlight-end
        })
    ]
})
```
</Tab>
</Tabs>

# Additional Verification - Email Verification -  Customize the pre-built UI
Source: https://supertokens.com/docs/additional-verification/email-verification/changing-style

## Overview

Updating the CSS allows you to change the UI of the components to meet your needs.
This section guides you through an example of updating the look of buttons.
Note that you can apply the process to update any HTML tag from within SuperTokens components.

## Before you start

This guide is only relevant if you are using the **pre-built UI** components. If you are using your own UI, you can skip this section.

---

## Global style changes

Each stylable component contains the `data-supertokens` attribute (in this example `data-supertokens="link"`). 
For more information on how to find a specific selector look over the [changing style page](/docs/references/frontend-sdks/prebuilt-ui/changing-style).
Let's add a `border` to the `link` elements. The syntax for styling is plain CSS.

<Tabs>
<Tab value="reactjs">

```tsx preview="/img/emailverification/resend-with-border.png" previewAlt="Prebuilt form with custom submit button"

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailVerification.init({
            // highlight-start
            style: `
                [data-supertokens~=link] {
                    border: 2px solid #0076ff;
                    border-radius: 5;
                    width: 30%;
                    margin: 0 auto;
                }
            `,
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailVerification.init({
            // highlight-start
            style: `
                [data-supertokens~=link] {
                    border: 2px solid #0076ff;
                    border-radius: 5px;
                    width: 30%;
                    margin: 0 auto;
                }
            `,
            // highlight-end
        })
    ]
});
```
</Tab>

</Tabs>

### Change fonts

By default, SuperTokens uses the `Arial` font. The best way to override this is to add a `font-family` styling to the `container` component in the recipe configuration.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailVerification.init({
            // highlight-start
            style: `
                [data-supertokens~=container] {
                    font-family: cursive
                }
            `
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUIEmailVerification.init({
            // highlight-start
            style: `
                [data-supertokens~=container] {
                    font-family: cursive
                }
            `
            // highlight-end
        }),
    ]
});
```
</Tab>
</Tabs>

### Use media queries

You may want to have different CSS for different `viewports`.
You can achieve this via media queries like this:

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // ...
        EmailVerification.init({
            // ...
            style: `
                [data-supertokens~=link] {
                    border: 2px solid #0076ff;
                    borderRadius: 5;
                    width: 30%;
                    margin: 0 auto;
                }

                // highlight-start
                @media (max-width: 440px) {
                    [data-supertokens~=link] {
                        width: 90%;
                    }
                }
                // highlight-end
            `,
        }),
    ],
});
```
</Tab>
<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // ...
        supertokensUIEmailVerification.init({
            // ...
            style: `
                [data-supertokens~=link] {
                    border: 2px solid #0076ff;
                    borderRadius: 5;
                    width: 30%;
                    margin: 0 auto;
                }

                // highlight-start
                @media (max-width: 440px) {
                    [data-supertokens~=link] {
                        width: 90%;
                    }
                }
                // highlight-end
            `,
        }),
    ],
});
```
</Tab>
</Tabs>

## Customize individual screens

### Send email screen

This screen is where the system redirects the user if you set `mode` to `REQUIRED` and they visit a path that requires a verified email.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        EmailVerification.init({
            // highlight-start
            sendVerifyEmailScreen: {
                style: ` ... `
            }
            // highlight-end
        }),
        Session.init()
	]
});
```
</Tab>
<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        supertokensUIEmailVerification.init({
            // highlight-start
            sendVerifyEmailScreen: {
                style: ` ... `
            }
            // highlight-end
        })
	]
});
```
</Tab>
</Tabs>

### Verify link clicked screen

This is the screen shown to users that click the email verification link in the email.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        EmailVerification.init({
            // highlight-start
            verifyEmailLinkClickedScreen: {
                style: ` ... `,
            }
            // highlight-end
        }), 
        Session.init()
	]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        supertokensUIEmailVerification.init({
            // highlight-start
            verifyEmailLinkClickedScreen: {
                style: ` ... `,
            }
            // highlight-end
        })
	]
});
```
</Tab>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/email-verification/manual-actions" label="Manual actions" />
  <ReferenceCard href="/docs/additional-verification/email-verification/protecting-routes" label="Protect routes" />
  <ReferenceCard href="/docs/additional-verification/email-verification/hooks-and-overrides" label="Hooks and overrides" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Backend session validation" />
  <ReferenceCard href="/docs/authentication/passwordless/configure-email-and-sms-behavior" label="Configure email behavior" />
</ReferenceCard.Grid>

# Additional Verification - Email Verification -  Hooks and overrides
Source: https://supertokens.com/docs/additional-verification/email-verification/hooks-and-overrides

**SuperTokens** exposes a set of constructs that allow you to trigger different actions during the authentication lifecycle or to even fully customize the logic based on your use case. 
The following sections describe how you can modify adjust the `emailverification` recipe to your needs.

Explore the [references pages](/docs/references) for a more in depth guide on hooks and overrides.

## Backend override

To perform any task post email verification like analytics, sending a user a welcome email or notifying an internal dashboard, you need to override the `verifyEmailPOST` API.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailVerification.init({
            mode: "REQUIRED",
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        verifyEmailPOST: async function (input) {

                            if (originalImplementation.verifyEmailPOST === undefined) {
                                throw Error("Should never come here");
                            }

                            // First we call the original implementation
                            let response = await originalImplementation.verifyEmailPOST(input);

                            // Then we check if it was successfully completed
                            if (response.status === "OK") {
                                let { recipeUserId, email } = response.user;
                                // TODO: post email verification logic
                            }
                            return response;
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

# Additional Verification - Attack Protection Suite -  Introduction
Source: https://supertokens.com/docs/additional-verification/attack-protection-suite/introduction

## Overview

The **Attack Protection Suite** feature identifies and prevents suspicious activities in authentication sessions.
It leverages detection methods to enhance the security of your application.

:::info Important
This feature is **in beta** and not enabled by default.
Check the [quickstart guide](/docs/additional-verification/attack-protection-suite/initial-setup) for instructions on how to set it up.
:::

The feature processes requests and provides risk assessments. You can use these assessments to enforce additional security measures, such as requiring two-factor authentication for suspicious logins or blocking high-risk attempts altogether.
Check the next diagram for a high-level overview of how the feature's flow works.

<img src="/img/attackprotectionsuite/sequence-diagram.png" alt="Attack Protection Suite flow"/>

### Features

- **Brute Force Attack Detection**: Watches how many times someone tries to do a specific action (such as logging in, resetting password, etc.) within a certain time. If there are too many attempts, it stops them to prevent bad actors from compromising accounts.

- **Password Breach Detection**: Checks passwords against a database of leaked passwords to see if they have leaked before. This helps keep accounts safe by avoiding weak passwords.

- **Impossible Travel Detection**: Identifies fraudulent login attempts by detecting geographically impossible travel between user sessions in a short time.

- **Bot Detection**: Identifies and prevents automated scripts or bots from performing malicious activities such as credential stuffing, account takeover attempts, or scraping sensitive data. It uses advanced algorithms to analyze user behavior, request patterns, and other indicators to distinguish between human users and automated bots.

- **Suspicious IP Detection**: Detects suspicious IP addresses known for malicious activities. This includes detecting the use of VPNs, Tor, proxy servers, or other network configurations that may hide the user's true location or identity.

- **New Device Detection**: Recognizes when a user logs in from a new, previously unseen device. This helps find possible unauthorized logins.

- **Device Count Tracking**: Monitors the number of unique devices associated with a user account. This helps spot unusual account use.

- **Requester Detection**: Recognize and remember devices and requester details, even when they try to disguise themselves. This helps track and identify the same device or requester across multiple login attempts, improving security and user recognition.

## Getting started

To learn how to use the feature in your application open the [quickstart guide](/docs/additional-verification/attack-protection-suite/initial-setup).

:::info
Use the feature only with either the `Email Password` or `Passwordless` authentication recipes.
For social or enterprise login, it is not needed.
:::

# Additional Verification - Attack Protection Suite -  Initial setup
Source: https://supertokens.com/docs/additional-verification/attack-protection-suite/initial-setup

## Overview

The following page shows you how to include the **Attack Protection Suite** feature in your **SuperTokens** integration.

## Before you start

This feature is **in beta**.
To get access to it, please [reach out](mailto:support@supertokens.com) to get it set up for you.
Once you have access to it, you receive:
- **Public API key** - use this on your frontend for generating request IDs
- **Secret API key** - use this on your backend for making requests to the anomaly detection API
- **Environment ID** - use this for identifying the environment you are using both on the backend and the frontend

You can use the feature with either the `Email Password` or the `Passwordless` authentication methods.
For social or enterprise login, it is not needed for multiple reasons:
- **Existing anomaly detection**: Most reputable third-party authentication providers (like Google, Facebook, Apple, etc.) have robust security measures in place, including their own anomaly detection systems. These systems are typically more comprehensive and tailored to their specific platforms.
- **Limited visibility**: When using third-party authentication, you have limited visibility into the authentication process. This makes it difficult to accurately detect anomalies or suspicious activities that occur on the third-party's side.
- **Potential false positives**: Applying anomaly detection to third-party logins might lead to an increase in false positives, as you don't have full context of the user's interactions with the third-party provider.
- **User experience**: Additional security checks on top of third-party authentication could negatively impact the user experience, defeating the purpose of offering third-party login as a convenient option.

## Steps

### 1. Attach request IDs to backend API calls

The **Attack Protection Suite** feature relies on identifying each request through a unique ID.
This way the fingerprinting process can determine if it's a potential threat or not.

:::info Important
This step applies only to bot detection and anomaly IP-based detection such as impossible travel detection.
Also, check for bot detection only on the email password login flows.
:::

#### 1.1 Generate a request ID 

To generate a request ID, import, and initialize the SDK using your public API key.
This SDK generates a unique request ID for each authentication event attempt.

```tsx
const ENVIRONMENT_ID = "<environment-id>"; // Your environment ID that you received from the SuperTokens team
// Initialize the agent on page load using your public API key that you received from the SuperTokens team.
// @ts-expect-error
const supertokensRequestIdPromise = import("https://deviceid.supertokens.io/PqWNQ35Ydhm6WDUK/k9bwGCuvuA83Ad6s?apiKey=<PUBLIC_API_KEY>")
    .then((RequestId: any) => RequestId.load({
        endpoint: [
            'https://deviceid.supertokens.io/PqWNQ35Ydhm6WDUK/CnsdzKsyFKU8Q3h2',
            RequestId.defaultEndpoint
        ]
    }));

async function getRequestId() {
    const sdk = await supertokensRequestIdPromise;
    const result = await sdk.get({
        tag: {
            environmentId: ENVIRONMENT_ID,
        }
    });
    return result.requestId;
}
```

#### 1.2 Pass the request ID to the backend

Include the `requestId` property along with the value as part of the `preAPIHook` body from the initialisation of the recipes.

:::info Important
If the request ID is not passed to the backend, the anomaly detection can only detect password breaches and brute force attacks.
:::

Below is a full example of how to configure the SDK and pass the request ID to the backend.
The request ID generates only for the email password sign in, sign up, and reset password actions because these are the only actions that require bot detection.
For all the other recipes, this is not needed.

```tsx

const ENVIRONMENT_ID = "<environment-id>"; // Your environment ID that you received from the SuperTokens team
// Initialize the agent on page load using your public API key that you received from the SuperTokens team.
// @ts-expect-error
const supertokensRequestIdPromise = import("https://deviceid.supertokens.io/PqWNQ35Ydhm6WDUK/k9bwGCuvuA83Ad6s?apiKey=<PUBLIC_API_KEY>")
    .then((RequestId: any) => RequestId.load({
        endpoint: [
            'https://deviceid.supertokens.io/PqWNQ35Ydhm6WDUK/CnsdzKsyFKU8Q3h2',
            RequestId.defaultEndpoint
        ]
    }));

async function getRequestId() {
    const sdk = await supertokensRequestIdPromise;
    const result = await sdk.get({
        tag: {
            environmentId: ENVIRONMENT_ID,
        }
    });
    return result.requestId;
}

export const SuperTokensConfig = {
    // ... other config options
    appInfo: {
        appName: "...",
        apiDomain: '...',
        websiteDomain: '...',
    },
    // recipeList contains all the modules that you want to
    // use from SuperTokens. See the full list here: https://supertokens.com/docs/guides
    recipeList: [
        EmailPassword.init({
            // highlight-start
            preAPIHook: async (context) => {
                let url = context.url;
                let requestInit = context.requestInit;

                let action = context.action;
                if (action === "EMAIL_PASSWORD_SIGN_IN" || action === "EMAIL_PASSWORD_SIGN_UP" || action === "SEND_RESET_PASSWORD_EMAIL") {
                    let requestId = await getRequestId();
                    let body = context.requestInit.body;
                    if (body !== undefined) {
                        let bodyJson = JSON.parse(body as string);
                        bodyJson.requestId = requestId;
                        requestInit.body = JSON.stringify(bodyJson);
                    }
                }
                return {
                    requestInit, url
                };
            }
            // highlight-end
        }),
    ],
};
```

### 2. Retrieve the request ID

To retrieve the request ID in the backend you have to override the recipe implementations.

#### Email and password

<Tabs>

<Tab value="nodejs">

```tsx

function getIpFromRequest(req: Request): string {
  let headers: { [key: string]: string } = {};
  for (let key of Object.keys(req.headers)) {
    headers[key] = (req as any).headers[key]!;
  }
  return (req as any).headers["x-forwarded-for"] || "127.0.0.1";
}

const getBruteForceConfig = (
  userIdentifier: string,
  ip: string,
  prefix?: string,
) => [
  {
    key: `${prefix ? `${prefix}-` : ""}${userIdentifier}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
  {
    key: `${prefix ? `${prefix}-` : ""}${ip}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
];

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  supertokens: {
    connectionURI: "...",
  },
  recipeList: [
    EmailPassword.init({
      // highlight-start
      override: {
        apis: (originalImplementation) => {
          return {
            ...originalImplementation,
            signUpPOST: async function (input) {
              // We need to generate a request ID in order to detect possible bots, suspicious IP addresses, etc.
              const requestId = (await input.options.req.getJSONBody())
                .requestId;
              if (!requestId) {
                return {
                  status: "GENERAL_ERROR",
                  message: "The request ID is required",
                };
              }

              const actionType = "emailpassword-sign-up";
              const ip = getIpFromRequest(input.options.req.original);
              let email = input.formFields.filter((f) => f.id === "email")[0]
                .value as string;
              let password = input.formFields.filter(
                (f) => f.id === "password",
              )[0].value as string;
              const bruteForceConfig = getBruteForceConfig(
                email,
                ip,
                actionType,
              );
              
              return originalImplementation.signUpPOST!(input);
            },
            signInPOST: async function (input) {
              // We need to generate a request ID in order to detect possible bots, suspicious IP addresses, etc.
              const requestId = (await input.options.req.getJSONBody())
                .requestId;
              if (!requestId) {
                return {
                  status: "GENERAL_ERROR",
                  message: "The request ID is required",
                };
              }

              const actionType = "emailpassword-sign-up";
              const ip = getIpFromRequest(input.options.req.original);
              let email = input.formFields.filter((f) => f.id === "email")[0]
                .value as string;
              let password = input.formFields.filter(
                (f) => f.id === "password",
              )[0].value as string;
              const bruteForceConfig = getBruteForceConfig(
                email,
                ip,
                actionType,
              );

              return originalImplementation.signInPOST!(input);
            },
            generatePasswordResetTokenPOST: async function (input) {
              // We need to generate a request ID in order to detect possible bots, suspicious IP addresses, etc.
              const requestId = (await input.options.req.getJSONBody())
                .requestId;
              if (!requestId) {
                return {
                  status: "GENERAL_ERROR",
                  message: "The request ID is required",
                };
              }

              const actionType = "emailpassword-sign-up";
              const ip = getIpFromRequest(input.options.req.original);
              let email = input.formFields.filter((f) => f.id === "email")[0]
                .value as string;
              let password = input.formFields.filter(
                (f) => f.id === "password",
              )[0].value as string;
              const bruteForceConfig = getBruteForceConfig(
                email,
                ip,
                actionType,
              );

              return originalImplementation.generatePasswordResetTokenPOST!(
                input,
              );
            },
          };
        },
      },
      // highlight-end
    }),
  ],
});

```

</Tab>

<Tab value="go">

```go

		return forwardedFor
	}
	return "127.0.0.1"
}

func getBruteForceConfig(userIdentifier string, ip string, prefix string) []BruteForceConfig {
	var key string
	if prefix != "" {
		key = prefix + "-"
	}

	return []BruteForceConfig{
		{
			Key: key + userIdentifier,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
		{
			Key: key + ip,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
	}
}

func main() {
	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			emailpassword.Init(&epmodels.TypeInput{
				Override: &epmodels.OverrideStruct{
					APIs: func(originalImplementation epmodels.APIInterface) epmodels.APIInterface {
						// rewrite the original implementation of SignUpPOST
						originalSignUpPOST := *originalImplementation.SignUpPOST
						(*originalImplementation.SignUpPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.SignUpPOSTResponse, error) {
							// Generate request ID for bot and suspicious IP detection
							var reqBody ReqBody
							err := json.NewDecoder(options.Req.Body).Decode(&reqBody)
							if err != nil {
								return epmodels.SignUpPOSTResponse{}, err
							}

							if reqBody.RequestID == nil {
								return epmodels.SignUpPOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "The request ID is required",
									},
								}, nil
							}
							requestId := *reqBody.RequestID
              fmt.Println(requestId)

							actionType := "emailpassword-sign-up"
							ip := getIpFromRequest(options.Req)
							email := ""
							password := ""
							for _, field := range formFields {
								if field.ID == "email" || field.ID == "password" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.SignUpPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									if field.ID == "email" {
										email = valueAsString
									} else {
										password = valueAsString
									}
								}
							}
              fmt.Println(password)

							bruteForceConfig := getBruteForceConfig(email, ip, actionType)
              fmt.Println(bruteForceConfig)

							// pre API logic...
							resp, err := originalSignUpPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.SignUpPOSTResponse{}, err
							}

							return resp, nil
						}

						// rewrite the original implementation of SignInPOST
						originalSignInPOST := *originalImplementation.SignInPOST
						(*originalImplementation.SignInPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.SignInPOSTResponse, error) {
							// Generate request ID for bot and suspicious IP detection
							var reqBody ReqBody
							err := json.NewDecoder(options.Req.Body).Decode(&reqBody)
							if err != nil {
								return epmodels.SignInPOSTResponse{}, err
							}

							if reqBody.RequestID == nil {
								return epmodels.SignInPOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "The request ID is required",
									},
								}, nil
							}
							requestId := *reqBody.RequestID
              fmt.Println(requestId)

							actionType := "emailpassword-sign-in"
							ip := getIpFromRequest(options.Req)
							email := ""
							password := ""
							for _, field := range formFields {
								if field.ID == "email" || field.ID == "password" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.SignInPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									if field.ID == "email" {
										email = valueAsString
									} else {
										password = valueAsString
									}
								}
							}
              fmt.Println(password)

							bruteForceConfig := getBruteForceConfig(email, ip, actionType)
              fmt.Println(bruteForceConfig)

							// pre API logic...
							resp, err := originalSignInPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.SignInPOSTResponse{}, err
							}

							return resp, nil
						}

						// rewrite the original implementation of GeneratePasswordResetTokenPOST
						originalGeneratePasswordResetTokenPOST := *originalImplementation.GeneratePasswordResetTokenPOST
						(*originalImplementation.GeneratePasswordResetTokenPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.GeneratePasswordResetTokenPOSTResponse, error) {
							// Generate request ID for bot and suspicious IP detection
							var reqBody ReqBody
							err := json.NewDecoder(options.Req.Body).Decode(&reqBody)
							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}

							if reqBody.RequestID == nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "The request ID is required",
									},
								}, nil
							}
							requestId := *reqBody.RequestID
              fmt.Println(requestId)

							actionType := "send-password-reset-email"
							ip := getIpFromRequest(options.Req)
							email := ""
							for _, field := range formFields {
								if field.ID == "email" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									email = valueAsString
								}
							}

							bruteForceConfig := getBruteForceConfig(email, ip, actionType)
              fmt.Println(bruteForceConfig)

							// pre API logic...
							resp, err := originalGeneratePasswordResetTokenPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}

							return resp, nil
						}

            return originalImplementation
					},
					Functions: func(originalImplementation epmodels.RecipeInterface) epmodels.RecipeInterface {
						return originalImplementation
					},
				},
			}),
		},
	})
}
```

</Tab>

<Tab value="python">

```python
from typing import Dict, Any, Union, List
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.framework import BaseRequest
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.recipe.session import SessionContainer

def get_ip_from_request(req: BaseRequest) -> str:
    forwarded_for = req.get_header("x-forwarded-for")
    if forwarded_for:
        return forwarded_for
    return "127.0.0.1"

def get_brute_force_config(
    user_identifier: Union[str, None], ip: str, prefix: Union[str, None] = None
) -> List[Dict[str, Any]]:
    return [
        {
            "key": f"{prefix}-{user_identifier}" if prefix else user_identifier,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
        {
            "key": f"{prefix}-{ip}" if prefix else ip,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
    ]

# highlight-start
def override_email_password_apis(original_implementation: APIInterface):
    original_sign_up_post = original_implementation.sign_up_post

    async def sign_up_post(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        request_body = await api_options.request.json()
        if not request_body:
            return GeneralErrorResponse(message="The request body is required")

        request_id = request_body.get("requestId")
        if not request_id:
            return GeneralErrorResponse(message="The request ID is required")

        action_type = "emailpassword-sign-in"
        ip = get_ip_from_request(api_options.request)
        email = None
        for field in form_fields:
            if field.id == "email":
                email = field.value
        brute_force_config = get_brute_force_config(email, ip, action_type)
        print(brute_force_config)

        response = await original_sign_up_post(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

        return response

    original_implementation.sign_up_post = sign_up_post

    original_sign_in_post = original_implementation.sign_in_post

    async def sign_in_post(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        request_body = await api_options.request.json()
        if not request_body:
            return GeneralErrorResponse(message="The request body is required")

        request_id = request_body.get("requestId")
        if not request_id:
            return GeneralErrorResponse(message="The request ID is required")

        action_type = "emailpassword-sign-in"
        ip = get_ip_from_request(api_options.request)
        email = None
        for field in form_fields:
            if field.id == "email":
                email = field.value
        brute_force_config = get_brute_force_config(email, ip, action_type)
        print(brute_force_config)

        response = await original_sign_in_post(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

        return response

    original_implementation.sign_in_post = sign_in_post

    original_generate_password_reset_token_post = (
        original_implementation.generate_password_reset_token_post
    )

    async def generate_password_reset_token_post(
        form_fields: List[FormField],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        request_body = await api_options.request.json()
        if not request_body:
            return GeneralErrorResponse(message="The request body is required")

        request_id = request_body.get("requestId")
        if not request_id:
            return GeneralErrorResponse(message="The request ID is required")

        action_type = "send-password-reset-email"
        ip = get_ip_from_request(api_options.request)
        email = None
        for field in form_fields:
            if field.id == "email":
                email = field.value
        brute_force_config = get_brute_force_config(email, ip, action_type)
        print(brute_force_config)

        response = await original_generate_password_reset_token_post(
            form_fields, tenant_id, api_options, user_context
        )

        return response

    original_implementation.generate_password_reset_token_post = (
        generate_password_reset_token_post
    )

    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            # highlight-start
            override=emailpassword.InputOverrideConfig(
                apis=override_email_password_apis
            )
            # highlight-end
        )
    ],
)

```

</Tab>

</Tabs>

#### Passwordless

<Tabs>

<Tab value="nodejs">

```tsx

function getIpFromRequest(req: Request): string {
  let headers: { [key: string]: string } = {};
  for (let key of Object.keys(req.headers)) {
    headers[key] = (req as any).headers[key]!;
  }
  return (req as any).headers["x-forwarded-for"] || "127.0.0.1";
}

const getBruteForceConfig = ( userIdentifier: string,
  ip: string,
  prefix?: string,
) => [
  {
    key: `${prefix ? `${prefix}-` : ""}${userIdentifier}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
  {
    key: `${prefix ? `${prefix}-` : ""}${ip}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
];

SuperTokens.init({
  // @ts-ignore
  framework: "...",
  // @ts-ignore
  appInfo: {
    /*...*/
  },
  recipeList: [
    Passwordless.init({
      // ... other customisations ...
      // highlight-start
      contactMethod: "EMAIL_OR_PHONE",
      flowType: "USER_INPUT_CODE_AND_MAGIC_LINK",
      override: {
        apis: (originalImplementation) => {
          return {
            ...originalImplementation,
            createCodePOST: async function (input) {
              const actionType = "passwordless-send-sms";
              const ip = getIpFromRequest(input.options.req.original);
              const emailOrPhoneNumber =
                "email" in input ? input.email : input.phoneNumber;
              const bruteForceConfig = getBruteForceConfig(
                emailOrPhoneNumber,
                ip,
                actionType,
              );

              return originalImplementation.createCodePOST!(input);
            },
            resendCodePOST: async function (input) {
              const actionType = "passwordless-send-sms";
              const ip = getIpFromRequest(input.options.req.original);
              let codesInfo = await Passwordless.listCodesByPreAuthSessionId({
                tenantId: input.tenantId,
                preAuthSessionId: input.preAuthSessionId,
              });
              const phoneNumber =
                codesInfo && "phoneNumber" in codesInfo
                  ? codesInfo.phoneNumber
                  : undefined;
              const email =
                codesInfo && "email" in codesInfo ? codesInfo.email : undefined;
              const userIdentifier = email || phoneNumber || input.deviceId;

              const bruteForceConfig = getBruteForceConfig(
                userIdentifier,
                ip,
                actionType,
              );

              return originalImplementation.resendCodePOST!(input);
            },
          };
        },
      },
      // highlight-end
    }),
  ],
});

```

</Tab>

<Tab value="go">

```go
		return forwardedFor
	}
	return "127.0.0.1"
}

func getBruteForceConfig(userIdentifier string, ip string, prefix string) []BruteForceConfig {
	var key string
	if prefix != "" {
		key = prefix + "-"
	}

	return []BruteForceConfig{
		{
			Key: key + userIdentifier,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
		{
			Key: key + ip,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
	}
}

func main() {
	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			passwordless.Init(plessmodels.TypeInput{
				FlowType: "USER_INPUT_CODE",
				ContactMethodPhone: plessmodels.ContactMethodPhoneConfig{
					Enabled: true,
				},
				Override: &plessmodels.OverrideStruct{
					APIs: func(originalImplementation plessmodels.APIInterface) plessmodels.APIInterface {
						originalCreateCodePOST := *originalImplementation.CreateCodePOST
						(*originalImplementation.CreateCodePOST) = func(email *string, phoneNumber *string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.CreateCodePOSTResponse, error) {
                            actionType := "passwordless-send-sms"
							ip := getIpFromRequest(options.Req)
							var key string
							if email != nil {
								key = *email
							} else {
								key = *phoneNumber
							}

							bruteForceConfig := getBruteForceConfig(key, ip, actionType)
              fmt.Println(bruteForceConfig)

							return originalCreateCodePOST(email, phoneNumber, tenantId, options, userContext)
						}

						originalResendCodePOST := *originalImplementation.ResendCodePOST
						(*originalImplementation.ResendCodePOST) = func(deviceID string, preAuthSessionID string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.ResendCodePOSTResponse, error) {
							// retreive user details
							codesInfo, err := passwordless.ListCodesByDeviceID(tenantId, deviceID, userContext)
							if err != nil {
								return plessmodels.ResendCodePOSTResponse{}, err
							}
							var email *string
							var phoneNumber *string
							if codesInfo.Email != nil {
								email = codesInfo.Email
							}
							if codesInfo.PhoneNumber != nil {
								phoneNumber = codesInfo.PhoneNumber
							}

							actionType := "passwordless-send-sms"
							ip := getIpFromRequest(options.Req)
							key := ""
							if email != nil {
								key = *email
							} else {
								key = *phoneNumber
							}

							bruteForceConfig := getBruteForceConfig(key, ip, actionType)
              fmt.Println(bruteForceConfig)

							return originalResendCodePOST(deviceID, preAuthSessionID, tenantId, options, userContext)
						}

						return originalImplementation
					},
				},
			}),
		},
	})
}
```

</Tab>

<Tab value="python">

```python
from typing import Dict, Any, Union, List
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import passwordless
from supertokens_python.recipe.passwordless.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.passwordless.asyncio import list_codes_by_device_id
from supertokens_python.framework import BaseRequest
from supertokens_python.recipe.session import SessionContainer

def get_ip_from_request(req: BaseRequest) -> str:
    forwarded_for = req.get_header("x-forwarded-for")
    if forwarded_for:
        return forwarded_for
    return "127.0.0.1"

def get_brute_force_config(
    user_identifier: Union[str, None], ip: str, prefix: Union[str, None] = None
) -> List[Dict[str, Any]]:
    return [
        {
            "key": f"{prefix}-{user_identifier}" if prefix else user_identifier,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
        {
            "key": f"{prefix}-{ip}" if prefix else ip,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
    ]

# highlight-start
def override_passwordless_apis(original_implementation: APIInterface):
    original_create_code_post = original_implementation.create_code_post

    async def create_code_post(
        email: Union[str, None],
        phone_number: Union[str, None],
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        action_type = "passwordless-send-sms"
        ip = get_ip_from_request(api_options.request)
        identifier = None
        if email is not None:
            identifier = email
        elif phone_number is not None:
            identifier = phone_number
        brute_force_config = get_brute_force_config(identifier, ip, action_type)
        print(brute_force_config)

        # We need to call the original implementation of create_code_post.
        response = await original_create_code_post(
            email,
            phone_number,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

        return response

    original_implementation.create_code_post = create_code_post

    original_resend_code_post = original_implementation.resend_code_post

    async def resend_code_post(
        device_id: str,
        pre_auth_session_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        action_type = "passwordless-send-sms"
        ip = get_ip_from_request(api_options.request)
        email = None
        phone_number = None
        codes = await list_codes_by_device_id(
            tenant_id=tenant_id, device_id=device_id, user_context=user_context
        )
        if codes is not None:
            email = codes.email
            phone_number = codes.phone_number
        identifier = None
        if email is not None:
            identifier = email
        elif phone_number is not None:
            identifier = phone_number
        brute_force_config = get_brute_force_config(identifier, ip, action_type)
        print(brute_force_config)

        # We need to call the original implementation of resend_code_post.
        response = await original_resend_code_post(
            device_id,
            pre_auth_session_id,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

        return response

    original_implementation.resend_code_post = resend_code_post

    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            # highlight-start
            flow_type="USER_INPUT_CODE_AND_MAGIC_LINK",
            contact_config=passwordless.ContactEmailOrPhoneConfig(),
            override=passwordless.InputOverrideConfig(apis=override_passwordless_apis),
            # highlight-end
        )
    ],
)

```

</Tab>

</Tabs>

### 3. Call the protection service 

To use the service, send requests to the appropriate regional endpoint based on your location:

- **US Region (N. Virginia)**: `https://security-us-east-1.aws.supertokens.io/v1/security`
- **EU Region (Ireland)**: `https://security-eu-west-1.aws.supertokens.io/v1/security`
- **APAC Region (Singapore)**: `https://security-ap-southeast-1.aws.SuperTokens.io/v1/security`

<HTTPRequestCard path="/v1/security" method="post" title="Attack Protection Suite">
  <HTTPRequestCard.ShellExample showTenatSelection={false}>

```bash
curl --location --request POST 'https://security-us-east-1.aws.supertokens.io/v1/security' \
     --header 'Authorization: Bearer <secret-api-key>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
    "email": "user@email.com",
    "phoneNumber": "+1234567890",
    "passwordHash": "9cf95dacd226dcf43da376cdb6cbba7035218920",
    "requestId": "some-request-id",
    "actionType": "emailpassword-sign-in",
    "bruteForce": [
        {
            "key": "some-key",
            "maxRequests": [
                {
                    "limit": 1,
                    "perTimeIntervalMS": 1000
                }
            ]
        }
    ]
}'
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample showTenatSelection={false}>

```tsx
const REGION = "us-east-1"; // or "eu-west-1" or "ap-southeast-1"
const SECRET_API_KEY = "<secret-api-key>";

const url = `https://security-${REGION}.aws.supertokens.io/v1/security`;
const payload = {
  email: "user@email.com",
  phoneNumber: "+1234567890",
  passwordHashPrefix: "9cf95dacd226dcf43da376cdb6cbba7035218920",
  requestId: "some-request-id",
  actionType: "emailpassword-sign-in",
  bruteForce: [
    {
      key: "some-key",
      maxRequests: [
        {
          limit: 1,
          perTimeIntervalMS: 1000,
        },
      ],
    },
  ],
};

fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + SECRET_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload)
})
    .then(response => response.json())
    .then(json => console.log(json))
    .catch(err => console.error(err));
```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.PythonExample showTenatSelection={false}>

```python

const SECRET_API_KEY = "<secret-api-key>"; // Your secret API key that you received from the SuperTokens team
// The full URL with the correct region will be provided by the SuperTokens team
const ANOMALY_DETECTION_API_URL =
  "https://security-<region>.aws.supertokens.io/v1/security";

async function handleSecurityChecks(input: {
  actionType?: string;
  email?: string;
  phoneNumber?: string;
  password?: string;
  requestId?: string;
  bruteForceConfig?: {
    key: string;
    maxRequests: {
      limit: number;
      perTimeIntervalMS: number;
    }[];
  }[];
}): Promise<
  | {
      status: "GENERAL_ERROR";
      message: string;
    }
  | undefined
> {
  let requestBody: {
    email?: string;
    phoneNumber?: string;
    actionType?: string;
    requestId?: string;
    passwordHashPrefix?: string;
    bruteForce?: {
      key: string;
      maxRequests: {
        limit: number;
        perTimeIntervalMS: number;
      }[];
    }[];
  } = {};

  if (input.requestId !== undefined) {
    requestBody.requestId = input.requestId;
  }

  let passwordHash: string | undefined;
  if (input.password !== undefined) {
    let shasum = createHash("sha1");
    shasum.update(input.password);
    passwordHash = shasum.digest("hex");
    requestBody.passwordHashPrefix = passwordHash.slice(0, 5);
  }
  requestBody.bruteForce = input.bruteForceConfig;
  requestBody.email = input.email;
  requestBody.phoneNumber = input.phoneNumber;
  requestBody.actionType = input.actionType;

  let response;
  try {
    response = await axios.post(ANOMALY_DETECTION_API_URL, requestBody, {
      headers: {
        Authorization: `Bearer ${SECRET_API_KEY}`,
        "Content-Type": "application/json",
      },
    });
  } catch (err) {
    // silently fail in order to not break the auth flow
    console.error(err);
    return;
  }

  let responseData = response.data;

  if (responseData.bruteForce.detected) {
    return {
      status: "GENERAL_ERROR",
      message: "Too many requests. Please try again later.",
    };
  }

  if (responseData.requestIdInfo?.isUsingTor) {
    return {
      status: "GENERAL_ERROR",
      message: "Tor activity detected. Please use a regular browser.",
    };
  }

  if (responseData.requestIdInfo?.vpn?.result) {
    return {
      status: "GENERAL_ERROR",
      message: "VPN activity detected. Please use a regular network.",
    };
  }

  if (responseData.requestIdInfo?.botDetected) {
    return {
      status: "GENERAL_ERROR",
      message: "Bot activity detected.",
    };
  }

  if (responseData?.passwordBreaches && passwordHash) {
    const suffix = passwordHash.slice(5).toUpperCase();
    const foundPasswordHash = responseData?.passwordBreaches[suffix];

    if (foundPasswordHash) {
      return {
        status: "GENERAL_ERROR",
        message:
          "This password has been detected in a breach. Please set a different password.",
      };
    }
  }

  return undefined;
}

function getIpFromRequest(req: Request): string {
  let headers: { [key: string]: string } = {};
  for (let key of Object.keys(req.headers)) {
    headers[key] = (req as any).headers[key]!;
  }
  return (req as any).headers["x-forwarded-for"] || "127.0.0.1";
}

const getBruteForceConfig = (
  userIdentifier: string,
  ip: string,
  prefix?: string,
) => [
  {
    key: `${prefix ? `${prefix}-` : ""}${userIdentifier}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
  {
    key: `${prefix ? `${prefix}-` : ""}${ip}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
];

// backend
SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  supertokens: {
    connectionURI: "...",
  },
  recipeList: [
    EmailPassword.init({
      // highlight-start
      override: {
        apis: (originalImplementation) => {
          return {
            ...originalImplementation,
            signUpPOST: async function (input) {
              // We need to generate a request ID in order to detect possible bots, suspicious IP addresses, etc.
              const requestId = (await input.options.req.getJSONBody())
                .requestId;
              if (!requestId) {
                return {
                  status: "GENERAL_ERROR",
                  message: "The request ID is required",
                };
              }

              const actionType = "emailpassword-sign-up";
              const ip = getIpFromRequest(input.options.req.original);
              let email = input.formFields.filter((f) => f.id === "email")[0]
                .value as string;
              let password = input.formFields.filter(
                (f) => f.id === "password",
              )[0].value as string;
              const bruteForceConfig = getBruteForceConfig(
                email,
                ip,
                actionType,
              );

              // we check the anomaly detection service before calling the original implementation of signUp
              let securityCheckResponse = await handleSecurityChecks({
                requestId,
                email,
                password,
                bruteForceConfig,
                actionType,
              });
              if (securityCheckResponse !== undefined) {
                return securityCheckResponse;
              }

              return originalImplementation.signUpPOST!(input);
            },
            signInPOST: async function (input) {
              // We need to generate a request ID in order to detect possible bots, suspicious IP addresses, etc.
              const requestId = (await input.options.req.getJSONBody())
                .requestId;
              if (!requestId) {
                return {
                  status: "GENERAL_ERROR",
                  message: "The request ID is required",
                };
              }

              const actionType = "emailpassword-sign-in";
              const ip = getIpFromRequest(input.options.req.original);
              let email = input.formFields.filter((f) => f.id === "email")[0]
                .value as string;
              const bruteForceConfig = getBruteForceConfig(
                email,
                ip,
                actionType,
              );

              // we check the anomaly detection service before calling the original implementation of signIn
              let securityCheckResponse = await handleSecurityChecks({
                requestId,
                email,
                bruteForceConfig,
                actionType,
              });
              if (securityCheckResponse !== undefined) {
                return securityCheckResponse;
              }

              return originalImplementation.signInPOST!(input);
            },
            generatePasswordResetTokenPOST: async function (input) {
              // We need to generate a request ID in order to detect possible bots, suspicious IP addresses, etc.
              const requestId = (await input.options.req.getJSONBody())
                .requestId;
              if (!requestId) {
                return {
                  status: "GENERAL_ERROR",
                  message: "The request ID is required",
                };
              }

              const actionType = "send-password-reset-email";
              const ip = getIpFromRequest(input.options.req.original);
              let email = input.formFields.filter((f) => f.id === "email")[0]
                .value as string;
              const bruteForceConfig = getBruteForceConfig(
                email,
                ip,
                actionType,
              );

              // we check the anomaly detection service before calling the original implementation of generatePasswordResetToken
              let securityCheckResponse = await handleSecurityChecks({
                requestId,
                email,
                bruteForceConfig,
                actionType,
              });
              if (securityCheckResponse !== undefined) {
                return securityCheckResponse;
              }

              return originalImplementation.generatePasswordResetTokenPOST!(
                input,
              );
            },
            passwordResetPOST: async function (input) {
              let password = input.formFields.filter(
                (f) => f.id === "password",
              )[0].value as string;
              let securityCheckResponse = await handleSecurityChecks({
                password,
              });
              if (securityCheckResponse !== undefined) {
                return securityCheckResponse;
              }
              return originalImplementation.passwordResetPOST!(input);
            },
          };
        },
      },
      // highlight-end
    }),
  ],
});

```

The above code overrides the SuperTokens APIs and adding custom logic for anomaly detection. The steps when overriding the APIs are as follows:
- We get the request ID from the request body. This is a unique ID for the request.
- Define the action type based on the API you call.
- We get the email and password from the form fields.
- We get the IP address from the request.
- We create the brute force configuration from the email, IP address, and action type. This configuration allows a number of requests over a time interval per:
    1. Action and email/phone number.
    2. Action and IP address.
- We call the anomaly detection service to check if the request is permissible.
- If the request is not allowed, it returns a descriptive error response.
- If the request is permissible, it calls the original implementation of the API.
- We return the response from the original implementation of the API.

</Tab>

<Tab value="go">

```go

// The full URL with the correct region will be provided by the SuperTokens team
const ANOMALY_DETECTION_API_URL = "https://security-<region>.aws.supertokens.io/v1/security"

type SecurityCheckInput struct {
	ActionType       string             `json:"actionType,omitempty"`
	Email            string             `json:"email,omitempty"`
	PhoneNumber      string             `json:"phoneNumber,omitempty"`
	Password         string             `json:"password,omitempty"`
	RequestID        string             `json:"requestId,omitempty"`
	BruteForceConfig []BruteForceConfig `json:"bruteForceConfig,omitempty"`
}

type BruteForceConfig struct {
	Key         string        `json:"key"`
	MaxRequests []MaxRequests `json:"maxRequests"`
}

type MaxRequests struct {
	Limit             int `json:"limit"`
	PerTimeIntervalMS int `json:"perTimeIntervalMS"`
}

type ReqBody struct {
	RequestID *string `json:"requestId"`
}

func getIpFromRequest(req *http.Request) string {
	if forwardedFor := req.Header.Get("X-Forwarded-For"); forwardedFor != "" {
		return forwardedFor
	}
	return "127.0.0.1"
}

func getBruteForceConfig(userIdentifier string, ip string, prefix string) []BruteForceConfig {
	var key string
	if prefix != "" {
		key = prefix + "-"
	}

	return []BruteForceConfig{
		{
			Key: key + userIdentifier,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
		{
			Key: key + ip,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
	}
}

func handleSecurityChecks(input SecurityCheckInput) (*supertokens.GeneralErrorResponse, error) {
	requestBody := make(map[string]interface{})

	if input.RequestID != "" {
		requestBody["requestId"] = input.RequestID
	}

    var passwordHash string
	if input.Password != "" {
		hash := sha1.New()
		hash.Write([]byte(input.Password))
		passwordHash = hex.EncodeToString(hash.Sum(nil))
		requestBody["passwordHashPrefix"] = passwordHash[:5]
	}

	requestBody["bruteForce"] = input.BruteForceConfig
	requestBody["email"] = input.Email
	requestBody["phoneNumber"] = input.PhoneNumber
	requestBody["actionType"] = input.ActionType

	jsonBody, err := json.Marshal(requestBody)
	if err != nil {
		return nil, err
	}

	req, err := http.NewRequest("POST", ANOMALY_DETECTION_API_URL, bytes.NewBuffer(jsonBody))
	if err != nil {
		// silently fail in order to not break the auth flow
		return nil, nil
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+SECRET_API_KEY)

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	var responseData map[string]interface{}
	err = json.NewDecoder(resp.Body).Decode(&responseData)
	if err != nil {
		return nil, err
	}

	if bruteForce, ok := responseData["bruteForce"].(map[string]interface{}); ok {
		if detected, ok := bruteForce["detected"].(bool); ok && detected {
			return &supertokens.GeneralErrorResponse{
				Message: "Too many requests. Please try again later.",
			}, nil
		}
	}

	if requestIdInfo, ok := responseData["requestIdInfo"].(map[string]interface{}); ok {
		if isUsingTor, ok := requestIdInfo["isUsingTor"].(bool); ok && isUsingTor {
			return &supertokens.GeneralErrorResponse{
				Message: "Tor activity detected. Please use a regular browser.",
			}, nil
		}

		if vpn, ok := requestIdInfo["vpn"].(map[string]interface{}); ok {
			if result, ok := vpn["result"].(bool); ok && result {
				return &supertokens.GeneralErrorResponse{
					Message: "VPN activity detected. Please use a regular network.",
				}, nil
			}
		}

		if botDetected, ok := requestIdInfo["botDetected"].(bool); ok && botDetected {
			return &supertokens.GeneralErrorResponse{
				Message: "Bot activity detected.",
			}, nil
		}
	}

	if passwordBreaches, ok := responseData["passwordBreaches"].(map[string]interface{}); ok {
        passwordHashSuffix := passwordHash[5:]
		if _, ok := passwordBreaches[passwordHashSuffix]; ok {
			return &supertokens.GeneralErrorResponse{
				Message: "This password has been detected in a breach. Please set a different password.",
			}, nil
		}
	}

	return nil, nil
}

func main() {
	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			emailpassword.Init(&epmodels.TypeInput{
				Override: &epmodels.OverrideStruct{
					APIs: func(originalImplementation epmodels.APIInterface) epmodels.APIInterface {
						// rewrite the original implementation of SignUpPOST
						originalSignUpPOST := *originalImplementation.SignUpPOST
						(*originalImplementation.SignUpPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.SignUpPOSTResponse, error) {
							// Generate request ID for bot and suspicious IP detection
							var reqBody ReqBody
							err := json.NewDecoder(options.Req.Body).Decode(&reqBody)
							if err != nil {
								return epmodels.SignUpPOSTResponse{}, err
							}

							if reqBody.RequestID == nil {
								return epmodels.SignUpPOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "The request ID is required",
									},
								}, nil
							}
							requestId := *reqBody.RequestID

							actionType := "emailpassword-sign-up"
							ip := getIpFromRequest(options.Req)
							email := ""
							password := ""
							for _, field := range formFields {
								if field.ID == "email" || field.ID == "password" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.SignUpPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									if field.ID == "email" {
										email = valueAsString
									} else {
										password = valueAsString
									}
								}
							}
							bruteForceConfig := getBruteForceConfig(email, ip, actionType)

							// Check anomaly detection service before proceeding
							checkErr, err := handleSecurityChecks(
								SecurityCheckInput{
									ActionType:       actionType,
									Email:            email,
									RequestID:        requestId,
									BruteForceConfig: bruteForceConfig,
									Password:         password,
								},
							)
							if err != nil {
								return epmodels.SignUpPOSTResponse{}, err
							}

							if checkErr != nil {
								return epmodels.SignUpPOSTResponse{
									GeneralError: checkErr,
								}, nil
							}

							// pre API logic...
							resp, err := originalSignUpPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.SignUpPOSTResponse{}, err
							}

							return resp, nil
						}

						// rewrite the original implementation of SignInPOST
						originalSignInPOST := *originalImplementation.SignInPOST
						(*originalImplementation.SignInPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.SignInPOSTResponse, error) {
							// Generate request ID for bot and suspicious IP detection
							var reqBody ReqBody
							err := json.NewDecoder(options.Req.Body).Decode(&reqBody)
							if err != nil {
								return epmodels.SignInPOSTResponse{}, err
							}

							if reqBody.RequestID == nil {
								return epmodels.SignInPOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "The request ID is required",
									},
								}, nil
							}
							requestId := *reqBody.RequestID

							actionType := "emailpassword-sign-in"
							ip := getIpFromRequest(options.Req)
							email := ""
							password := ""
							for _, field := range formFields {
								if field.ID == "email" || field.ID == "password" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.SignInPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									if field.ID == "email" {
										email = valueAsString
									} else {
										password = valueAsString
									}
								}
							}
							bruteForceConfig := getBruteForceConfig(email, ip, actionType)

							// Check anomaly detection service before proceeding
							checkErr, err := handleSecurityChecks(
								SecurityCheckInput{
									ActionType:       actionType,
									Email:            email,
									RequestID:        requestId,
									BruteForceConfig: bruteForceConfig,
									Password:         password,
								},
							)
							if err != nil {
								return epmodels.SignInPOSTResponse{}, err
							}

							if checkErr != nil {
								return epmodels.SignInPOSTResponse{
									GeneralError: checkErr,
								}, nil
							}

							// pre API logic...
							resp, err := originalSignInPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.SignInPOSTResponse{}, err
							}

							return resp, nil
						}

						// rewrite the original implementation of GeneratePasswordResetTokenPOST
						originalGeneratePasswordResetTokenPOST := *originalImplementation.GeneratePasswordResetTokenPOST
						(*originalImplementation.GeneratePasswordResetTokenPOST) = func(formFields []epmodels.TypeFormField, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.GeneratePasswordResetTokenPOSTResponse, error) {
							// Generate request ID for bot and suspicious IP detection
							var reqBody ReqBody
							err := json.NewDecoder(options.Req.Body).Decode(&reqBody)
							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}

							if reqBody.RequestID == nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{
									GeneralError: &supertokens.GeneralErrorResponse{
										Message: "The request ID is required",
									},
								}, nil
							}
							requestId := *reqBody.RequestID

							actionType := "send-password-reset-email"
							ip := getIpFromRequest(options.Req)
							email := ""
							for _, field := range formFields {
								if field.ID == "email" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									email = valueAsString
								}
							}
							bruteForceConfig := getBruteForceConfig(email, ip, actionType)

							// Check anomaly detection service before proceeding
							checkErr, err := handleSecurityChecks(
								SecurityCheckInput{
									ActionType:       actionType,
									Email:            email,
									RequestID:        requestId,
									BruteForceConfig: bruteForceConfig,
								},
							)
							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}

							if checkErr != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{
									GeneralError: checkErr,
								}, nil
							}

							// pre API logic...
							resp, err := originalGeneratePasswordResetTokenPOST(formFields, tenantId, options, userContext)
							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}

							return resp, nil
						}

                        // rewrite the original implementation of PasswordResetPOST
						originalPasswordResetPOST := *originalImplementation.PasswordResetPOST
						(*originalImplementation.PasswordResetPOST) = func(formFields []epmodels.TypeFormField, token string, tenantId string, options epmodels.APIOptions, userContext supertokens.UserContext) (epmodels.ResetPasswordPOSTResponse, error) {
							password := ""
							for _, field := range formFields {
								if field.ID == "password" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.ResetPasswordPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									password = valueAsString
								}
							}

							// Check anomaly detection service before proceeding
							checkErr, err := handleSecurityChecks(
								SecurityCheckInput{
									Password: password,
								},
							)
							if err != nil {
								return epmodels.ResetPasswordPOSTResponse{}, err
							}

							if checkErr != nil {
								return epmodels.ResetPasswordPOSTResponse{
									GeneralError: checkErr,
								}, nil
							}

							// First we call the original implementation
							resp, err := originalPasswordResetPOST(formFields, token, tenantId, options, userContext)

							if err != nil {
								return epmodels.ResetPasswordPOSTResponse{}, err
							}

							return resp, nil
						}

						return originalImplementation
					},
					Functions: func(originalImplementation epmodels.RecipeInterface) epmodels.RecipeInterface {
						return originalImplementation
					},
				},
			}),
		},
	})
}
```

The above code overrides the SuperTokens APIs and adding custom logic for anomaly detection. The steps when overriding the APIs are as follows:
- We get the request ID from the request body. This is a unique ID for the request.
- Define the action type based on the API you call.
- We get the email and password from the form fields.
- We get the IP address from the request.
- We create the brute force configuration from the email, IP address, and action type. This configuration allows a number of requests over a time interval per:
    1. Action and email/phone number.
    2. Action and IP address.
- We call the anomaly detection service to check if the request is permissible.
- If the request is not allowed, it returns a descriptive error response.
- If the request is permissible, it calls the original implementation of the API.
- We return the response from the original implementation of the API.

</Tab>

<Tab value="python">

```python
from httpx import AsyncClient
from hashlib import sha1
from typing import Dict, Any, Union, List
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.framework import BaseRequest
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.recipe.session import SessionContainer

SECRET_API_KEY = "<secret-api-key>"
# Your secret API key that you received from the SuperTokens team
# The full URL with the correct region will be provided by the SuperTokens team
ANOMALY_DETECTION_API_URL = "https://security-<region>.aws.supertokens.io/v1/security"

async def handle_security_checks(
    request_id: Union[str, None],
    password: Union[str, None],
    brute_force_config: Union[List[Dict[str, Any]], None],
    email: Union[str, None],
    phone_number: Union[str, None],
    action_type: Union[str, None],
) -> Union[GeneralErrorResponse, None]:
    request_body: Dict[str, Any] = {}

    if request_id is not None:
        request_body["requestId"] = request_id

    password_hash = None
    if password is not None:
        password_hash = sha1(password.encode()).hexdigest()
        request_body["passwordHashPrefix"] = password_hash[:5]

    request_body["bruteForce"] = brute_force_config
    request_body["email"] = email
    request_body["phoneNumber"] = phone_number
    request_body["actionType"] = action_type

    try:
        async with AsyncClient(timeout=10.0) as client:
            response = await client.post(
                ANOMALY_DETECTION_API_URL,
                json=request_body,
                headers={
                    "Authorization": f"Bearer {SECRET_API_KEY}",
                    "Content-Type": "application/json",
                },
            )  # type: ignore
            response_data = response.json()
    except:
        # silently fail in order to not break the auth flow
        return None

    if response_data.get("bruteForce", {}).get("detected"):
        return GeneralErrorResponse(
            message="Too many requests. Please try again later."
        )

    if response_data.get("requestIdInfo", {}).get("isUsingTor"):
        return GeneralErrorResponse(
            message="Tor activity detected. Please use a regular browser."
        )

    if response_data.get("requestIdInfo", {}).get("vpn", {}).get("result"):
        return GeneralErrorResponse(
            message="VPN activity detected. Please use a regular network."
        )

    if response_data.get("requestIdInfo", {}).get("botDetected"):
        return GeneralErrorResponse(message="Bot activity detected.")

    if response_data.get("passwordBreaches") and password_hash is not None:
        password_hash_suffix = password_hash[5:]
        if password_hash_suffix in response_data["passwordBreaches"]:
            return GeneralErrorResponse(
                message="This password has been detected in a breach. Please set a different password."
            )

    return None

def get_ip_from_request(req: BaseRequest) -> str:
    forwarded_for = req.get_header("x-forwarded-for")
    if forwarded_for:
        return forwarded_for
    return "127.0.0.1"

def get_brute_force_config(
    user_identifier: Union[str, None], ip: str, prefix: Union[str, None] = None
) -> List[Dict[str, Any]]:
    return [
        {
            "key": f"{prefix}-{user_identifier}" if prefix else user_identifier,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
        {
            "key": f"{prefix}-{ip}" if prefix else ip,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
    ]

# highlight-start
def override_email_password_apis(original_implementation: APIInterface):
    original_sign_up_post = original_implementation.sign_up_post

    async def sign_up_post(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        request_body = await api_options.request.json()
        if not request_body:
            return GeneralErrorResponse(message="The request body is required")

        request_id = request_body.get("requestId")
        if not request_id:
            return GeneralErrorResponse(message="The request ID is required")

        action_type = "emailpassword-sign-in"
        ip = get_ip_from_request(api_options.request)
        email = None
        password = None
        for field in form_fields:
            if field.id == "email":
                email = field.value
            if field.id == "password":
                password = field.value
        brute_force_config = get_brute_force_config(email, ip, action_type)

        # we check the anomaly detection service before calling the original implementation of signUp
        security_check_response = await handle_security_checks(
            request_id=request_id,
            password=password,
            brute_force_config=brute_force_config,
            email=email,
            phone_number=None,
            action_type=action_type,
        )
        if security_check_response is not None:
            return security_check_response

        # We need to call the original implementation of sign_up_post.
        response = await original_sign_up_post(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

        return response

    original_implementation.sign_up_post = sign_up_post

    original_sign_in_post = original_implementation.sign_in_post

    async def sign_in_post(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        request_body = await api_options.request.json()
        if not request_body:
            return GeneralErrorResponse(message="The request body is required")

        request_id = request_body.get("requestId")
        if not request_id:
            return GeneralErrorResponse(message="The request ID is required")

        action_type = "emailpassword-sign-in"
        ip = get_ip_from_request(api_options.request)
        email = None
        for field in form_fields:
            if field.id == "email":
                email = field.value
        brute_force_config = get_brute_force_config(email, ip, action_type)

        # we check the anomaly detection service before calling the original implementation of sign_in_post
        security_check_response = await handle_security_checks(
            request_id=request_id,
            password=None,
            brute_force_config=brute_force_config,
            email=email,
            phone_number=None,
            action_type=action_type,
        )
        if security_check_response is not None:
            return security_check_response

        # We need to call the original implementation of sign_in_post.
        response = await original_sign_in_post(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

        return response

    original_implementation.sign_in_post = sign_in_post

    original_generate_password_reset_token_post = (
        original_implementation.generate_password_reset_token_post
    )

    async def generate_password_reset_token_post(
        form_fields: List[FormField],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        request_body = await api_options.request.json()
        if not request_body:
            return GeneralErrorResponse(message="The request body is required")

        request_id = request_body.get("requestId")
        if not request_id:
            return GeneralErrorResponse(message="The request ID is required")

        action_type = "send-password-reset-email"
        ip = get_ip_from_request(api_options.request)
        email = None
        for field in form_fields:
            if field.id == "email":
                email = field.value
        brute_force_config = get_brute_force_config(email, ip, action_type)

        # we check the anomaly detection service before calling the original implementation of generate_password_reset_token_post
        security_check_response = await handle_security_checks(
            request_id=request_id,
            password=None,
            brute_force_config=brute_force_config,
            email=email,
            phone_number=None,
            action_type=action_type,
        )
        if security_check_response is not None:
            return security_check_response

        # We need to call the original implementation of generate_password_reset_token_post.
        response = await original_generate_password_reset_token_post(
            form_fields, tenant_id, api_options, user_context
        )

        return response

    original_implementation.generate_password_reset_token_post = (
        generate_password_reset_token_post
    )

    original_password_reset_post = original_implementation.password_reset_post

    async def password_reset_post(
        form_fields: List[FormField],
        token: str,
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        password = None
        for field in form_fields:
            if field.id == "password":
                password = field.value

        # we check the anomaly detection service before calling the original implementation of password_reset_post
        security_check_response = await handle_security_checks(
            request_id=None,
            password=password,
            brute_force_config=None,
            email=None,
            phone_number=None,
            action_type=None,
        )
        if security_check_response is not None:
            return security_check_response

        response = await original_password_reset_post(
            form_fields, token, tenant_id, api_options, user_context
        )

        return response

    original_implementation.password_reset_post = password_reset_post

    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            # highlight-start
            override=emailpassword.InputOverrideConfig(
                apis=override_email_password_apis
            )
            # highlight-end
        )
    ],
)

```

The above code overrides the SuperTokens APIs and adding custom logic for anomaly detection. The steps when overriding the APIs are as follows:
- We get the request ID from the request body. This is a unique ID for the request.
- Define the action type based on the API you call.
- We get the email and password from the form fields.
- We get the IP address from the request.
- We create the brute force configuration from the email, IP address, and action type. This configuration allows a number of requests over a time interval per:
    1. Action and email/phone number.
    2. Action and IP address.
- We call the anomaly detection service to check if the request is permissible.
- If the request is not allowed, it returns a descriptive error response.
- If the request is permissible, it calls the original implementation of the API.
- We return the response from the original implementation of the API.

</Tab>

</Tabs>

### Passwordless

<Tabs>

<Tab value="nodejs">

```tsx

const SECRET_API_KEY = "<secret-api-key>"; // Your secret API key that you received from the SuperTokens team
const ANOMALY_DETECTION_API_URL =
  "https://security-us-east-1.aws.supertokens.io/v1/security";

async function handleSecurityChecks(input: {
  actionType?: string;
  email?: string;
  phoneNumber?: string;
  bruteForceConfig?: {
    key: string;
    maxRequests: {
      limit: number;
      perTimeIntervalMS: number;
    }[];
  }[];
}): Promise<
  | {
      status: "GENERAL_ERROR";
      message: string;
    }
  | undefined
> {
  let requestBody: {
    email?: string;
    phoneNumber?: string;
    actionType?: string;
    bruteForce?: {
      key: string;
      maxRequests: {
        limit: number;
        perTimeIntervalMS: number;
      }[];
    }[];
  } = {};

  requestBody.bruteForce = input.bruteForceConfig;
  requestBody.email = input.email;
  requestBody.phoneNumber = input.phoneNumber;
  requestBody.actionType = input.actionType;

  let response;
  try {
    response = await axios.post(ANOMALY_DETECTION_API_URL, requestBody, {
      headers: {
        Authorization: `Bearer ${SECRET_API_KEY}`,
        "Content-Type": "application/json",
      },
    });
  } catch (err) {
    // silently fail in order to not break the auth flow
    console.error(err);
    return;
  }
  let responseData = response.data;

  if (responseData.bruteForce.detected) {
    return {
      status: "GENERAL_ERROR",
      message: "Too many requests. Please try again later.",
    };
  }

  return undefined;
}

function getIpFromRequest(req: Request): string {
  let headers: { [key: string]: string } = {};
  for (let key of Object.keys(req.headers)) {
    headers[key] = (req as any).headers[key]!;
  }
  return (req as any).headers["x-forwarded-for"] || "127.0.0.1";
}

const getBruteForceConfig = (
  userIdentifier: string,
  ip: string,
  prefix?: string,
) => [
  {
    key: `${prefix ? `${prefix}-` : ""}${userIdentifier}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
  {
    key: `${prefix ? `${prefix}-` : ""}${ip}`,
    maxRequests: [
      { limit: 5, perTimeIntervalMS: 60 * 1000 },
      { limit: 15, perTimeIntervalMS: 60 * 60 * 1000 },
    ],
  },
];

SuperTokens.init({
  // @ts-ignore
  framework: "...",
  // @ts-ignore
  appInfo: {
    /*...*/
  },
  recipeList: [
    Passwordless.init({
      // ... other customisations ...
      // highlight-start
      contactMethod: "EMAIL_OR_PHONE",
      flowType: "USER_INPUT_CODE_AND_MAGIC_LINK",
      override: {
        apis: (originalImplementation) => {
          return {
            ...originalImplementation,
            createCodePOST: async function (input) {
              const actionType = "passwordless-send-sms";
              const ip = getIpFromRequest(input.options.req.original);
              const emailOrPhoneNumber =
                "email" in input ? input.email : input.phoneNumber;
              const bruteForceConfig = getBruteForceConfig(
                emailOrPhoneNumber,
                ip,
                actionType,
              );

              // we check the anomaly detection service before calling the original implementation of createCodePOST
              let securityCheckResponse = await handleSecurityChecks({
                bruteForceConfig,
                actionType,
              });
              if (securityCheckResponse !== undefined) {
                return securityCheckResponse;
              }

              return originalImplementation.createCodePOST!(input);
            },
            resendCodePOST: async function (input) {
              const actionType = "passwordless-send-sms";
              const ip = getIpFromRequest(input.options.req.original);
              let codesInfo = await Passwordless.listCodesByPreAuthSessionId({
                tenantId: input.tenantId,
                preAuthSessionId: input.preAuthSessionId,
              });
              const phoneNumber =
                codesInfo && "phoneNumber" in codesInfo
                  ? codesInfo.phoneNumber
                  : undefined;
              const email =
                codesInfo && "email" in codesInfo ? codesInfo.email : undefined;
              const userIdentifier = email || phoneNumber || input.deviceId;

              const bruteForceConfig = getBruteForceConfig(
                userIdentifier,
                ip,
                actionType,
              );

              // we check the anomaly detection service before calling the original implementation of resendCodePOST
              let securityCheckResponse = await handleSecurityChecks({
                phoneNumber,
                email,
                bruteForceConfig,
                actionType,
              });
              if (securityCheckResponse !== undefined) {
                return securityCheckResponse;
              }

              return originalImplementation.resendCodePOST!(input);
            },
          };
        },
      },
      // highlight-end
    }),
  ],
});

```

The above code overrides the SuperTokens APIs and adding custom logic for anomaly detection. The steps when overriding the APIs are as follows:
- Define the action type based on the API you call.
- We get the email or the phone number from the form fields.
- We get the IP address from the request.
- We create the brute force configuration from the email, IP address, and action type. This configuration allows a number of requests over a time interval per:
    1. Action and email/phone number.
    2. Action and IP address.
- The anomaly detection service checks if the request passes the allowed criteria (only brute force detection occurs here).
- If the request is not allowed, the system returns a descriptive error response.
- If the request passes the allowed criteria, the original implementation of the API executes.
- We return the response from the original implementation of the API.

</Tab>

<Tab value="go">

```go
// The full URL with the correct region will be provided by the SuperTokens team
const ANOMALY_DETECTION_API_URL = "https://security-<region>.aws.supertokens.io/v1/security"

type SecurityCheckInput struct {
	ActionType       string             `json:"actionType,omitempty"`
	Email            string             `json:"email,omitempty"`
	PhoneNumber      string             `json:"phoneNumber,omitempty"`
	BruteForceConfig []BruteForceConfig `json:"bruteForceConfig,omitempty"`
}

type BruteForceConfig struct {
	Key         string        `json:"key"`
	MaxRequests []MaxRequests `json:"maxRequests"`
}

type MaxRequests struct {
	Limit             int `json:"limit"`
	PerTimeIntervalMS int `json:"perTimeIntervalMS"`
}

func getIpFromRequest(req *http.Request) string {
	if forwardedFor := req.Header.Get("X-Forwarded-For"); forwardedFor != "" {
		return forwardedFor
	}
	return "127.0.0.1"
}

func getBruteForceConfig(userIdentifier string, ip string, prefix string) []BruteForceConfig {
	var key string
	if prefix != "" {
		key = prefix + "-"
	}

	return []BruteForceConfig{
		{
			Key: key + userIdentifier,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
		{
			Key: key + ip,
			MaxRequests: []MaxRequests{
				{Limit: 5, PerTimeIntervalMS: 60 * 1000},
				{Limit: 15, PerTimeIntervalMS: 60 * 60 * 1000},
			},
		},
	}
}

func handleSecurityChecks(input SecurityCheckInput) (*supertokens.GeneralErrorResponse, error) {
	requestBody := make(map[string]interface{})

	requestBody["bruteForce"] = input.BruteForceConfig
	requestBody["email"] = input.Email
	requestBody["phoneNumber"] = input.PhoneNumber
	requestBody["actionType"] = input.ActionType

	jsonBody, err := json.Marshal(requestBody)
	if err != nil {
		return nil, err
	}

	req, err := http.NewRequest("POST", ANOMALY_DETECTION_API_URL, bytes.NewBuffer(jsonBody))
	if err != nil {
		// silently fail in order to not break the auth flow
		return nil, nil
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+SECRET_API_KEY)

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	var responseData map[string]interface{}
	err = json.NewDecoder(resp.Body).Decode(&responseData)
	if err != nil {
		return nil, err
	}

	if bruteForce, ok := responseData["bruteForce"].(map[string]interface{}); ok {
		if detected, ok := bruteForce["detected"].(bool); ok && detected {
			return &supertokens.GeneralErrorResponse{
				Message: "Too many requests. Please try again later.",
			}, nil
		}
	}

	return nil, nil
}

func main() {
	supertokens.Init(supertokens.TypeInput{
		RecipeList: []supertokens.Recipe{
			passwordless.Init(plessmodels.TypeInput{
				FlowType: "USER_INPUT_CODE",
				ContactMethodPhone: plessmodels.ContactMethodPhoneConfig{
					Enabled: true,
				},
				Override: &plessmodels.OverrideStruct{
					APIs: func(originalImplementation plessmodels.APIInterface) plessmodels.APIInterface {
						originalCreateCodePOST := *originalImplementation.CreateCodePOST
						(*originalImplementation.CreateCodePOST) = func(email *string, phoneNumber *string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.CreateCodePOSTResponse, error) {
                            actionType := "passwordless-send-sms"
							ip := getIpFromRequest(options.Req)
							var key string
							if email != nil {
								key = *email
							} else {
								key = *phoneNumber
							}
							bruteForceConfig := getBruteForceConfig(key, ip, actionType)

							// Check anomaly detection service before proceeding
							checkErr, err := handleSecurityChecks(
								SecurityCheckInput{
									ActionType:       actionType,
									Email:            *email,
									PhoneNumber:      *phoneNumber,
									BruteForceConfig: bruteForceConfig,
								},
							)
							if err != nil {
								return plessmodels.CreateCodePOSTResponse{}, err
							}

							if checkErr != nil {
								return plessmodels.CreateCodePOSTResponse{
									GeneralError: checkErr,
								}, nil
							}

							return originalCreateCodePOST(email, phoneNumber, tenantId, options, userContext)
						}

						originalResendCodePOST := *originalImplementation.ResendCodePOST
						(*originalImplementation.ResendCodePOST) = func(deviceID string, preAuthSessionID string, tenantId string, options plessmodels.APIOptions, userContext supertokens.UserContext) (plessmodels.ResendCodePOSTResponse, error) {
							// retreive user details
							codesInfo, err := passwordless.ListCodesByDeviceID(tenantId, deviceID, userContext)
							if err != nil {
								return plessmodels.ResendCodePOSTResponse{}, err
							}
							var email *string
							var phoneNumber *string
							if codesInfo.Email != nil {
								email = codesInfo.Email
							}
							if codesInfo.PhoneNumber != nil {
								phoneNumber = codesInfo.PhoneNumber
							}

							actionType := "passwordless-send-sms"
							ip := getIpFromRequest(options.Req)
							key := ""
							if email != nil {
								key = *email
							} else {
								key = *phoneNumber
							}
							bruteForceConfig := getBruteForceConfig(key, ip, actionType)

							// Check anomaly detection service before proceeding
							checkErr, err := handleSecurityChecks(
								SecurityCheckInput{
									ActionType:       actionType,
									Email:            *email,
									PhoneNumber:      *phoneNumber,
									BruteForceConfig: bruteForceConfig,
								},
							)
							if err != nil {
								return plessmodels.ResendCodePOSTResponse{}, err
							}

							if checkErr != nil {
								return plessmodels.ResendCodePOSTResponse{
									GeneralError: checkErr,
								}, nil
							}

							return originalResendCodePOST(deviceID, preAuthSessionID, tenantId, options, userContext)
						}

						return originalImplementation
					},
				},
			}),
		},
	})
}
```

The above code overrides the SuperTokens APIs and adding custom logic for anomaly detection. The steps when overriding the APIs are as follows:
- Define the action type based on the API you call.
- We get the email or the phone number from the form fields.
- We get the IP address from the request.
- We create the brute force configuration from the email, IP address, and action type. This configuration allows a number of requests over a time interval per:
    1. Action and email/phone number.
    2. Action and IP address.
- The anomaly detection service checks if the request passes the allowed criteria (only brute force detection occurs here).
- If the request is not allowed, the system returns a descriptive error response.
- If the request passes the allowed criteria, the original implementation of the API executes.
- We return the response from the original implementation of the API.

</Tab>

<Tab value="python">

```python
from httpx import AsyncClient
from typing import Dict, Any, Union, List
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import passwordless
from supertokens_python.recipe.passwordless.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.passwordless.asyncio import list_codes_by_device_id
from supertokens_python.framework import BaseRequest
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.recipe.session import SessionContainer

SECRET_API_KEY = "<secret-api-key>"  # Your secret API key that you received from the SuperTokens team
# The full URL with the correct region will be provided by the SuperTokens team
ANOMALY_DETECTION_API_URL = "https://security-<region>.aws.supertokens.io/v1/security"

async def handle_security_checks(
    request_id: Union[str, None],
    password: Union[str, None],
    brute_force_config: Union[List[Dict[str, Any]], None],
    email: Union[str, None],
    phone_number: Union[str, None],
    action_type: Union[str, None],
) -> Union[GeneralErrorResponse, None]:
    request_body: Dict[str, Any] = {}

    request_body["bruteForce"] = brute_force_config
    request_body["email"] = email
    request_body["phoneNumber"] = phone_number
    request_body["actionType"] = action_type

    try:
        async with AsyncClient(timeout=10.0) as client:
            response = await client.post(
                ANOMALY_DETECTION_API_URL,
                json=request_body,
                headers={
                    "Authorization": f"Bearer {SECRET_API_KEY}",
                    "Content-Type": "application/json",
                },
            )  # type: ignore
            response_data = response.json()
    except:
        # silently fail in order to not break the auth flow
        return None

    if response_data.get("bruteForce", {}).get("detected"):
        return GeneralErrorResponse(
            message="Too many requests. Please try again later."
        )

    return None

def get_ip_from_request(req: BaseRequest) -> str:
    forwarded_for = req.get_header("x-forwarded-for")
    if forwarded_for:
        return forwarded_for
    return "127.0.0.1"

def get_brute_force_config(
    user_identifier: Union[str, None], ip: str, prefix: Union[str, None] = None
) -> List[Dict[str, Any]]:
    return [
        {
            "key": f"{prefix}-{user_identifier}" if prefix else user_identifier,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
        {
            "key": f"{prefix}-{ip}" if prefix else ip,
            "maxRequests": [
                {"limit": 5, "perTimeIntervalMS": 60 * 1000},
                {"limit": 15, "perTimeIntervalMS": 60 * 60 * 1000},
            ],
        },
    ]

# highlight-start
def override_passwordless_apis(original_implementation: APIInterface):
    original_create_code_post = original_implementation.create_code_post

    async def create_code_post(
        email: Union[str, None],
        phone_number: Union[str, None],
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        action_type = "passwordless-send-sms"
        ip = get_ip_from_request(api_options.request)
        identifier = None
        if email is not None:
            identifier = email
        elif phone_number is not None:
            identifier = phone_number
        brute_force_config = get_brute_force_config(identifier, ip, action_type)

        # we check the anomaly detection service before calling the original implementation of create_code_post
        security_check_response = await handle_security_checks(
            request_id=None,
            password=None,
            brute_force_config=brute_force_config,
            email=email,
            phone_number=phone_number,
            action_type=action_type,
        )
        if security_check_response is not None:
            return security_check_response

        # We need to call the original implementation of create_code_post.
        response = await original_create_code_post(
            email,
            phone_number,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

        return response

    original_implementation.create_code_post = create_code_post

    original_resend_code_post = original_implementation.resend_code_post

    async def resend_code_post(
        device_id: str,
        pre_auth_session_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        action_type = "passwordless-send-sms"
        ip = get_ip_from_request(api_options.request)
        email = None
        phone_number = None
        codes = await list_codes_by_device_id(
            tenant_id=tenant_id, device_id=device_id, user_context=user_context
        )
        if codes is not None:
            email = codes.email
            phone_number = codes.phone_number
        identifier = None
        if email is not None:
            identifier = email
        elif phone_number is not None:
            identifier = phone_number
        brute_force_config = get_brute_force_config(identifier, ip, action_type)

        # we check the anomaly detection service before calling the original implementation of resend_code_post
        security_check_response = await handle_security_checks(
            request_id=None,
            password=None,
            brute_force_config=brute_force_config,
            email=email,
            phone_number=phone_number,
            action_type=action_type,
        )
        if security_check_response is not None:
            return security_check_response

        # We need to call the original implementation of resend_code_post.
        response = await original_resend_code_post(
            device_id,
            pre_auth_session_id,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

        return response

    original_implementation.resend_code_post = resend_code_post

    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            # highlight-start
            flow_type="USER_INPUT_CODE_AND_MAGIC_LINK",
            contact_config=passwordless.ContactEmailOrPhoneConfig(),
            override=passwordless.InputOverrideConfig(apis=override_passwordless_apis),
            # highlight-end
        )
    ],
)

```

The above code overrides the SuperTokens APIs and adding custom logic for anomaly detection. The steps when overriding the APIs are as follows:
- Define the action type based on the API you call.
- We get the email or the phone number from the form fields.
- We get the IP address from the request.
- We create the brute force configuration from the email, IP address, and action type. This configuration allows a number of requests over a time interval per:
    1. Action and email/phone number.
    2. Action and IP address.
- The anomaly detection service checks if the request passes the allowed criteria (only brute force detection occurs here).
- If the request is not allowed, the system returns a descriptive error response.
- If the request passes the allowed criteria, the original implementation of the API executes.
- We return the response from the original implementation of the API.

</Tab>

</Tabs>

# Additional Verification - User Roles -  Initial setup
Source: https://supertokens.com/docs/additional-verification/user-roles/initial-setup

## Overview 

When you work with the `UserRoles` recipe you should follow these steps:
<Steps>
## Create a role and assign permissions to it
## Assign roles to users
## Protect frontend and backend routes by verifying that the user has the correct role and permissions
</Steps>

The next sections show you the actual instructions on how to achieve this.

## Before you start

:::info Multi Tenancy

In a multi tenant setup, roles, and permissions share across all tenants, however, the mapping of users to roles are on a per tenant level.

For example, if you create one role (`"admin"`) and add permissions to it for `read:all` and `write:all`, this role can reuse across all tenants.
If you have user ID `user1` that has access to `tenant1` and `tenant2`, you can give them the `admin` role in `tenant1`, but not in `tenant2`.

:::

## Steps

### 1. Initialize the recipe

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-next-line
        UserRoles.init(),
    ]
});
```

</Tab>
<Tab value="go">

```go

UserRoles.init({
    // highlight-start
    skipAddingRolesToAccessToken: true,
    skipAddingPermissionsToAccessToken: true,
    // highlight-end
})
```

</Tab>
<Tab value="go">

```go

Note that if you associate a role to a user ID for a tenant, and that user ID doesn't belong to that tenant, then the operation still succeeds.
:::

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/user-roles/protecting-routes" label="Protecting Routes with User Roles" />
  <ReferenceCard href="/docs/additional-verification/user-roles/role-management-actions" label="Role Management Actions" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Session Verification" />
  <ReferenceCard href="/docs/post-authentication/dashboard/user-management" label="Dashboard User Role Management" />
</ReferenceCard.Grid>

# Additional Verification - User Roles -  Role management actions
Source: https://supertokens.com/docs/additional-verification/user-roles/role-management-actions

## Overview 

**SuperTokens** exposes a set of functions and APIs that you can use to have fine-grained control over roles and permissions.
Actions like listing roles, creating permissions, or checking which roles you assign are available through different SDK calls.

## Before you start

:::info 

You can also perform most of the actions outlined on this page from the user management dashboard.
To know more about how to use it check [the documentation](/docs/post-authentication/dashboard/user-management)

:::

---

## Create a role

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

async function createRole() {
    // highlight-start
    const response = await UserRoles.createNewRoleOrAddPermissions("user", ["read"]);

    if (response.createdNewRole === false) {
        // The role already exists
    }
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go
--data-raw '{
  "role": "user",
  "permissions": [
    "read"
  ]
}'

```

</Tab>

<Tab value="dashboard" className="tab-with-background">

<img src="/img/dashboard/create-role.gif" alt="Create Role"/>

</Tab>

</Tabs>

---

## List roles

<Tabs additionalValues={[{label: "Curl", value: "curl"}]}>
<Tab value="nodejs">

```tsx

async function getAllRoles() {
    // highlight-start
    const roles: string[] = (await UserRoles.getAllRoles()).roles;
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go

async function deleteRole() {
    // highlight-start
    // Delete the user role
    const response = await UserRoles.deleteRole("user");

    if (!response.didRoleExist) {
        // There was no such role
    }
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go
--data-raw '{
  "role": "admin"
}'
```

</Tab>
</Tabs>

---

## Add permissions

The SDK function only adds missing permissions and does not have any effect on permissions that are already assigned to a role.

<Tabs>
<Tab value="nodejs">

```tsx

async function addPermissionForRole() {
    // highlight-start
    // Add the "write" permission to the "user" role
    await UserRoles.createNewRoleOrAddPermissions("user", ["write"]);
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go

<Tabs>
<Tab value="nodejs">

```tsx

async function removePermissionFromRole() {
    // highlight-start
    // Remove the "write" permission to the "user" role
    const response = await UserRoles.removePermissionsFromRole("user", ["write"]);

    if (response.status === "UNKNOWN_ROLE_ERROR") {
        // No such role exists
    }
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go

async function getPermissionsForRole() {
    // highlight-start
    const response = await UserRoles.getPermissionsForRole("user");

    if (response.status === "UNKNOWN_ROLE_ERROR") {
        // No such role exists
        return;
    }

    const permissions: string[] = response.permissions;
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go
	response, err := userroles.GetPermissionsForRole("user", nil)
	if err != nil {
		// TODO: Handle error
		return
	}

	if response.UnknownRoleError != nil {
		// No such role exists
		return
	}

	_ = response.OK.Permissions
	// highlight-end
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.userroles.asyncio import get_permissions_for_role
from supertokens_python.recipe.userroles.interfaces import UnknownRoleError

async def remove_permission_from_role():
	# highlight-start
	res = await get_permissions_for_role("user")
	if isinstance(res, UnknownRoleError):
		# No such role exists
		return

	_ = res.permissions
	# highlight-end

```
</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.userroles.syncio import get_permissions_for_role
from supertokens_python.recipe.userroles.interfaces import UnknownRoleError

def remove_permission_from_role():
	# highlight-start
	res = get_permissions_for_role("user")
	if isinstance(res, UnknownRoleError):
		# No such role exists
		return

	_ = res.permissions
	# highlight-end

```
</Tab>

</Tabs>

</Tab>

</Tabs>

--- 

## Get roles by permission

Get a list of all the roles assigned a specific permission.

<Tabs>
<Tab value="nodejs">

```tsx

async function getRolesWithPermission() {
    // highlight-start
    const response = await UserRoles.getRolesThatHavePermission("write");
    const roles: string[] = response.roles;
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go

Note that if you associate a role to a user ID for a tenant, and that user ID doesn't actually belong to that tenant, then the operation still succeeds.
:::

---

## Remove role from a user and their sessions

You can remove roles from a user. The system removes the role you provide only if the user previously had that role.

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

async function removeRoleFromUserAndTheirSession(session: SessionContainer) {
    const response = await UserRoles.removeUserRole(session.getTenantId(), session.getUserId(), "user");

    if (response.status === "UNKNOWN_ROLE_ERROR") {
        // No such role exists
        return;
    }

    if (response.didUserHaveRole === false) {
        // The user was never assigned the role
    } else {
        // We also want to update the session of this user to reflect this change.
        await session.fetchAndSetClaim(UserRoles.UserRoleClaim);
        await session.fetchAndSetClaim(UserRoles.PermissionClaim);
    }
}
```

</Tab>
<Tab value="go">

```go
--data-raw '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "role": "user"
}'
```

</Tab>

</Tabs>

:::info Multi Tenancy
When using the multi-tenancy feature, in the previous snippets, only the user's role for the tenant they used to log in gets removed.
That's the one stored in the session.

You can pass in another tenant ID if you like, or call the function above for all the tenants that the user belongs to.
:::

---

## List the roles of a user

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

async function getRolesForUser(userId: string) {
    // highlight-start
    const response = await UserRoles.getRolesForUser("public", userId);
    const roles: string[] = response.roles;
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go
:::

---

## List the users of a role

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

async function getUsersThatHaveRole(role: string) {
    // highlight-start
    const response = await UserRoles.getUsersThatHaveRole("public", role);

    if (response.status === "UNKNOWN_ROLE_ERROR") {
        // No such role exists
        return;
    }

    const users: string[] = response.users;
    // highlight-end
}
```

</Tab>
<Tab value="go">

```go

# Additional Verification - User Roles -  Protect frontend and backend routes
Source: https://supertokens.com/docs/additional-verification/user-roles/protecting-routes

## Overview

To limit access to your application resources based on roles and permissions you have to use the `UserRoleClaim` inside the session validation logic.

## Before you start

<TokensCallout>

If you are implementing [**Unified Login**](/docs/authentication/unified-login/introduction), which uses **OAuth2 Access Tokens**, please check the [separate page](/docs/authentication/unified-login/verify-tokens) that shows you how to validate them.
You have to check for the `roles` claim in the token payload.

</TokensCallout>

---

## Protect backend routes

Override the global claim validators to integrate role verification in the standard flow.
The `GlobalValidators` represents other validators that apply to all API routes by default.
This may include a validator that enforces that the user has verified their email.

To perform the verification follow these steps:
- Add the `UserRoleClaim` validator to the `Verify Session` function which makes sure that the user has specific roles.
- Optionally, add a `PermissionClaim` validator to enforce a permission.

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post(
    "/update-blog",
    verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ],
    }),
    async (req: SessionRequest, res) => {
        // All validator checks have passed and the user is an admin.
    }
);
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    overrideGlobalClaimValidators: async (globalValidators) => [
                        ...globalValidators,
                        UserRoles.UserRoleClaim.validators.includes("admin"),
                        // UserRoles.PermissionClaim.validators.includes("edit")
                    ],
                }),
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // All validator checks have passed and the user is an admin.
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ],
    }),
}, async (req: SessionRequest, res) => {
    // All validator checks have passed and the user is an admin.
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    // All validator checks have passed and the user is an admin.
};

exports.handler = verifySession(updateBlog, {
    overrideGlobalClaimValidators: async (globalValidators) => ([
        ...globalValidators, 
        UserRoles.UserRoleClaim.validators.includes("admin"),
        // UserRoles.PermissionClaim.validators.includes("edit")
    ])
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => ([
            ...globalValidators, 
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ])
    }), async (ctx: SessionContext, next) => {
    // All validator checks have passed and the user is an admin.
});
```

</Tab>
<Tab value="loopback">

```tsx

class SetRole {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/update-blog")
    @intercept(verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => ([
            ...globalValidators, 
            UserRoles.UserRoleClaim.validators.includes("admin"),
            // UserRoles.PermissionClaim.validators.includes("edit")
        ])
    }))
    @response(200)
    async handler() {
        // All validator checks have passed and the user is an admin.
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function setRole(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                overrideGlobalClaimValidators: async (globalValidators) => ([
                    ...globalValidators, 
                    UserRoles.UserRoleClaim.validators.includes("admin"),
                    // UserRoles.PermissionClaim.validators.includes("edit")
                ])
            })(req, res, next);
        },
        req,
        res
    )
    // All validator checks have passed and the user is an admin.
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        // All validator checks have passed and the user is an admin.
        return NextResponse.json({})
    },
    {
        // highlight-start
        overrideGlobalClaimValidators: async function (globalClaimValidators) {
            return [...globalClaimValidators, UserRoles.UserRoleClaim.validators.includes("admin")]
        }
        // highlight-end
    });
}
```

</ConditionalContent>
</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard({
    overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => ([
        ...globalValidators, 
        UserRoles.UserRoleClaim.validators.includes("admin"),
        // UserRoles.PermissionClaim.validators.includes("edit")
    ])
  }))
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    // All validator checks have passed and the user is an admin.
    return true;
  }
}
```
</Tab>

</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go

let app = express();

app.post("/update-blog", verifySession(), async (req: SessionRequest, res) => {
    // highlight-start
    const roles = await req.session!.getClaimValue(UserRoles.UserRoleClaim);
    
    if (roles === undefined || !roles.includes("admin")) {
        // this error tells SuperTokens to return a 403 to the frontend.
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User is not an admin",
            payload: [{
                id: UserRoles.UserRoleClaim.key
            }]
        })
    }
    // highlight-end
    // user is an admin..
});
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/update-blog",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // highlight-start
        const roles = await req.session!.getClaimValue(UserRoles.UserRoleClaim);

        if (roles === undefined || !roles.includes("admin")) {
            // this error tells SuperTokens to return a 403 to the frontend.
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User is not an admin",
                payload: [{
                    id: UserRoles.UserRoleClaim.key
                }]
            })
        }
        // highlight-end
        // user is an admin..
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/update-blog", {
    preHandler: verifySession(),
}, async (req: SessionRequest, res) => {
    // highlight-start
    const roles = await req.session!.getClaimValue(UserRoles.UserRoleClaim);

    if (roles === undefined || !roles.includes("admin")) {
        // this error tells SuperTokens to return a 403 to the frontend.
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User is not an admin",
            payload: [{
                id: UserRoles.UserRoleClaim.key
            }]
        })
    }
    // highlight-end
    // user is an admin..
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateBlog(awsEvent: SessionEvent) {
    // highlight-start
    const roles = await awsEvent.session!.getClaimValue(UserRoles.UserRoleClaim);

    if (roles === undefined || !roles.includes("admin")) {
        // this error tells SuperTokens to return a 403 to the frontend.
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User is not an admin",
            payload: [{
                id: UserRoles.UserRoleClaim.key
            }]
        })
    }
    // highlight-end
    // user is an admin..
};

exports.handler = verifySession(updateBlog);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/update-blog", verifySession(), async (ctx: SessionContext, next) => {
    // highlight-start
    const roles = await ctx.session!.getClaimValue(UserRoles.UserRoleClaim);

    if (roles === undefined || !roles.includes("admin")) {
        // this error tells SuperTokens to return a 403 to the frontend.
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User is not an admin",
            payload: [{
                id: UserRoles.UserRoleClaim.key
            }]
        })
    }
    // highlight-end
    // user is an admin..
});
```

</Tab>
<Tab value="loopback">

```tsx

class UpdateBlog {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) {}
    @post("/update-blog")
    @intercept(verifySession())
    @response(200)
    async handler() {
        // highlight-start
        const roles = await ((this.ctx as any).session as Session.SessionContainer).getClaimValue(UserRoles.UserRoleClaim);

        if (roles === undefined || !roles.includes("admin")) {
            // this error tells SuperTokens to return a 403 to the frontend.
            throw new STError({
                type: "INVALID_CLAIMS",
                message: "User is not an admin",
                payload: [{
                    id: UserRoles.UserRoleClaim.key
                }]
            })
        }
        // highlight-end
        // user is an admin..
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

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

	// highlight-start
    const roles = await req.session!.getClaimValue(UserRoles.UserRoleClaim);

    if (roles === undefined || !roles.includes("admin")) {
        // this error tells SuperTokens to return a 403 to the frontend.
        await superTokensNextWrapper(
            async (next) => {
                throw new STError({
                    type: "INVALID_CLAIMS",
                    message: "User is not an admin",
                    payload: [{
                        id: UserRoles.UserRoleClaim.key
                    }]
                })
            },
            req,
            res
        )
    }
    // highlight-end
    // user is an admin..
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        const roles = await session!.getClaimValue(UserRoles.UserRoleClaim);
        if (roles === undefined || !roles.includes("admin")) {
            const error = new STError({
                type: "INVALID_CLAIMS",
                message: "User is not an admin",
                payload: [{
                    id: UserRoles.UserRoleClaim.key
                }]
            });
            return NextResponse.json(error, { status: 403 });
        }
        // user is an admin..
        return NextResponse.json({})
    });
}

```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard())
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    // highlight-start
    const roles = await session.getClaimValue(UserRoles.UserRoleClaim);

    if (roles === undefined || !roles.includes("admin")) {
        // this error tells SuperTokens to return a 403 to the frontend.
        throw new STError({
            type: "INVALID_CLAIMS",
            message: "User is not an admin",
            payload: [{
                id: UserRoles.UserRoleClaim.key
            }]
        })
    }
    // highlight-end
    // user is an admin..
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go

const AdminRoute = (props: React.PropsWithChildren<any>) => {
    return (
        <SessionAuth 
            accessDeniedScreen={AccessDeniedScreen}
            overrideGlobalClaimValidators={(globalValidators) => [
                ...globalValidators, UserRoleClaim.validators.includes("admin"),
            ]
        }>
            {props.children}
        </SessionAuth>
    );
}

```
Above, you create a generic component called `AdminRoute` which enforces that its child components render only if the user has the admin role.

In the `AdminRoute` component, the `SessionAuth` wrapper ensures that the session exists. The `UserRoleClaim` validator is also added to the `<SessionAuth>` component which checks if the validators pass or not. If all validation passes, the `props.children` component renders. If the claim validation has failed, it displays the `AccessDeniedScreen` component instead of rendering the children. You can also pass a custom component to the `accessDeniedScreen` prop.

:::note
You can extend the `AdminRoute` component to check for other types of validators as well. This component can then reuse to protect all your app's components (In this case, you may want to rename this component to something more appropriate, like `ProtectedRoute`).
:::

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx

function ProtectedComponent() {
    let claimValue = Session.useClaimValue(UserRoleClaim)
    if (claimValue.loading || !claimValue.doesSessionExist) {
        return null;
    }
    let roles = claimValue.value;
    if (Array.isArray(roles) && roles.includes("admin")) {
        // User is an admin
    } else {
        // User doesn't have any roles, or is not an admin..
    }
}
```

</Tab>

<Tab value="angular">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {

        // highlight-start
        let validationErrors = await Session.validateClaims({
            overrideGlobalClaimValidators: (globalValidators) =>
                [...globalValidators,
                    UserRoleClaim.validators.includes("admin"),
                 /* PermissionClaim.validators.includes("modify") */
                ]
        });
        // highlight-end

        if (validationErrors.length === 0) {
            // user is an admin
            return true;
        }

        for (const err of validationErrors) {
            if (err.id === UserRoleClaim.id) {
                // user roles claim check failed
            } else {
                // some other claim check failed (from the global validators list)
            }
        }
    }
    // either a session does not exist, or one of the validators failed.
    // so we do not allow access to this page.
    return false
}
```

- We call the `validateClaims` function with the `UserRoleClaim` validator which makes sure that the user has an `admin` role.
- The `globalValidators` represents other validators that apply to all calls to the `validateClaims` function. This may include a validator that enforces that the user has verified their email (if enabled by you).
- We can also add a `PermissionClaim` validator to enforce a permission.

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        // highlight-start
        let roles = await Session.getClaimValue({claim: UserRoleClaim});
        if (Array.isArray(roles) && roles.includes("admin")) {
            // User is an admin
            return true;
        }
         // highlight-end
    }
    // either a session does not exist, or the user is not an admin
    return false
}
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {

        // highlight-start
        let validationErrors = await Session.validateClaims({
            overrideGlobalClaimValidators: (globalValidators) =>
                [...globalValidators,
                    UserRoleClaim.validators.includes("admin"),
                 /* PermissionClaim.validators.includes("modify") */
                ]
        });
        // highlight-end

        if (validationErrors.length === 0) {
            // user is an admin
            return true;
        }

        for (const err of validationErrors) {
            if (err.id === UserRoleClaim.id) {
                // user roles claim check failed
            } else {
                // some other claim check failed (from the global validators list)
            }
        }
    }
    // either a session does not exist, or one of the validators failed.
    // so we do not allow access to this page.
    return false
}
```

<Box px="4" pt="5">

- We call the `validateClaims` function with the `UserRoleClaim` validator which makes sure that the user has an `admin` role.
- The `globalValidators` represents other validators that apply to all calls to the `validateClaims` function. This may include a validator that enforces that the user has verified their email (if enabled by you).
- We can also add a `PermissionClaim` validator to enforce a permission.

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

</Box>

```tsx

async function shouldLoadRoute(): Promise<boolean> {
    if (await Session.doesSessionExist()) {
        // highlight-start
        let roles = await Session.getClaimValue({claim: UserRoleClaim});
        if (roles !== undefined && roles.includes("admin")) {
            // User is an admin
            return true;
        }
         // highlight-end
    }
    // either a session does not exist, or the user is not an admin
    return false
}
```

</Tab>
<Tab value="scripts">

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {

        // highlight-start
        let validationErrors = await supertokensSession.validateClaims({
            overrideGlobalClaimValidators: (globalValidators) =>
                [...globalValidators,
                    supertokensUserRoles.UserRoleClaim.validators.includes("admin"),
                 /* supertokensUserRoles.PermissionClaim.validators.includes("modify") */
                ]
        });
        // highlight-end

        if (validationErrors.length === 0) {
            // user is an admin
            return true;
        }

        for (const err of validationErrors) {
            if (err.id === supertokensUserRoles.UserRoleClaim.id) {
                // user roles claim check failed
            } else {
                // some other claim check failed (from the global validators list)
            }
        }
    }
    // either a session does not exist, or one of the validators failed.
    // so we do not allow access to this page.
    return false
}
```

- We call the `validateClaims` function with the `UserRoleClaim` validator which makes sure that the user has an `admin` role.
- The `globalValidators` represents other validators that apply to all calls to the `validateClaims` function. This may include a validator that enforces that the user has verified their email (if enabled by you).
- We can also add a `PermissionClaim` validator to enforce a permission.

If you want to have more complex access control, you can get the roles list from the session as follows, and check the list yourself:

```tsx
async function shouldLoadRoute(): Promise<boolean> {
    if (await supertokensSession.doesSessionExist()) {
        // highlight-start
        let roles = await supertokensSession.getClaimValue({claim: supertokensUserRoles.UserRoleClaim});
        if (roles !== undefined && roles.includes("admin")) {
            // User is an admin
            return true;
        }
         // highlight-end
    }
    // either a session does not exist, or the user is not an admin
    return false
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function getRole() {
    if (await SuperTokens.doesSessionExist()) {

        // highlight-start
        let roles: string[] = (await SuperTokens.getAccessTokenPayloadSecurely())["st-role"].v;

        if (roles.includes("admin")) {
            // TODO..
        } else {
            // TODO..
        }
        // highlight-end
    }
}
```

</Tab>

<Tab value="android">

```kotlin
        val roles: List<String> = (accessTokenPayload.get("st-role") as JSONObject).get("v") as List<String>;
        if (roles.contains("admin")) {
            // user is an admin
        } else {
            // user is not an admin
        }
    }
}
```

</Tab>

<Tab value="ios">

```swift

Future<void> checkIfUserIsAnAdmin() async {
    var accessTokenPayload = await SuperTokens.getAccessTokenPayloadSecurely();

    if (accessTokenPayload.containsKey("st-role")) {
      Map<String, dynamic> roleObject = accessTokenPayload["st-role"];

      if (roleObject.containsKey("v")) {
        List<String> roles = roleObject["v"];

        if (roles.contains("admin")) {
          // user is an admin
        } else {
          // user is not an admin
        }
      }
    }
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/user-roles/role-management-actions" label="Role management actions" />
  <ReferenceCard href="/docs/additional-verification/session-verification/claim-validation" label="Claim validation" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Protect backend routes" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Protect frontend routes" />
</ReferenceCard.Grid>

# Additional Verification -  CAPTCHA validation
Source: https://supertokens.com/docs/additional-verification/captcha

## Overview

This following tutorial shows you how to add CAPTCHA validation to your authentication flows.
The guide makes use of the plugins functionality.
A new abstraction layer aimed to simplify how you can add new features in your **SuperTokens** integration.

## Before you start

The plugin supports only the `React` and `NodeJS` SDKs. 
Support for other platforms is under active development.

You can use the plugin with the following CAPTCHA providers:
- [Google reCAPTCHA v2](https://developers.google.com/recaptcha/docs/display)
- [Google reCAPTCHA v3](https://developers.google.com/recaptcha/docs/v3)  
- [Cloudflare Turnstile](https://www.cloudflare.com/en-gb/application-services/products/turnstile)

Make sure to have the appropriate provider keys before starting the tutorial.

The implementation is in early stages and APIs might change.
For more information on how plugins work refer to the [references page](/docs/references/plugins/introduction).

## Steps

### 1. Initialize the frontend plugin

#### 1.1 Install the plugin

```bash
npm install @supertokens-plugins/captcha-react
```

#### 1.2 Update your frontend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      CaptchaPlugin.init({
	type: 'reCAPTCHAv3', // or "reCAPTCHAv2" or "turnstile"
	captcha: {
	  sitekey: 'your-site-key',
	  // Additional configuration based on the captcha provider
	},
      }),
    ],
  }
});
```

### 2. Initialize the backend plugin

#### 2.1 Install the plugin

```bash
npm install @supertokens-plugins/captcha-nodejs
```

#### 2.2 Update your backend SDK configuration

```typescript

SuperTokens.init({
  supertokens: {
    connectionURI: '...',
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      CaptchaPlugin.init({
	type: 'reCAPTCHAv3', // or "reCAPTCHAv2" or "turnstile"
	captcha: {
	  secretKey: 'your-secret-key',
	},
      }),
    ],
  }
});
```

:::info no-title
If you are using a captcha input that renders an input on the frontend, you will have to [disable the use of shadow DOM](/docs/references/frontend-sdks/prebuilt-ui/shadow-dom) when you initialize the SDK.
:::

### 3. Customize the plugin

By default, the plugin performs CAPTCHA validation on the following authentication flows:

| Recipe          | Authentication Flow        | Forms                                                                                  | Pre-API Hook Action         | API Function                     |
| --------------- | -------------------------- | -------------------------------------------------------------------------------------- | --------------------------- | -------------------------------- |
| `EmailPassword` | User sign in               | `EmailPasswordSignInForm`                                                              | `EMAIL_PASSWORD_SIGN_IN`    | `signInPOST`                     |
| `EmailPassword` | User registration          | `EmailPasswordSignUpForm`                                                              | `EMAIL_PASSWORD_SIGN_UP`    | `signUpPOST`                     |
| `EmailPassword` | Password reset request     | `EmailPasswordResetPasswordEmail`                                                      | `SEND_RESET_PASSWORD_EMAIL` | `generatePasswordResetTokenPOST` |
| `EmailPassword` | Password reset submission  | `EmailPasswordSubmitNewPassword`                                                       | `SUBMIT_NEW_PASSWORD`       | `passwordResetPOST`              |
| `Passwordless`  | Generate verification code | `PasswordlessEmailForm` and `PasswordlessPhoneForm` and `PasswordlessEmailOrPhoneForm` | `PASSWORDLESS_CREATE_CODE`  | `createCodePOST`                 |
| `Passwordless`  | Verify code and sign in    | `PasswordlessUserInputForm`                                                            | `PASSWORDLESS_CONSUME_CODE` | `consumeCodePOST`                |

To limit which actions require additional validation, pass additional configuration parameters to the frontend and backend setup steps.

#### Frontend conditional validation

On the frontend create a custom component that conditionally loads the CAPTCHA provider based on the name of the form. 

```typescript

const CaptchaInputContainer = forwardRef<
  HTMLDivElement,
  CaptchInputContainerProps
>((props, ref) => {
  const { form, ...rest } = props;
  const { loadAndRender, containerId } = useCaptcha();

  useEffect(() => {
    // CAPTCHA applies/renders only for the EmailPasswordSignUpForm
    // and the EmailPasswordResetPasswordEmail
    if (
      form === 'EmailPasswordSignUpForm' ||
      form === 'EmailPasswordResetPasswordEmail'
    ) {
      loadAndRender();
    }
  }, [form]);

  return (
    <div ref={ref} id={containerId} className="CAPTCHA-container" {...rest} />
  );
});

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      CaptchaPlugin.init({
	type: 'reCAPTCHAv3', // or "reCAPTCHAv2" or "turnstile"
	captcha: {
	  sitekey: 'your-site-key',
	},
	InputContainer: CaptchaInputContainer,
      }),
    ],
  }
});

```

#### Backend conditional validation

On the backend pass a custom validation function that tells the plugin which actions should require extra validation.

```typescript

const shouldValidate: ShouldValidate = (api, input) => {
  // Only require CAPTCHA for sign up
  if (api === 'signUpPOST') {
    return true;
  }

  // Check request headers for suspicious activity
  if (api === 'signInPOST') {
    const userAgent = input.options.req.getHeaderValue('user-agent');
    return !userAgent || userAgent.includes('bot');
  }

  return false;
};

SuperTokens.init({
  supertokens: {
    connectionURI: '...',
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      CaptchaPlugin.init({
	type: 'reCAPTCHAv3', // or "reCAPTCHAv2" or "turnstile"
	captcha: {
	  secretKey: 'your-secret-key',
	},
	shouldValidate,
      }),
    ],
   }
});

```


Besides CAPTCHA validation you can also look into the **Attack Protection Suite** feature which provides prevention against suspicious authentication attempts.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/attack-protection-suite/introduction">
    <ReferenceCard.Title>
      Attack Protection Suite
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Prevent suspicious authentication attempts.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/additional-verification/mfa/introduction">
    <ReferenceCard.Title>
      Multi-factor Authentication
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Add multi-factor authentication to your authentication flows.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/plugins/introduction">
    <ReferenceCard.Title>
     Plugins Reference 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
     General information on how plugins work.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Post Authentication -  Post login redirection
Source: https://supertokens.com/docs/post-authentication/post-login-redirect

## Change redirection path post login

<Tabs>
<Tab value="reactjs">

By default, the user is redirected to the the `/` route on your website post login. To change this, you can use the `getRedirectionURL` function on the frontend as shown below:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            if (context.redirectToPath !== undefined) {
                // we are navigating back to where the user was before they authenticated
                return context.redirectToPath;
            }
            if (context.createdNewUser) {
                // user signed up
            } else {
                // user signed in
            }
            return "/dashboard";
        }
        return undefined;
    },
    // highlight-end
    recipeList: [ /* Recipe list */]
});
```

</Tab>

<Tab value="angular">

By default, the user is redirected the the `/` route on your website post login. To change this, you can use the `getRedirectionURL` function on the frontend as shown below:

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            if (context.redirectToPath !== undefined) {
                // we are navigating back to where the user was before they authenticated
                return context.redirectToPath;
            }
            if (context.createdNewUser) {
                // user signed up
            } else {
                // user signed in
            }
            return "/dashboard";
        }
        return undefined;
    },
    // highlight-end
    recipeList: [ /* Recipe list */]
});
```

</Tab>

</Tabs>

The user will be redirected to the provided URL on:
- Successful sign up.
- Successful sign in.
- Successful email verification post sign up.
- If the user is already logged in.

If you want to redirect the user to a different domain, then you can first redirect them to a specific path using the function above, which further redirects them to the final domain.

:::info
Please refer to [this page](/docs/references/frontend-sdks/hooks#redirection-callback-hook) to learn more about the `getRedirectionURL` hook.
:::

## Redirect user to the login page

<Tabs>
<Tab value="reactjs">

Use the `redirectToAuth({show?: "signin" | "signup", redirectBack?: boolean}?)` function to redirect the user to the login screen. For example, you may want to call this function when the user clicks on the login button.

```tsx
// highlight-next-line

function NavBar () {
  async function onLogin () {
    // highlight-next-line
    redirectToAuth(); 
  }
  return (
    <ul>
        <li>Home</li>
        // highlight-next-line
        <li onClick={onLogin}>Login</li> 

    </ul>
  )
}
```

- Call `redirectToAuth({show: "signin"})` to take them to the sign in screen
- Call `redirectToAuth({show: "signup"})` to take them to the sign up screen
- If you do not want the user to be redirected to the current page post sign in, use `redirectToAuth({redirectBack: false})`

</Tab>
<Tab value="angular">

Redirect the user to the `/auth` (this is the default path for the pre-built UI)

```ts

@Component({
    selector: 'nav-bar',
    template: `
        <ul>
            <li>Home</li>
            // highlight-next-line
            <li (click)="onLogin()">Login</li> 
        </ul>
    `,
})
export class NavBarComponent {
    async onLogin () {
        // highlight-next-line
        window.location.href = "/auth?show=signin&redirectToPath=" + encodeURIComponent(window.location.pathname);
    }
}
```

- Set `show=signin` to take them to the sign in screen
- Set `show=signup` to take them to the sign up screen
- Set `redirectToPath` to redirect the user to a specific page after they have signed in, or you can skip it to take them to the `/` route (which is the default one).

</Tab>

<Tab value="vue">

Redirect the user to the `/auth` (this is the default path for the pre-built UI)

```html
<template>
  <ul>
    <li>Home</li>
    // highlight-next-line
    <li @click="onLogin">Login</li>
  </ul>
</template>

<script>

export default {
  name: "NavBarComponent",
  methods: {
    async onLogin() {
    // highlight-next-line
      window.location.href = "/auth?show=signin&redirectToPath=" + encodeURIComponent(window.location.pathname);
    }
  }
};
</script>
```

- Set `show=signin` to take them to the sign in screen
- Set `show=signup` to take them to the sign up screen
- Set `redirectToPath` to redirect the user to a specific page after they have signed in, or you can skip it to take them to the `/` route (which is the default one).

</Tab>
</Tabs>

## Showing sign up by default

The login screen shows the sign in UI by default, to change that, you can set the following config:

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-next-line
    defaultToSignUp: true,
    recipeList: [ /* ... */]
});
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-next-line
    defaultToSignUp: true,
    recipeList: [ /* ... */]
});
```

</Tab>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Protect Frontend Routes" />
  <ReferenceCard href="/docs/references/frontend-sdks/hooks#redirection-callback-hook" label="Redirection Callback Hook" />
  <ReferenceCard href="/docs/post-authentication/session-management/session-invalidation" label="Session Invalidation" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-in-form" label="Customize Sign-in Form" />
  <ReferenceCard href="/docs/authentication/email-password/customize-the-sign-up-form" label="Customize Sign-up Form" />
</ReferenceCard.Grid>

# Post Authentication - Session Management -  Access session data
Source: https://supertokens.com/docs/post-authentication/session-management/access-session-data

## Overview

The session data is accessible, both in the backend and on the frontend, after a user has successfully logged in.
This guide shows you how to access different session properties.

## Before you start



---

## Access the JWT Token

### On the backend

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.get("/getJWT", verifySession(), async (req, res) => {

    let session = req.session;

    // highlight-start
    let jwt = session.getAccessToken();
    // highlight-end

    res.json({ token: jwt })
});
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/getJWT",
    method: "get",
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let session = req.session;

        // highlight-start
        let jwt = session!.getAccessToken();
        // highlight-end
        return res.response({ token: jwt }).code(200);
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.get("/getJWT", {
    preHandler: verifySession(),
}, (req, res) => {
    let session = req.session;

    // highlight-start
    let jwt = session.getAccessToken();
    // highlight-end
    res.send({ token: jwt });
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function getJWT(awsEvent: SessionEvent) {
    let session = awsEvent.session;

    // highlight-start
    let jwt = session!.getAccessToken();
    // highlight-end

    return {
        body: JSON.stringify({ token: jwt }),
        statusCode: 200,
    };
};

exports.handler = verifySession(getJWT);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.get("/getJWT", verifySession(), (ctx: SessionContext, next) => {
    let session = ctx.session;

    // highlight-start
    let jwt = session!.getAccessToken();
    // highlight-end
    ctx.body = { token: jwt };
});
```

</Tab>
<Tab value="loopback">

```tsx

class GetJWT {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: SessionContext) { }
    @get("/getJWT")
    @intercept(verifySession())
    @response(200)
    handler() {
        let session = this.ctx.session;

        // highlight-start
        let jwt = session!.getAccessToken();
        // highlight-end
        return { token: jwt };
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

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

    // highlight-start
    let jwt = session!.getAccessToken();
    // highlight-end
    res.json({ token: jwt })
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        // highlight-start
        let jwt = session!.getAccessToken();
        // highlight-end
        return NextResponse.json({ token: jwt });
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Get('example')
  @UseGuards(new AuthGuard())
  async postExample(@Session() session: SessionContainer): Promise<{ token: any }> {
    //highlight-start
    // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
    const jwt = session.getAccessToken();
    //highlight-end
    return { token: jwt };
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            exposeAccessTokenToFrontendInCookieBasedAuth: true,
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

async function getJWT() {
      if (await Session.doesSessionExist()) {
            let userId = await Session.getUserId();
            let jwt = await Session.getAccessToken();
      }
}
```

</Tab>
<Tab value="angular">

```tsx

async function getJWT() {
      if (await Session.doesSessionExist()) {
            let userId = await Session.getUserId();
            let jwt = await Session.getAccessToken();
      }
}
```

</Tab>
</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function getJWT() {
      if (await Session.doesSessionExist()) {
            let userId = await Session.getUserId();
            let jwt = await Session.getAccessToken();
      }
}
```

</Tab>
<Tab value="scripts">

```tsx
async function getJWT() {
      if (await supertokensSession.doesSessionExist()) {
            let userId = await supertokensSession.getUserId();
            let jwt = await supertokensSession.getAccessToken();
      }
}
```

</Tab>
</Tabs>
</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function getJWT() {
      if (await SuperTokens.doesSessionExist()) {
            let userId = await SuperTokens.getUserId();
            let jwt = await SuperTokens.getAccessToken();
      }
}
```

</Tab>

<Tab value="android">

```kotlin
    }
}
```

</Tab>

<Tab value="ios">

```swift

Future<void> getJWT() async {
    var jwt = await SuperTokens.getAccessToken();

    if (jwt != null) {
      // Use `jwt` however you like
    }
}
```

</Tab>

</Tabs>

</Tab>
</Tabs>

</CustomUIInstructions>

---

## Access the Tenant ID

:::info Multi Tenancy
This feature is only relevant if you are using the multi tenancy feature.
:::

The session's access token payload contains the tenant ID in the `tId` claim. You can access it in the following way:

### On the backend

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

// highlight-start
app.post("/like-comment", verifySession(), (req: SessionRequest, res) => {
    let tenantId = req.session!.getTenantId();
    // highlight-end
    //....
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",
    //highlight-start
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let tenantId = req.session!.getTenantId();
        //highlight-end
        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post("/like-comment", {
    preHandler: verifySession(),
}, (req: SessionRequest, res) => {
    let tenantId = req.session!.getTenantId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function likeComment(awsEvent: SessionEventV2) {
    let tenantId = awsEvent.session!.getTenantId();
    //....
};

//highlight-next-line
exports.handler = verifySession(likeComment);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/like-comment", verifySession(), (ctx: SessionContext, next) => {
    let tenantId = ctx.session!.getTenantId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    //highlight-start
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/like-comment")
    @intercept(verifySession())
    @response(200)
    handler() {
        let tenantId = (this.ctx as SessionContext).session!.getTenantId();
        //highlight-end
        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

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

    let tenantId = req.session!.getTenantId();
    // highlight-end
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        let tenantId = session!.getTenantId();
        //....
        return NextResponse.json({})
    });
}
```

</ConditionalContent>
</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@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> {
    //highlight-start
    let tenantId = session.getTenantId();

    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go
:::

### On the frontend

You can read the tenant ID on the frontend by adding the `tId` claim from the [access token payload](/docs/additional-verification/session-verification/claim-validation#using-the-access-token-payload).

---

## Fetch all user sessions

Given a user ID, you can fetch all sessions that are active for that user in the following way:

<Tabs>
<Tab value="nodejs">

```tsx

async function getSessions() {
    let userId = "someUserId" // fetch somehow

    // sessionHandles is string[]
    // highlight-next-line
    let sessionHandles = await Session.getAllSessionHandlesForUser(userId);

    sessionHandles.forEach((handle) => {

        /* we can do the following with the handle:
         * - revoke this session
         * - change access token payload or session data
         * - fetch access token payload or session data
        */
    })
}
```
</Tab>
<Tab value="go">

```go

# Post Authentication - Session Management -  Session invalidation
Source: https://supertokens.com/docs/post-authentication/session-management/session-invalidation

## Overview

You can invalidate a session in **SuperTokens** in different ways.
The main recommendation is to use the `signOut` function from the frontend SDK.
Besides that you can also revoke sessions manually, through the backend SDKs.
This guide shows you how to implement each of these.

## Before you start



---

## User sign out

The frontend SDK exposes a `signOut` function that revokes the session for the user.
You need to add your own UI element for this since the library does not expose any components.
The `signOut` function calls the sign out API exposed by the session recipe on the backend and, in turn, revokes all the user active sessions.
If you call the `signOut` function whilst the access token has expired, but the refresh token still exists, the SDKs automatically perform a session refresh before revoking the session.

:::important
You have to add your own redirection logic after the sign out call completes.
:::



<PrebuiltUIInstructions>

<Tabs>
<Tab value="reactjs">

```tsx
// highlight-next-line

function NavBar() {
  async function onLogout() {
    // highlight-next-line
    await signOut();
    window.location.href = "/auth"; // or redirect to wherever the login page is
  }
  return (
    <ul>
      <li>Home</li>
          // highlight-next-line
      <li onClick={onLogout}>Logout</li>

    </ul>
  )
}
```
</Tab>

<Tab value="angular">

```tsx
// highlight-next-line

async function logout () {
  // highlight-next-line
  await Session.signOut(); 
  window.location.href = "/auth"; // or redirect to wherever the login page is
}
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

async function logout () {
  // highlight-next-line
  await Session.signOut(); 
  window.location.href = "/auth"; // or redirect to wherever the login page is
}
```

</Tab>
<Tab value="scripts">

```tsx
async function logout () {
  // highlight-next-line
  await supertokensSession.signOut(); 
  window.location.href = "/auth"; // or redirect to wherever the login page is
}
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

async function logout () {
  // highlight-next-line
  await SuperTokens.signOut(); 
  // navigate to the login screen..
}
```

</Tab>

<Tab value="android">

```kotlin
        // navigate to the login screen..
    }
}
```

</Tab>

<Tab value="ios">

```swift

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

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

### Expose a backend sign out method

If you do not want to use the frontend function you can expose a backend sign out method.

<Tabs>
<Tab value="nodejs">

<Tabs>
<Tab value="express">

```tsx

let app = express();

// highlight-start
app.post("/someapi", verifySession(), async (req: SessionRequest, res) => {

    // This will delete the session from the db and from the frontend (cookies)
    await req.session!.revokeSession();
    // highlight-end

    res.send("Success! User session revoked");
});
```
</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/someapi",
    method: "post",
    //highlight-start
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        // This will delete the session from the db and from the frontend (cookies)
        await req.session!.revokeSession();
        // highlight-end
        return res.response("Success! User session revoked").code(200);
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post("/someapi", {
    preHandler: verifySession(),
}, async (req: SessionRequest, res) => {
    // This will delete the session from the db and from the frontend (cookies)
    await req.session!.revokeSession();
    // highlight-end

    res.send("Success! User session revoked");
});
```

</Tab>
<Tab value="awsLambda">

```tsx

// highlight-start
async function someapi(awsEvent: SessionEvent) {
    // This will delete the session from the db and from the frontend (cookies)
    await awsEvent.session!.revokeSession();
    // highlight-end

    return {
        body: JSON.stringify({ message: "Success! User session revoked" }),
        statusCode: 200,
    };
};

exports.handler = verifySession(someapi);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/someapi", verifySession(), async (ctx: SessionContext, next) => {
    // This will delete the session from the db and from the frontend (cookies)
    await ctx.session!.revokeSession();
    // highlight-end

    ctx.body = "Success! User session revoked";
});
```

</Tab>
<Tab value="loopback">

```tsx

class Logout {
    //highlight-start
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: SessionContext) { }
    @post("/someapi")
    @intercept(verifySession())
    @response(200)
    async handler() {
        // This will delete the session from the db and from the frontend (cookies)
        await this.ctx.session!.revokeSession();
        // highlight-end

        return "Success! User session revoked";
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function someapi(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            // highlight-next-line
            await verifySession()(req, res, next);
        },
        req,
        res
    )
    // This will delete the session from the db and from the frontend (cookies)
    await req.session!.revokeSession();
    // highlight-end
    res.send("Success! User session revoked");
}
```

</ConditionalContent>

<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        // This will delete the session from the db and from the frontend (cookies)
        await session!.revokeSession();
        return NextResponse.json({ message: "Success! User session revoked" });
    });
}
```

</ConditionalContent>

</Tab>

<Tab value="nestjs">

```ts
// @ts-ignore

@Controller()
export class ExampleController {
  // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
  @Post('someapi')
  @UseGuards(new AuthGuard())
  async postSomeAPI(@Session() session: SessionContainer): Promise<string> {
    await session.revokeSession();

    return "Success! User session revoked";
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go
	err := sessionContainer.RevokeSession()
	if err != nil {
		err = supertokens.ErrorHandler(err, r, w)
		if err != nil {
			// TODO: Send 500 status code to client
		}
		return
	}

	// TODO: Send 200 response to client
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="fastapi">

```python
from supertokens_python.recipe.session.framework.fastapi import verify_session
from supertokens_python.recipe.session import SessionContainer
from fastapi import Depends
from fastapi.responses import PlainTextResponse

# highlight-start
async def some_api(session: SessionContainer = Depends(verify_session())):
    await session.revoke_session() # This will delete the session from the db and from the frontend (cookies)
    # highlight-end
    return PlainTextResponse(content='success')
```

</Tab>
<Tab value="flask">

```python
from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.recipe.session import SessionContainer
from flask import g

# highlight-start
@app.route('/some_api', methods=['POST']) # type: ignore
@verify_session()
def some_api():
    session: SessionContainer = g.supertokens # type: ignore

    session.sync_revoke_session() # This will delete the session from the db and from the frontend (cookies)
    # highlight-end
    return 'success'
```

</Tab>
<Tab value="django">

```python
from typing import cast

from django.http import HttpRequest

from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.framework.django.asyncio import verify_session

# highlight-start
@verify_session()
async def some_api(request: HttpRequest):
    session: SessionContainer = cast(SessionContainer, request.supertokens) # type: ignore This will delete the session from the db and from the frontend (cookies)
    # highlight-end
    await session.revoke_session()
```

</Tab>
</Tabs>

</Tab>
</Tabs>

:::info Tip

If you are using the pre-built UI, and the `<SessionAuth>` component set custom post log out logic with the `onSessionExpired` prop. 
The handler gets called if:
- The backend has revoked the session, but not the frontend.
- The user has been inactive for too long and their refresh token has expired.

```tsx
// @ts-ignore

const App = () => {
    return (
        <SessionAuth
            onSessionExpired={() => {/* ... */ }}>
            <MyComponent />
        </SessionAuth>
    );
}
```
:::

---

## Direct session invalidation

To invalidate a session without relying on the intervention of a user you can create your own custom methods using the backend SDKs.

:::caution
This method of revoking a session only deletes the session from the database and not from the frontend.
This implies that the user can still access protected endpoints while their access token is alive.
If you want to instantly logout the user in this mode, you should [enable access token blacklisting](/docs/post-authentication/session-management/advanced-workflows/access-token-blacklisting).
:::

### Revoke a specific session

<Tabs>
<Tab value="nodejs">

```tsx

async function revokeSession(sessionHandle: string) {
    let revoked = await Session.revokeSession(sessionHandle);
};
```
</Tab>
<Tab value="go">

```go

let app = express();

app.use("/revoke-all-user-sessions", async (req, res) => {

    let userId = req.body.userId
    // highlight-next-line
    await Session.revokeAllSessionsForUser(userId);

    res.send("Success! All user sessions have been revoked");
});
```
</Tab>
<Tab value="go">

```go

# Post Authentication - Session Management -  Share sessions across subdomains
Source: https://supertokens.com/docs/post-authentication/session-management/share-session-across-sub-domains

## Overview

Configure sharing sessions across multiple subdomains in SuperTokens by setting the `sessionTokenFrontendDomain` attribute of the Session recipe in your frontend code.

:::info Example
 - Your app has two subdomains `abc.example.com` and `xyz.example.com`. Assume that the user logs in via `example.com`
 - To enable sharing sessions across `example.com`, `abc.example.com` and `xyz.example.com`, set the `sessionTokenFrontendDomain` attribute to `.example.com`.
:::

## Steps

### 1. Update the frontend configuration



<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        // ...
        // this should be equal to the domain where the user will see the login UI
        apiDomain: "...",
        appName: "...",
        websiteDomain: "https://example.com"
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            sessionTokenFrontendDomain: ".example.com"
        })
    ]
});
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx

supertokensUIInit({
    appInfo: {
        // ...
        // this should be equal to the domain where the user will see the login UI
        apiDomain: "...",
        appName: "...",
        websiteDomain: "https://example.com"
    },
    recipeList: [
        supertokensUISession.init({
            // highlight-next-line
            sessionTokenFrontendDomain: ".example.com"
        })
    ]
});
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            // highlight-start
            sessionTokenFrontendDomain: ".example.com"
            // highlight-end 
        }),
    ],
})
```

</Tab>

</Tabs>

:::caution
- Do not set `sessionTokenFrontendDomain` to a value that's in the [public suffix list](https://publicsuffix.org/list/public_suffix_list.dat) (Search for your value without the leading dot). Otherwise, session management does not work.
- Do not set `sessionTokenFrontendDomain` to `.localhost` or an IP address based domain with a leading `.` since browsers reject these cookies. For local development, you should configure [your machine to use alias for `localhost`](https://superuser.com/questions/152146/how-to-alias-a-hostname-on-mac-osx).
:::

:::info Multi Tenancy

If each tenant belongs to one subdomain, and a user has access to more than one tenant, the tenant ID in the session is always the one from which they logged in.

For example, if a user has access to tenant `t1.example.com` and `t2.example.com`, and they logged in via `t1.example.com`, then the tenant ID in the session is always `t1`. This remains true even if they navigate to `t2.example.com` or make an API request from `t2.example.com`.

To solve this, add extra information about access token payload containing a list of all the tenants that the user has access to. Then read from that list instead of the `tId` claim.

:::

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            // highlight-start
            sessionTokenFrontendDomain: ".example.com"
            // highlight-end 
        }),
    ],
})
```

</Tab>
<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init({
            // ...
            // highlight-start
            sessionTokenFrontendDomain: ".example.com"
            // highlight-end
        })
    ],
})
```

</Tab>
</Tabs>

:::caution
- Do not set `sessionTokenFrontendDomain` to a value that's in the [public suffix list](https://publicsuffix.org/list/public_suffix_list.dat) (Search for your value without the leading dot). Otherwise, session management does not work.
- Do not set `sessionTokenFrontendDomain` to `.localhost` or an IP address based domain with a leading `.` since browsers reject these cookies. For local development, you should configure [your machine to use alias for `localhost`](https://superuser.com/questions/152146/how-to-alias-a-hostname-on-mac-osx).
:::

:::info Multi Tenancy

If each tenant belongs to one subdomain, and a user has access to more than one tenant, the tenant ID in the session is always the one from which they logged in.

For example, if a user has access to tenant `t1.example.com` and `t2.example.com`, and they logged in via `t1.example.com`, then the tenant ID in the session is always `t1`. This remains true even if they navigate to `t2.example.com` or make an API request from `t2.example.com`.

To solve this, add extra information about access token payload containing a list of all the tenants that the user has access to. Then read from that list instead of the `tId` claim.

:::

</Tab>

<Tab value="mobile">

:::caution
Not applicable
:::

</Tab>

</Tabs>

</CustomUIInstructions>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/authentication/unified-login/introduction" label="Unified Login" />
  <ReferenceCard href="/docs/authentication/enterprise/introduction" label="Multitenancy" />
  <ReferenceCard href="/docs/post-authentication/session-management/session-invalidation" label="Session Invalidation" />
  <ReferenceCard href="/docs/post-authentication/session-management/security" label="Session Security" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-api-routes" label="Backend Session Verification" />
  <ReferenceCard href="/docs/additional-verification/session-verification/protect-frontend-routes" label="Frontend Session Verification" />
</ReferenceCard.Grid>

# Post Authentication - Session Management -  Switch between cookie and header-based sessions
Source: https://supertokens.com/docs/post-authentication/session-management/switch-between-cookies-and-header-authentication

## Overview

SuperTokens supports 2 methods of authorizing requests.
The following guide shows you how to switch between them.

### Cookie based 
  - The default in the web SDKs
  - Uses [`HttpOnly` cookies](https://owasp.org/www-community/HttpOnly) by default to prevent token theft via XSS

### Header based
  - The default in the mobile SDKs
  - Uses the [`Authorization` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) with a [`Bearer` auth-scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#authentication_schemes)
  - This can make it easier to work with API gateways and third-party services
  - Preferable in mobile environments, since they can have buggy and/or unreliable cookie implementations

When creating or authorising sessions, the SDK has to choose to send the tokens to the frontend by cookies or custom headers.
The backend controls this choice, but it follows a preference set in the frontend configuration.

## Before you start

:::caution
We recommend cookie-based sessions in browsers because header-based sessions require saving the access and refresh tokens in storage vulnerable to XSS attacks.
:::

## Steps

### 1. Update the frontend configuration

You can provide a `tokenTransferMethod` property in the configuration of the Session recipe to set the preferred token transfer method. The backend receives this method with every request in the `st-auth-mode` header.
By default, the backend follows this preference.



<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            tokenTransferMethod: "header" // or "cookie"
        })
    ]
});
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUISession.init({
            // highlight-next-line
            tokenTransferMethod: "header" // or "cookie"
        })
    ]
});
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            tokenTransferMethod: "header" // or "cookie"
        })
    ],
})
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            tokenTransferMethod: "header" // or "cookie"
        })
    ],
})
```

</Tab>
<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init({
            // highlight-next-line
            tokenTransferMethod: "header" // or "cookie",
        })
    ],
})
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

SuperTokens.init({
    apiDomain: "...",
    tokenTransferMethod: "header", // or "cookie". "header" by default
});
```

</Tab>

<Tab value="android">

You can use the `tokenTransferMethod` builder method to set what mode the SDK should use for sessions.

```kotlin

</Tab>

<Tab value="ios">

```swift

void main() {
    SuperTokens.init(
        apiDomain: "...",
        tokenTransferMethod: SuperTokensTokenTransferMethod.COOKIE,
    );
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

### 2. Update the backend configuration {{optional}}

This step is optional.
You can force the backend to use a specific token transfer method regardless of the frontend configuration.

:::caution
**You should not set this on the backend if you have more than one client using different modes** (for example if you have a website that uses cookie based, and a mobile app that uses header based sessions).
:::

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-start
            getTokenTransferMethod: () => "header",
            // highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

# Post Authentication - Session Management - Advanced Workflows -  Implement anonymous sessions
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/anonymous-session

## Overview 

With anonymous sessions, you can keep track of user's action / data before they login, and then transfer that data to their post login session.

Anonymous sessions have different properties than regular, logged in sessions:
- The `userID` of anonymous sessions doesn't matter
- The security constraints on anonymous sessions are lesser than regular sessions, as you would want users to log in before doing anything sensitive anyway.
- Each visitor that visits your app / website gets an anonymous session if they don't have one previously. This does not require them to log in.
- Anonymous sessions are not stored in the database to avoid the risk of flooding the database with sessions that are not useful to the app.

Given the different characteristics of anonymous sessions, using a simple, long lived JWT is a perfect use case.
They can store any information about the user's activity, and they don't occupy any database space either.

## Steps

### 1. Create the JWT

Start by creating a JWT like in the next example:

<Tabs>
<Tab value="nodejs">

```tsx

async function createAnonymousJWT(payload: any) {
    let jwtResponse = await Session.createJWT({
        key: "value",
        // more payload...
    }, 315360000); // 10 years lifetime
    if (jwtResponse.status === "OK") {
        // Send JWT as Authorization header to M2
        return jwtResponse.jwt;
    }
    throw new Error("Unable to create JWT. Should never come here.")
}
```

</Tab>
<Tab value="go">

```go
The `verifySession` and `getSession` check for the presence of certain claims in the JWT (`sessionHandle`, `refreshTokenHash` etc...) that the Session recipe adds for authenticated users.
:::

### 3. Transfer the data to a logged in session

The idea here is to override the `Session` recipe on the `backend`. Whenever the user logs in or signs up, the data from the anonymous session transfers to the logged-in session.

The override attempts to read the request header cookie to get the JWT. It assumes that you have added it to the cookies, verifies it, and then adds the payload to the logged-in session.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // ...
        Session.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        createNewSession: async function (input) {
                            let userId = input.userId;

                            const request = SuperTokens.getRequestFromUserContext(input.userContext);

                            let jwt: string | undefined
                            let jwtPayload = {}

                            if (request !== undefined) {
                                jwt = request.getCookieValue("jwt");
                            } else {
                                /**
                                 * This is possible if the function is triggered from the user management dashboard
                                 * 
                                 * In this case because we cannot read the JWT, we create a session without the custom
                                 * payload properties
                                 */
                            }

                            if (jwt !== undefined) {
                                // verify JWT using a JWT verification library..

                                jwtPayload = { /* ... get from decoded jwt ... */};
                            }

                            // This goes in the access token, and is available to read on the frontend.
                            input.accessTokenPayload = {
                                ...input.accessTokenPayload,
                                ...jwtPayload
                            };

                            return originalImplementation.createNewSession(input);
                        },
                    };
                },
            },
            // highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go
                                    }

                                    // This goes in the access token, and is available to read on the frontend.
                                    if accessTokenPayload == nil {
                                        accessTokenPayload = map[string]interface{}{}
                                    }
                                    accessTokenPayload["someKey"] = decodedJWT["someKey"]
                                }
                            } else {
                                /**
                                * This is possible if the function is triggered from the user management dashboard
                                * 
                                * In this case because we cannot read the JWT, we create a session without the custom
                                * payload properties
                                */
                            }

							return originalCreateNewSession(userID, accessTokenPayload, sessionDataInDatabase, disableAntiCsrf, tenantId, userContext)
						}

						return originalImplementation
					},
				},
				// highlight-end
			}),
		},
	})
}
```
</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, get_request_from_user_context
from supertokens_python.recipe import session
from supertokens_python.recipe.session.interfaces import RecipeInterface
from typing import Any, Dict, Optional
from supertokens_python.types import RecipeUserId

def override_functions(original_implementation: RecipeInterface):
    original_implementation_create_new_session = (
        original_implementation.create_new_session
    )

    async def create_new_session(
        user_id: str,
        recipe_user_id: RecipeUserId,
        access_token_payload: Optional[Dict[str, Any]],
        session_data_in_database: Optional[Dict[str, Any]],
        disable_anti_csrf: Optional[bool],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):

        request = get_request_from_user_context(user_context)
        jwt: Optional[str] = None

        if request is not None:
            jwt = request.get_cookie("jwt")
        else:
            #
            # This is possible if the function is triggered from the user management dashboard
            #
            # In this case because we cannot read the JWT, we create a session without the custom
            # payload properties
            #
            jwt = None

        if jwt is not None:
            # verify JWT using a JWT verification library..
            jwt_payload = {
                # from JWT verification lib
            }

            # This goes in the access token, and is available to read on the frontend.
            if access_token_payload is None:
                access_token_payload = {}
            access_token_payload["someKey"] = jwt_payload["someKey"]

        return await original_implementation_create_new_session(
            user_id,
            recipe_user_id,
            access_token_payload,
            session_data_in_database,
            disable_anti_csrf,
            tenant_id,
            user_context,
        )

    original_implementation.create_new_session = create_new_session
    return original_implementation

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        session.init(
            # highlight-start
            override=session.InputOverrideConfig(functions=override_functions)
            # highlight-end
        )
    ],
)
```
</Tab>
</Tabs>

- In the above code snippet, the system reads the JWT from the request header cookie. If it exists, it verifies it and then adds the payload to the logged-in session.
- If the JWT doesn't exist, or if the system cannot verify it, it would be safe to ignore it and create the logged-in session anyway.
- We assume that the you have saved the JWT in the cookies in with the key of `jwt`.
But if not, you can remove the JWT from the request based on how you have saved it.
You can even read the headers from the request.

# Post Authentication - Session Management - Advanced Workflows -  Implement user impersonation
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/user-impersonation

## Overview

Impersonating a user allows you to login as them without using their credentials.
This is useful for testing purposes, or for customer support.

This guide shows you how to achieve this by only allowing a certain type of users, `admins`, to perform the impersonation.

## Before you start

:::caution
Since this feature allows you to login as any user in your application, only admins or custom support staff should use it.
You can use any method to protect this API. (API Key, specific user roles, IP address validation, etc.)
:::

## Steps

### 1. Create the impersonation endpoint

Create a new API endpoint that accepts some form of identifier (email, phone number, user ID, etc.) and creates a new impersonation session for that user.

In order for this to work, admins need to first log in to the application as themselves. Once they create their session (like any regular user's session), they can call the API via a frontend UI that's only shown to them. You can detect the admin role on the frontend by seeing [this guide](/docs/additional-verification/user-roles/protecting-routes#protecting-frontend-routes).

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post(
    "/impersonate", 
    verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => [
            ...globalValidators,
            UserRoles.UserRoleClaim.validators.includes("admin")
        ],
    }),
    async (req, res) => {

    let email = "..."; // read from request body

    let user = await supertokens.listUsersByAccountInfo("public", {
        email
    });

    if (user.length === 0) {
        throw new Error("User does not exist");
    }

    await Session.createNewSession(req, res, "public", user[0].loginMethods[0].recipeUserId, {
        isImpersonation: true,
    });

    res.json({ message: "Impersonation successful!" });
})
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/impersonate",
    method: "post",
    options: {
        pre: [
            {
                method: verifySession({
                    overrideGlobalClaimValidators: async (globalValidators) => [
                        ...globalValidators,
                        UserRoles.UserRoleClaim.validators.includes("admin")
                    ],
                }),
            },
        ],
    },
    handler: async (req, res) => {

        let email = "..."; // read from request body

        let user = await supertokens.listUsersByAccountInfo("public", {
            email
        });

        if (user.length === 0) {
            throw new Error("User does not exist");
        }

        await Session.createNewSession(req, res, "public", user[0].loginMethods[0].recipeUserId, {
            isImpersonation: true,
        });

        return res.response({ message: "Impersonation successful!" }).code(200);
    },
});
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post(
    "/impersonate",
    {
        preHandler: verifySession({
            overrideGlobalClaimValidators: async (globalValidators) => [
                ...globalValidators,
                UserRoles.UserRoleClaim.validators.includes("admin")
            ],
        }),
    },
    async (req, res) => {

    let email = "..."; // read from request body

    let user = await supertokens.listUsersByAccountInfo("public", {
        email
    });

    if (user.length === 0) {
        throw new Error("User does not exist");
    }

    await Session.createNewSession(req, res, "public", user[0].loginMethods[0].recipeUserId, {
        isImpersonation: true,
    });

    res.send({ message: "Impersonation successful!" });
})
```

</Tab>
<Tab value="awsLambda">

```tsx

async function impersonate(awsEvent: SessionEvent) {
    let email = "..."; // read from request body

    let user = await supertokens.listUsersByAccountInfo("public", {
        email
    });

    if (user.length === 0) {
        throw new Error("User does not exist");
    }

    await Session.createNewSession(awsEvent, awsEvent, "public", user[0].loginMethods[0].recipeUserId, {
        isImpersonation: true,
    });

    return {
        body: JSON.stringify({ message: "Impersonation successful!" }),
        statusCode: 200,
    };
}

exports.handler = verifySession(impersonate, {
    overrideGlobalClaimValidators: async (globalValidators) => ([
        ...globalValidators, 
        UserRoles.UserRoleClaim.validators.includes("admin")
    ])
});
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post(
    "/impersonate",
    verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => ([
            ...globalValidators, 
            UserRoles.UserRoleClaim.validators.includes("admin")
        ])
    }), 
    async (ctx, next) => {
    let email = "..."; // read from request body

    let user = await supertokens.listUsersByAccountInfo("public", {
        email
    });

    if (user.length === 0) {
        throw new Error("User does not exist");
    }

    await Session.createNewSession(ctx, ctx, "public", user[0].loginMethods[0].recipeUserId, {
        isImpersonation: true,
    });

    ctx.body = { message: "Impersonation successful!" };
})
```

</Tab>
<Tab value="loopback">

```tsx

class Login {
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/impersonate")
    @intercept(verifySession({
        overrideGlobalClaimValidators: async (globalValidators) => ([
            ...globalValidators, 
            UserRoles.UserRoleClaim.validators.includes("admin")
        ])
    }))
    @response(200)
    async handler() {
        let email = "..."; // read from request body

        let user = await supertokens.listUsersByAccountInfo("public", {
            email
        });

        if (user.length === 0) {
            throw new Error("User does not exist");
        }

        await Session.createNewSession(this.ctx, this.ctx, "public", user[0].loginMethods[0].recipeUserId, {
            isImpersonation: true,
        });
        return { message: "Impersonation successful!" };
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function impersonate(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({
                overrideGlobalClaimValidators: async (globalValidators) => ([
                    ...globalValidators, 
                    UserRoles.UserRoleClaim.validators.includes("admin")
                ])
            })(req, res, next);
        },
        req,
        res
    )

    let email = "..."; // read from request body

    let user = await supertokens.listUsersByAccountInfo("public", {
        email
    });

    if (user.length === 0) {
        throw new Error("User does not exist");
    }

    await superTokensNextWrapper(
        async (next) => {
            await createNewSession(req, res, "public", user[0].loginMethods[0].recipeUserId, {
                isImpersonation: true,
            });
        },
        req,
        res
    );
    res.json({
        message: "Impersonation successful!"
    });
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(req: NextRequest) {
    return withPreParsedRequestResponse(req, async (baseRequest: PreParsedRequest, baseResponse: CollectingResponse) => {
        let email = "..."; // read from request body

        let users = await SuperTokens.listUsersByAccountInfo("public", { email });

        if (users.length === 0) {
            throw new Error("User does not exist");
        }

        const session = await createNewSession(baseRequest, baseResponse, "public", users[0].loginMethods[0].recipeUserId, {
            isImpersonation: true,
        });

        return NextResponse.json({ message: "Impersonation successful" });
    });

    
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```ts
// @ts-ignore

@Controller()
export class ExampleController {
  // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
  @Post("impersonate")
  @UseGuards(new AuthGuard({
    overrideGlobalClaimValidators: async (globalValidators: SessionClaimValidator[]) => ([
        ...globalValidators, 
        UserRoles.UserRoleClaim.validators.includes("admin")
    ])
  }))
  async postLogin(@Req() req: Request, @Res() res: Response): Promise<{ message: string }> {
    let email = "..."; // read from request body

    let user = await supertokens.listUsersByAccountInfo("public", {
        email
    });

    if (user.length === 0) {
        throw new Error("User does not exist");
    }

    await createNewSession(req, res, "public", user[0].loginMethods[0].recipeUserId, {
        isImpersonation: true,
    });

    return { message: "Impersonation successful!" };
  }
}
```

</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

	// we are using emailpassword recipe here, but you can use the recipe you use
	// as well..
	user, err := emailpassword.GetUserByEmail("public", email)
	if err != nil {
		// Send 500 to client
		return
	}

	if user == nil {
		// Send 400 to client cause user does not exist
		return
	}

	_, err = session.CreateNewSession(r, w, "public", user.ID, map[string]interface{}{
		"isImpersonation": true,
	}, nil)
	if err != nil {
		err = supertokens.ErrorHandler(err, r, w)
		if err != nil {
			// Send 500 to client
		}
		return
	}

	// Send 200 success to client
}
```

</Tab>
<Tab value="python">

<Tabs>
<Tab value="fastapi">

```python
from fastapi import Depends, Request
from fastapi.responses import JSONResponse

from supertokens_python.asyncio import list_users_by_account_info
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.asyncio import create_new_session
from supertokens_python.recipe.session.framework.fastapi import verify_session
from supertokens_python.recipe.userroles import UserRoleClaim
from supertokens_python.types.base import AccountInfoInput

@app.post("/impersonate")  # type: ignore
async def impersonate(
    request: Request,
    session: SessionContainer = Depends(
        verify_session(
            # We add the UserRoleClaim's includes validator
            override_global_claim_validators=lambda global_validators,
            session,
            user_context: global_validators
            + [UserRoleClaim.validators.includes("admin")]
        )
    ),
):
    email = "..."  # get from request body

    # we use the email password recipe here, but you can use the recipe you use
    user = await list_users_by_account_info("public", AccountInfoInput(email=email))

    if len(user) == 0:
        # return a 400 error to the client
        return

    await create_new_session(
        request,
        "public",
        user[0].login_methods[0].recipe_user_id,
        {"isImpersonation": True},
    )

    return JSONResponse({"message": "Impersonation complete!"})

```

</Tab>
<Tab value="flask">

```python
from flask import jsonify
from flask.wrappers import Request

from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.recipe.session.syncio import create_new_session
from supertokens_python.recipe.userroles import UserRoleClaim
from supertokens_python.syncio import list_users_by_account_info
from supertokens_python.types.base import AccountInfoInput

@app.route("/impersonate", methods=["POST"])  # type: ignore
@verify_session(
    # We add the UserRoleClaim's includes validator
    override_global_claim_validators=lambda global_validators,
    session,
    user_context: global_validators + [UserRoleClaim.validators.includes("admin")]
)
def login(request: Request):
    email = "..."  # get from request body

    # we use the email password recipe here, but you can use the recipe you use
    user = list_users_by_account_info("public", AccountInfoInput(email=email))

    if len(user) == 0:
        # return a 400 error to the client
        return

    create_new_session(
        request,
        "public",
        user[0].login_methods[0].recipe_user_id,
        {"isImpersonation": True},
    )

    return jsonify({"message": "Impersonation complete!"})

```

</Tab>
<Tab value="django">

```python
from django.http import HttpRequest, JsonResponse

from supertokens_python.asyncio import list_users_by_account_info
from supertokens_python.recipe.session.asyncio import create_new_session
from supertokens_python.recipe.session.framework.django.asyncio import verify_session
from supertokens_python.recipe.userroles import UserRoleClaim
from supertokens_python.types.base import AccountInfoInput

@verify_session(
    # We add the UserRoleClaim's includes validator
    override_global_claim_validators=lambda global_validators,
    session,
    user_context: global_validators + [UserRoleClaim.validators.includes("admin")]
)
async def impersonate(request: HttpRequest):
    email = "..."  # get from request body

    # we use the email password recipe here, but you can use the recipe you use
    user = await list_users_by_account_info("public", AccountInfoInput(email=email))

    if len(user) == 0:
        # return a 400 error to the client
        return

    await create_new_session(
        request,
        "public",
        user[0].login_methods[0].recipe_user_id,
        {"isImpersonation": True},
    )

    return JsonResponse({"message": "User logged in!"})

```

</Tab>
</Tabs>
</Tab>
</Tabs>

:::info Multi Tenancy
Notice that the `"public"` `tenantId` goes to the function call above. This is the default `tenantId` in SuperTokens. If you are using the multi-tenancy feature and want to login into a different tenant, you can replace `"public"` with the `tenantId` you want to login into.

You can fetch this `tenantId` based on the admin user's tenant (from their session), or you can pass it in the request body.
:::

- The API should call from your frontend application such that the frontend SDKs' network interceptors are running.
- In the API above, session verification runs first to ensure that the user has the admin role. If not, the API returns a `403` to the frontend.
- The target user is then fetched based on their email ID. If the user does not exist, an error occurs (which you can map to a `400` status code).
- A new session is then created using the target user's user ID. The `isImpersonation` flag goes as `true` in the access token payload to detect this on the frontend and show a message to the admin user that they are impersonating the target user (this is UI you would have to build if you want to). You can also use this custom access token payload to protect certain APIs which the admin cannot call, even if in impersonation mode. In the code, you use `isImpersonation`, but you can use anything else you like. In fact, you can even add the admin user's user ID to the access token payload (with a key like `adminUserId`), for logging purposes.
- The new session tokens attach to the response and overwrite the existing admin session. Cookies apply if the request contains the `st-auth-mode: "cookie"` header, otherwise the mode is header-based auth. Since you would be calling this API via the frontend interceptors, you do not need to explicitly set this header since the frontend SDK does this on its own.
- Once impersonated, the admin user can logout of the target user's session by clicking on the sign out button of your app - nothing special needs to happen there.

# Post Authentication - Session Management - Advanced Workflows -  Customize error handling
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/customize-error-handling

## Overview

The following page shows the errors that the SuperTokens Session recipe throws and how you can customize them.

---

## Unauthorised error

The system generates the error when someone accesses a protected backend API without a session.
The default behavior is to clear session tokens (if any) and send a 401 to the frontend.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            errorHandlers: {
                onUnauthorised: async (message, request, response, userContext) => {
                    // TODO: Write your own logic and then send a 401 response to the frontend
                },
            }
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            errorHandlers: {
                onInvalidClaim: async (validatorErrors, request, response, userContext) => {
                    // TODO: Write your own logic and then send a 403 response to the frontend
                },
            }
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            errorHandlers: {
                onTokenTheftDetected: async (sessionHandle, userId, req, res, userContext) => {
                    // TODO: Write your own logic and then send a 401 response to the frontend
                },
            }
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            errorHandlers: {
                onTryRefreshToken: async (message, request, response, userContext) => {
                    // TODO: Write your own logic and then send a 401 response to the frontend
                },
            }
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go
The default behavior is to send a 200 to the frontend.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-start
            errorHandlers: {
                onClearDuplicateSessionCookies: async (message, request, response, userContext) => {
                    // TODO: Write your own logic and then send a 200 response to the frontend
                },
            }
            //highlight-end
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

# Post Authentication - Session Management - Advanced Workflows -  Work with multiple API endpoints
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/multiple-api-endpoints

## Overview

To enable use of sessions for multiple API endpoints, you need to update the configuration on both the frontend and backend.

## Before you start

- All your API endpoints must have the same top level domain.
For example, they can be `{"api.example.com", "api2.example.com"}`, but they cannot be `{"api.example.com", "api.otherdomain.com"}`.
- Perform the backend configuration steps only if you are using cookie-based authentication.
If using header based auth, please skip to step 3.

## Steps

### 1. Set the cookie domain in the backend configuration

:::caution no-title
This step is only applicable for cookie based authentication.
:::

Set the `cookieDomain` value to be the common top level domain.
For example, if your API endpoints are `{"api.example.com", "api2.example.com", "api3.example.com"}`, the common portion of these endpoints is `".example.com"` (The dot is important). You would need to set the following:

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            cookieDomain: ".example.com",
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            cookieDomain: ".example.com",
            // highlight-next-line
            olderCookieDomain: "" // Set to an empty string if your previous cookieDomain was unset. Otherwise, use your old cookieDomain value.
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

- Keep the value set for `olderCookieDomain` for 1 year because the cookie lifetime of the access token on the frontend is 1 year (even though the JWT expiry is a few hours).

- If you have changed the `cookieDomain` more than once within one year, to prevent a stuck state, switch to [header-based auth](https://supertokens.com/docs/session/common-customizations/sessions/token-transfer-method#backend-configuration-optional) for all your clients. The important thing here is that you have to set the backend configuration to header even though that doc says it's optional. This ensures that all clients use header-based auth.

- Changing the `cookieDomain` can cause a temporary spike in requests, even if you set the `olderCookieDomain` correctly. This happens because older sessions, with older cookie domain, require additional refresh calls to clear their old cookies and set new ones. This spike is a one-time event and should not recur after the update.
:::

:::info
Set the `olderCookieDomain` value to prevent clients from having multiple session cookies from different domains. This can happen when cookies from a previous domain are still valid and sent with requests. For instance, if your previous `cookieDomain` was `api.example.com` and the new one is `.example.com`, both sets of cookies would send to the `apiDomain` `api.example.com`, leading to an inconsistent state. This can cause issues until you clear the older cookies. Setting `olderCookieDomain` in the configuration ensures that the SuperTokens SDK can automatically remove these older cookies.
:::

### 3. Update the frontend configuration 

Set the same value for `sessionTokenBackendDomain` on the frontend.
This allows the frontend SDK to apply interception and automatic refreshing across all your API calls:



<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-next-line 
            sessionTokenBackendDomain: ".example.com"
        })
    ]
});
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.
```tsx

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUISession.init({
            // highlight-next-line 
            sessionTokenBackendDomain: ".example.com"
        })
    ]
});
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            sessionTokenBackendDomain: ".example.com"
        }),
    ],
});
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            sessionTokenBackendDomain: ".example.com"
        }),
    ],
});
```

</Tab>
<Tab value="scripts">

```tsx
supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init({
            sessionTokenBackendDomain: ".example.com",
        })
    ],
});
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

SuperTokens.init({
    apiDomain: "...",
    sessionTokenBackendDomain: ".example.com"
});
```

</Tab>

<Tab value="android">

```kotlin

void initialiseSuperTokens() {
    SuperTokens.init(
        apiDomain: "...",
        sessionTokenBackendDomain: ".example.com",
    );
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

# Post Authentication - Session Management - Advanced Workflows -  Disable frontend network interceptors
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/disable-frontend-interceptors

## Overview

SuperTokens frontend SDKs add interceptors to networking libraries to:
- Enable auto refreshing of session tokens.
- Auto adding of the right request headers (Authorization header in case of header based auth, or the anti-csrf headers in case of cookie based auth).
- Setting `credentials: true` for cookie based auth to ensure the browser adds session cookies.

Whilst this helps for greenfield projects, for existing projects, you may want to disable this interception for your API calls. Take control of how you want to attach session tokens to the request yourself. You can do this as follows:

## Steps

### 1. Update the frontend configuration



<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("/auth")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUISession.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("/auth")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("/auth")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>
<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("/auth")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>
<Tab value="scripts">

```tsx
supertokensSession.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("/auth")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

You can use the `doesSessionExist` function to check if a session exists.

```tsx

SuperTokens.init({
    apiDomain: "...",
    override: {
        functions: (oI) => {
            return {
                ...oI,
                shouldDoInterceptionBasedOnUrl: (url, apiDomain, sessionTokenBackendDomain) => {
                    try {
                        let urlObj = new URL(url);
                        if (!urlObj.pathname.startsWith("/auth")) {
                            return false;
                        }
                    } catch (ignored) { }
                    return oI.shouldDoInterceptionBasedOnUrl(url, apiDomain, sessionTokenBackendDomain);
                }
            }
        }
    }
})
```

</Tab>

<Tab value="android">

:::note
At the moment this feature is not supported through the Android SDK.
:::

</Tab>

<Tab value="ios">

:::note
At the moment this feature is not supported through the iOS SDK.
:::

</Tab>

<Tab value="flutter">

:::note
At the moment this feature is not supported through the Flutter SDK.
:::

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

In the code above, the `shouldDoInterceptionBasedOnUrl` function is overridden to only allow interception for all API calls that start with `/auth` in their path. This ensures that API calls made from frontend SDKs (like sign out) continue to use the session tokens as expected by backend APIs. It also allows you to take control of how you want to attach session tokens to your own API calls (ones that have a path that don't start with `/auth`).

If you want to also change how session tokens attach to API calls (like sign out), you can return `false` from the function override. Then, attach custom session headers using the [pre-API hook function](/docs/references/frontend-sdks/hooks#pre-api-hook) on the frontend.

# Post Authentication - Session Management - Advanced Workflows -  Usage inside an iframe
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/in-iframe

## Overview

If your website can embed in an iframe that other websites consume, update your configuration based on this guide.

## Before you start

If the sites where your iframe can embed share the same top-level domain as the iframe domain, then you can ignore this section.

## Steps

### 1. Update the frontend configuration

- Set `isInIframe` to `true` during `Session.init` on the frontend.
- You need to use `https` during testing / `dev` for this to work. You can use tools like [ngrok](https://ngrok.com/) to create a `dev` `env` with `https` on your website / API domain.
- Switch to using header based auth
- Provide a custom `windowHandler` and a custom `cookieHandler` to ensure that the app works on safari and chrome incognito. These handlers switch from using `document.cookies` to `localstorage` to store tokens on the frontend (since safari doesn't allow access to `document.cookies` in iframes), and use in-memory storage for chrome incognito (since chrome incognito doesn't even allow access to `localstorage`). You can find implementations of these handlers [here (`windowHandler`)](https://github.com/SuperTokens/supertokens-auth-react/blob/master/examples/with-next-iframe/config/windowHandler.js) and [here (`cookieHandler`)](https://github.com/SuperTokens/supertokens-auth-react/blob/master/examples/with-next-iframe/config/cookieHandler.js).



<PrebuiltUIInstructions>

<Tabs>

<Tab value="reactjs">

```tsx
declare let cookieHandler: any // REMOVE_FROM_OUTPUT
declare let windowHandler: any // REMOVE_FROM_OUTPUT

SuperTokens.init({
    cookieHandler,
    windowHandler,
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-start
            tokenTransferMethod: "header",
            isInIframe: true
            // highlight-end
        })
    ]
});
```

</Tab>

<Tab value="angular">

You need to make changes to the auth route configuration, as well as to the `supertokens-web-js` SDK configuration at the root of your application:

This change is in your auth route configuration.

```tsx
declare let cookieHandler: any // REMOVE_FROM_OUTPUT
declare let windowHandler: any // REMOVE_FROM_OUTPUT

supertokensUIInit({
    cookieHandler,
    windowHandler,
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUISession.init({
            // highlight-start
            tokenTransferMethod: "header",
            isInIframe: true
            // highlight-end
        })
    ]
});
```

This change goes in the `supertokens-web-js` SDK configuration at the root of your application:

```tsx
declare let cookieHandler: any // REMOVE_FROM_OUTPUT
declare let windowHandler: any // REMOVE_FROM_OUTPUT

SuperTokens.init({
    cookieHandler,
    windowHandler,
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            // highlight-start
            tokenTransferMethod: "header",
            isInIframe: true
            // highlight-end
        })
    ],
})
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx
declare let cookieHandler: any // REMOVE_FROM_OUTPUT
declare let windowHandler: any // REMOVE_FROM_OUTPUT

SuperTokens.init({
    cookieHandler,
    windowHandler,
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        Session.init({
            // highlight-start
            tokenTransferMethod: "header",
            isInIframe: true
            // highlight-end
        })
    ],
})
```

</Tab>
<Tab value="scripts">

```tsx
declare let cookieHandler: any // REMOVE_FROM_OUTPUT
declare let windowHandler: any // REMOVE_FROM_OUTPUT
supertokens.init({
    cookieHandler,
    windowHandler,
    appInfo: {
        apiDomain: "...",
        appName: "...",
    },
    recipeList: [
        supertokensSession.init({
            // highlight-start
            tokenTransferMethod: "header",
            isInIframe: true
            // highlight-end
        })
    ],
})
```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

:::caution
Not applicable to mobile apps
:::

</Tab>

</Tabs>

</CustomUIInstructions>

:::caution
Because of the restrictions on access to storage on Chrome incognito, you must use in-memory storage to store the tokens on the frontend. This in turn implies that if the user refreshes the page, or if your app does a full page navigation, the user logs out.
:::

# Post Authentication - Session Management - Advanced Workflows -  Blacklist access tokens
Source: https://supertokens.com/docs/post-authentication/session-management/advanced-workflows/access-token-blacklisting

## Overview

By default, session verification is stateless.
This means that SuperTokens does not check that the session actually exists in the database, and only verifies the session by checking its signature.
Whilst this makes session verifications fast, it also means that if you revoke a session, the user can still use it until the access token expires.

If you want session verifications to fail immediately after revoking the session, you should force the session to check against the database.
Since you can use this feature on a per API basis, we recommend that you only use it for non-GET APIs since only those are state changing.

## Before you start

:::caution
For managed service users, please check [the rate limit policy](/docs/deployment/rate-limits) before implementing this feature. If you suspect that you might breach the free limit you can:
- [Email support](mailto:support@supertokens.com) to increase your rate limit.
- Use the `checkDatabase` flag only on certain important APIs. For example, omit using it in any `GET` API as those are not state changing.
- Implement your own method for keeping track of revoked access tokens by using a cache like Redis.
:::

---

## Using `Verify Session` 

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

// highlight-start
app.post("/like-comment", verifySession({ checkDatabase: true }), (req: SessionRequest, res) => {
    let userId = req.session!.getUserId();
    // highlight-end
    //....
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",
    //highlight-start
    options: {
        pre: [
            {
                method: verifySession({ checkDatabase: true })
            },
        ],
    },
    handler: async (req: SessionRequest, res) => {
        let userId = req.session!.getUserId();
        //highlight-end
        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

//highlight-start
fastify.post("/like-comment", {
    preHandler: verifySession({ checkDatabase: true }),
}, (req: SessionRequest, res) => {
    let userId = req.session!.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function likeComment(awsEvent: SessionEventV2) {
    let userId = awsEvent.session!.getUserId();
    //....
};

//highlight-next-line
exports.handler = verifySession(likeComment, { checkDatabase: true });
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

//highlight-start
router.post("/like-comment", verifySession({ checkDatabase: true }), (ctx: SessionContext, next) => {
    let userId = ctx.session!.getUserId();
    //highlight-end
    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

class LikeComment {
    //highlight-start
    constructor(@inject(RestBindings.Http.CONTEXT) private ctx: MiddlewareContext) { }
    @post("/like-comment")
    @intercept(verifySession({ checkDatabase: true }))
    @response(200)
    handler() {
        let userId = (this.ctx as SessionContext).session!.getUserId();
        //highlight-end
        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

// highlight-start
export default async function likeComment(req: SessionRequest, res: any) {
    await superTokensNextWrapper(
        async (next) => {
            await verifySession({ checkDatabase: true })(req, res, next);
        },
        req,
        res
    )

    let userId = req.session!.getUserId();
    // highlight-end
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        let userId = session!.getUserId();
        //....
        return NextResponse.json({})
    }, { checkDatabase: true });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard({ checkDatabase: true })) // For more information about this guard please read our NestJS guide.
  async postExample(@Session() session: SessionContainer): Promise<boolean> {
    //highlight-start
    let userId = session.getUserId();

    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">
<Tabs>
<Tab value="HTTP">

```go

let app = express();

app.post("/like-comment", async (req, res, next) => {
    try {
        let session = await Session.getSession(req, res, { checkDatabase: true })

        if (session !== undefined) {
            let userId = session.getUserId();
        } else {
            // user is not logged in...
        }
        //....
    } catch (err) {
        next(err);
    }
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/like-comment",
    method: "post",

    handler: async (req, res) => {
        let session = await Session.getSession(req, res, { checkDatabase: true })

        if (session !== undefined) {
            let userId = session.getUserId();
        } else {
            // user is not logged in...
        }

        //...
    }
})
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post("/like-comment", async (req, res) => {
    let session = await Session.getSession(req, res, { checkDatabase: true })

    if (session !== undefined) {
        let userId = session.getUserId();
    } else {
        // user is not logged in...
    }
    //....
});
```

</Tab>
<Tab value="awsLambda">

```tsx

async function likeComment(awsEvent: SessionEvent) {
    let session = await Session.getSession(awsEvent, awsEvent, { checkDatabase: true })

    if (session !== undefined) {
        let userId = session.getUserId();
    } else {
        // user is not logged in...
    }

    //....
};

//highlight-next-line
exports.handler = middleware(likeComment);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/like-comment", async (ctx, next) => {
    let session = await Session.getSession(ctx, ctx, { checkDatabase: true })

    if (session !== undefined) {
        let userId = session.getUserId();
    } else {
        // user is not logged in...
    }

    //....
});
```

</Tab>
<Tab value="loopback">

```tsx

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, { checkDatabase: true })

        if (session !== undefined) {
            let userId = session.getUserId();
        } else {
            // user is not logged in...
        }

        //....
    }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function likeComment(req: SessionRequest, res: any) {
    let session = await superTokensNextWrapper(
        async (next) => {
            return await Session.getSession(req, res, { checkDatabase: true });
        },
        req,
        res
    )

    if (session !== undefined) {
        let userId = session.getUserId();
    } else {
        // user is not logged in...
    }
    //....
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        let userId = session!.getUserId();
        //....
        return NextResponse.json({})
    }, { checkDatabase: true });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx

@Controller()
export class ExampleController {
  @Post('example')
  async postExample(@Req() req: Request, @Res({ passthrough: true }) res: Response): Promise<boolean> {
    //highlight-start
    // This should be done inside a parameter decorator, for more information please read our NestJS guide.
    const session = await Session.getSession(req, res, { checkDatabase: true })

    if (session !== undefined) {
      const userId = session.getUserId();
    } else {
      // user is not logged in...
    }
    //highlight-end
    //....
    return true;
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

# Post Authentication - Session Management -  Session security
Source: https://supertokens.com/docs/post-authentication/session-management/security

## Overview

The following page takes you through some common security considerations that the **SuperTokens** `Session` recipe handles.

---

## Anti-csrf

CSRF attacks can happen if a logged in user visits a malicious website which makes an API call to your website's API to maliciously change that user's data.
To protect against this attack, the cookie `sameSite` attribute works along with some anti-csrf measures.
This attribute declares if your cookies should restrict to a first-party or same-site context.
Configuring `sameSite` can prevent CSRF attacks.

For example, if `sameSite` is `lax`, the browser only sends cookies for requests that originate from the same top level domain as the API's domain.
If a user visits a malicious site, requests from those sites do not have the session cookies.

### Configure anti-csrf

:::caution
- SuperTokens automatically defends against CSRF attacks.
- Please only change this setting if you know what you are doing. If you are unsure, please feel free to [ask questions](https://supertokens.com/discord).
- This setting does not apply while using header-based authentication, since they get the same protection as `antiCsrf` set to `VIA_CUSTOM_HEADER`.
:::

You can change the `antiCsrf` configuration option to take control of the kind of protection you get.
You can use on of the following values:

- `"NONE"` would disable any anti-csrf protection from our end.
You can use this if you have an implementation of CSRF protection.
- `"VIA_CUSTOM_HEADER"` uses [this method](https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html#use-of-custom-request-headers) to prevent CSRF protection.
This sets automatically if `sameSite` is `none` or if your `apiDomain` and `websiteDomain` do not share the same top level domain name.
- `"VIA_TOKEN"` uses an explicit anti-csrf token.
Use this method if you want to allow any origin to query your APIs.
This method may cause issues in browsers like Safari, especially if your site embeds as an `iframe`.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            antiCsrf: "VIA_CUSTOM_HEADER",  // Should be one of "NONE" or "VIA_CUSTOM_HEADER" or "VIA_TOKEN"
        })
    ]
});
```
</Tab>
<Tab value="go">

```go
The ``sameSite`` cookie attribute declares if your cookies should restrict to a first-party or same-site context.
The ``sameSite`` attribute can have three possible values:
- ``none``
  - Cookies attach in all contexts, that is, cookies attach to both first-party and cross-origin requests.
  - On Safari however, if third-party cookies do not work (which is the default behavior), and the website and `API` domains do not share the same top-level domain, then cookies do not go. Please check [the session management page](/docs/post-authentication/session-management/switch-between-cookies-and-header-authentication) to see how you can switch to using headers.
- ``lax``
  - Cookies are only sent in a first-party context and along with `GET` requests initiated by third party websites (that result in browser navigation - user clicking on a link).
- ``strict``
  - Cookies are only sent in a first-party context and not sent along with requests initiated by third party websites.

### Configuration

:::caution
- SuperTokens automatically sets the value of the ``sameSite`` cookie attribute based on your website and `API` domain configuration.
- Please only change this setting if you are a web security expert. If you are unsure, please feel free to [ask questions](https://supertokens.com/discord).
:::

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-next-line
            cookieSameSite: "strict", // Should be one of "strict" or "lax" or "none"
        }),
    ],
});
```

</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-next-line
            cookieSecure: true,
        })
    ]
});
```
</Tab>
<Tab value="go">

```go

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            //highlight-next-line
            useDynamicAccessTokenSigningKey: false,
        })
    ]
});
```

:::caution
Updating this value causes a spike in the session refresh API, as and when users visit your application.
:::

</Tab>
<Tab value="go">

```go

# Post Authentication - User Management -  User management actions
Source: https://supertokens.com/docs/post-authentication/user-management/common-actions

## Overview

**SuperTokens** exposes a set of functions and APIs that you can use to have manual control over your users. 
Actions like fetching users or deleting them are available through different SDK calls.

---

## Get user 

### By email

<Tabs>
<Tab value="nodejs">

```tsx

async function getUserInfo() {
    let usersInfo = await supertokens.listUsersByAccountInfo("public", {
        email: "test@example.com"
    });

    /**
     * 
     * userInfo contains the following info:
     * - emails
     * - id
     * - timeJoined
     * - tenantIds
     * - phone numbers
     * - third party login info
     * - all the login methods associated with this user.
     * - information about if the user's email is verified or not.
     * 
    */
}
```

</Tab>

<Tab value="go">

```go

async function handler() {
    let usersInfo = await supertokens.listUsersByAccountInfo("public", {
        phoneNumber: "+1234567890"
    });

    /**
     * 
     * userInfo contains the following info:
     * - emails
     * - id
     * - timeJoined
     * - tenantIds
     * - phone numbers
     * - third party login info
     * - all the login methods associated with this user.
     * - information about if the user's email is verified or not.
     * 
    */
}
```

</Tab>

<Tab value="go">

```go

let app = express();
app.get("/get-user-info", verifySession(), async (req: SessionRequest, res) => {
    let userId = req.session!.getUserId();
    
    // highlight-next-line
    let userInfo = await supertokens.getUser(userId)

    /**
     * 
     * userInfo contains the following info:
     * - emails
     * - id
     * - timeJoined
     * - tenantIds
     * - phone numbers
     * - third party login info
     * - all the login methods associated with this user.
     * - information about if the user's email is verified or not.
     * 
    */
})
```
</Tab>

<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
    path: "/get-user-info",
    method: "get",
    options: {
        pre: [
            {
                method: verifySession()
            },
        ],
    },
    // @ts-ignore
    handler: async (req: SessionRequest, res) => {
        let userId = req.session!.getUserId();

        // highlight-next-line
        let userInfo = await supertokens.getUser(userId)

        /**
        * 
        * userInfo contains the following info:
        * - emails
        * - id
        * - timeJoined
        * - tenantIds
        * - phone numbers
        * - third party login info
        * - all the login methods associated with this user.
        * - information about if the user's email is verified or not.
        * 
        */
    }
})
```

</Tab>

<Tab value="fastify">

```tsx

const fastify = Fastify();

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

    // highlight-next-line
    let userInfo = await supertokens.getUser(userId)

    /**
    * 
    * userInfo contains the following info:
    * - emails
    * - id
    * - timeJoined
    * - tenantIds
    * - phone numbers
    * - third party login info
    * - all the login methods associated with this user.
    * - information about if the user's email is verified or not.
    * 
    */
});
```

</Tab>

<Tab value="awsLambda">

```tsx

async function getUserInfo(awsEvent: SessionEvent) {
    let userId = awsEvent.session!.getUserId();
    
    // highlight-next-line
    let userInfo = await supertokens.getUser(userId)

    /**
    * 
    * userInfo contains the following info:
    * - emails
    * - id
    * - timeJoined
    * - tenantIds
    * - phone numbers
    * - third party login info
    * - all the login methods associated with this user.
    * - information about if the user's email is verified or not.
    * 
    */
};

exports.handler = verifySession(getUserInfo);
```

</Tab>

<Tab value="koa">

```tsx

let router = new KoaRouter();

router.get("/get-user-info", verifySession(), async (ctx: SessionContext, next) => {
    let userId = ctx.session!.getUserId();
    
    // highlight-next-line
    let userInfo = await supertokens.getUser(userId)

    /**
    * 
    * userInfo contains the following info:
    * - emails
    * - id
    * - timeJoined
    * - tenantIds
    * - phone numbers
    * - third party login info
    * - all the login methods associated with this user.
    * - information about if the user's email is verified or not.
    * 
    */
});
```

</Tab>

<Tab value="loopback">

```tsx

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();
        
        // highlight-next-line
        let userInfo = await supertokens.getUser(userId)

        /**
        * 
        * userInfo contains the following info:
        * - emails
        * - id
        * - timeJoined
        * - tenantIds
        * - phone numbers
        * - third party login info
        * - all the login methods associated with this user.
        * - information about if the user's email is verified or not.
        * 
        */
    }
}
```

</Tab>

<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

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();
    
    // highlight-next-line
    let userInfo = await supertokens.getUser(userId)

    /**
    * 
    * userInfo contains the following info:
    * - emails
    * - id
    * - timeJoined
    * - tenantIds
    * - phone numbers
    * - third party login info
    * - all the login methods associated with this user.
    * - information about if the user's email is verified or not.
    * 
    */
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
            return NextResponse.json(err, { status: 500 });
        }
        const userId = session!.getUserId();

        // highlight-next-line
        let userInfo = await SuperTokens.getUser(userId)

        /**
        * 
        * userInfo contains the following info:
        * - emails
        * - id
        * - timeJoined
        * - tenantIds
        * - phone numbers
        * - third party login info
        * - all the login methods associated with this user.
        * - information about if the user's email is verified or not.
        * 
        */
        return NextResponse.json({});
    });
}
```

</ConditionalContent>
</Tab>

<Tab value="nestjs">

```tsx
// @ts-ignore
// @ts-ignore

@Controller()
export class ExampleController {
  @Post('example')
  @UseGuards(new AuthGuard()) // For more information about this guard please read our NestJS guide.
  async postExample(@Request() req: SessionRequest, @Session() session: Session, @Response({passthrough: true}) res: Response): Promise<boolean> {
    let userId = session.getUserId();
    
    // highlight-next-line
    let userInfo = await supertokens.getUser(userId)

    /**
    * 
    * userInfo contains the following info:
    * - emails
    * - id
    * - timeJoined
    * - tenantIds
    * - phone numbers
    * - third party login info
    * - all the login methods associated with this user.
    * - information about if the user's email is verified or not.
    * 
    */
    return true;
  }
}
```
</Tab>

</Tabs>

</Tab>
<Tab value="go">

<Tabs>
<Tab value="http">

```go

async function deleteUserForId() {
    let userId = "..." // get the user ID
    await deleteUser(userId); // this will succeed even if the userId didn't exist.
}
```

</Tab>
<Tab value="go">

```go

async function getUsers() {
    // get the latest 100 users
    let usersResponse = await getUsersNewestFirst({
		tenantId: "public"
	});

    let users = usersResponse.users;
    let nextPaginationToken = usersResponse.nextPaginationToken;

    // get the next 200 users
    usersResponse = await getUsersNewestFirst({
		tenantId: "public",
        limit: 200,
        paginationToken: nextPaginationToken,
    })

    users = usersResponse.users;
    nextPaginationToken = usersResponse.nextPaginationToken;

    // get for specific recipes
    usersResponse = await getUsersNewestFirst({
		tenantId: "public",
        limit: 200,
        paginationToken: nextPaginationToken,
		// only get for those users who signed up with ^{recipeNameCapitalLetters}
        includeRecipeIds: ["^{rid}"],
    })

    users = usersResponse.users;
    nextPaginationToken = usersResponse.nextPaginationToken;
}
```

</Tab>
<Tab value="go">

```go

async function getUsers() {
    // get the latest 100 users
    let usersResponse = await getUsersOldestFirst({
		tenantId: "public"
	});
    let users = usersResponse.users;
    let nextPaginationToken = usersResponse.nextPaginationToken;

    // get the next oldest 200 users
    usersResponse = await getUsersOldestFirst({
		tenantId: "public",
        limit: 200,
        paginationToken: nextPaginationToken,
    });

    users = usersResponse.users;
    nextPaginationToken = usersResponse.nextPaginationToken;

    // get for specific recipes
    usersResponse = await getUsersOldestFirst({
		tenantId: "public",
        limit: 200,
        paginationToken: nextPaginationToken,
        // only get for those users who signed up with ^{recipeNameCapitalLetters}
        includeRecipeIds: ["^{rid}"]
    });

    users = usersResponse.users;
    nextPaginationToken = usersResponse.nextPaginationToken;
}
```

- If the `nextPaginationToken` is `undefined`, then there are no more users to loop through.
- If there are no users in your app, then `nextPaginationToken` is `undefined` and `users` is an empty array
- Each element in the `users` array is according to the output of the core API as shown in the [API documentation](https://app.swaggerhub.com/apis/supertokens/CDI/2.8.0#/Core/getUsers).

</Tab>
<Tab value="go">

```go

async function getCount() {
    let count = await getUserCount()
}
```

</Tab>
<Tab value="go">

```go

# Post Authentication - User Management -  Allow users to change their data
Source: https://supertokens.com/docs/post-authentication/user-management/allow-users-to-update-their-data

## Overview

This guide shows you how to implement a feature that allows users to update their email or password.

## Before you start

:::caution
SuperTokens does not provide the UI for this type of use case.
You need to create the UI and set up a route on your backend to have this functionality.
:::

---

## Email update

This section has instructions on how to create a route, on your backend, to update a user's email.
Calling this route checks if the new email is valid and not already in use and proceeds to update the user's account with the new email.

### Without email verification

In this flow, a user can update their account's email without verifying the new email ID.

#### 1. Create the email update endpoint

- You need to create a route on the backend protected by the session verification middleware, ensuring that only an authenticated user can access the protected route.
- To learn more about how to use the session verification middleware for other frameworks, click [this link](/docs/additional-verification/session-verification/protect-api-routes)

<Tabs>

<Tab value="nodejs">

```tsx

let app = express();

// highlight-start
app.post("/change-email", verifySession(), async (req: SessionRequest, res: express.Response) => {
    // TODO: see next steps
})

// highlight-end
```
</Tab>

<Tab value="go">

```go

let app = express();

app.post("/change-email", verifySession(), async (req: SessionRequest, res: express.Response) => {

    // highlight-start
    let session = req.session!;
    let email = req.body.email;

    // Validate the input email
    if (!isValidEmail(email)) {
        // TODO: handle invalid email error
        return 
    }
    
    // Update the email
    let resp = await Passwordless.updateUser({
        recipeUserId: session.getRecipeUserId(),
        email: email
    })

    if (resp.status === "OK") {
        // TODO: send successfully updated email response
        return 
    }
    if (resp.status === "EMAIL_ALREADY_EXISTS_ERROR") {
        // TODO: handle error that email exists with another account.
        return
    }
    if (resp.status === "EMAIL_CHANGE_NOT_ALLOWED_ERROR") {
        // This is possible if you have enabled account linking.
        // See our docs for account linking to know more about this. 
        // TODO: tell the user to contact support.
    }
    throw new Error("Should never come here");
    // highlight-end

})

function isValidEmail(email: string) {
    let regexp = new RegExp(
        /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
    );
    return regexp.test(email);
}
```

</Tab>

<Tab value="go">

```go
	if err != nil {
		return false
	}
	return emailCheck
}
```

</Tab>

<Tab value="python">

```python
from re import fullmatch

from flask import Flask, g, request

from supertokens_python.recipe.passwordless.interfaces import (
    EmailChangeNotAllowedError,
    UpdateUserEmailAlreadyExistsError,
    UpdateUserOkResult,
)
from supertokens_python.recipe.passwordless.syncio import update_user
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.framework.flask import verify_session

app = Flask(__name__)

@app.route("/change-email", methods=["POST"])  # type: ignore
@verify_session()
def change_email():
    # highlight-start
    session: SessionContainer = g.supertokens

    request_body = request.get_json()

    email = str(request_body["email"])  # type: ignore
    if request_body is None:
        # TODO: handle invalid body error
        return

    # validate the input email
    if not is_valid_email(email):
        # TODO: handle invalid email error
        return

    # update the users email
    update_response = update_user(session.get_recipe_user_id(), email=email)

    if isinstance(update_response, UpdateUserOkResult):
        # TODO send successful email update response
        return

    if isinstance(update_response, UpdateUserEmailAlreadyExistsError):
        # TODO handle error, email already exists
        return

    if isinstance(update_response, EmailChangeNotAllowedError):
        # This is possible if you have enabled account linking.
        # See our docs for account linking to know more about this.
        # TODO: tell the user to contact support.
        return

    raise Exception("Should never reach here")

    # highlight-end

def is_valid_email(value: str) -> bool:
    return (
        fullmatch(
            r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
            value,
        )
        is not None
    )
```

</Tab>
</Tabs>

### With email verification

In this flow, the user's account updates once they have verified the new email.

#### 1. Create the email update endpoint 

- You need to create a route on the backend protected by the session verification middleware, ensuring that only an authenticated user can access the protected route.
- To learn more about how to use the session verification middleware for other frameworks, click [this link](/docs/additional-verification/session-verification/protect-api-routes)

<Tabs>

<Tab value="nodejs">

```tsx

let app = express();

// highlight-start
app.post("/change-email", verifySession(), async (req: SessionRequest, res: express.Response) => {
    // TODO: see next steps
})

// highlight-end
```
</Tab>

<Tab value="go">

```go

let app = express();

app.post("/change-email", verifySession(), async (req: SessionRequest, res: express.Response) => {

    // highlight-start
    let session = req.session!;
    let email = req.body.email;

    // validate the input email
    if (!isValidEmail(email)) {
        return res.status(400).send("Email is invalid");
    }

    // Then, we check if the email is verified for this user ID or not.
    // It is important to understand that SuperTokens stores email verification
    // status based on the user ID AND the email, and not just the email.
    let isVerified = await EmailVerification.isEmailVerified(session.getRecipeUserId(), email);

    if (!isVerified) {
        if (!(await isEmailChangeAllowed(session.getRecipeUserId(), email, false))) {
            // this can come here if you have enabled the account linking feature, and 
            // if there is a security risk in changing this user's email.
            return res.status(400).send("Email change not allowed. Please contact support");
        }
        // Before sending a verification email, we check if the email is already
        // being used by another user. If it is, we throw an error.
        let user = (await supertokens.getUser(session.getUserId()))!;
        for (let i = 0; i < user?.tenantIds.length; i++) {
            // Since once user can be shared across many tenants, we need to check if
            // the email already exists in any of the tenants.
            let usersWithEmail = await supertokens.listUsersByAccountInfo(user?.tenantIds[i], {
                email
            })
            for (let y = 0; y < usersWithEmail.length; y++) {
                if (usersWithEmail[y].id !== session.getUserId()) {
                    // TODO handle error, email already exists with another user.
                    return
                }
            }
        }

        // Now we create and send the email verification link to the user for the new email.
        await EmailVerification.sendEmailVerificationEmail(session.getTenantId(), session.getUserId(), session.getRecipeUserId(), email);

        // TODO send successful response that email verification email sent.
        return
    }

    // Since the email is verified, we try and do an update
    let resp = await Passwordless.updateUser({
        recipeUserId: session.getRecipeUserId(),
        email: email,
    });

    if (resp.status === "OK") {
        // TODO send successful response that email updated.
        return
    }
    if (resp.status === "EMAIL_ALREADY_EXISTS_ERROR") {
        // TODO handle error, email already exists with another user.
        return
    }

    throw new Error("Should never come here");
    // highlight-end

})

function isValidEmail(email: string) {
    let regexp = new RegExp(
        /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
    );
    return regexp.test(email);
}
```

</Tab>

<Tab value="go">

```go

	if err != nil {
		return false
	}
	return emailCheck
}

```

</Tab>

<Tab value="python">

```python
from re import fullmatch

from flask import Flask, g, request

from supertokens_python.recipe.accountlinking.syncio import is_email_change_allowed
from supertokens_python.recipe.emailverification.syncio import (
    is_email_verified,
    send_email_verification_email,
)
from supertokens_python.recipe.passwordless.interfaces import (
    UpdateUserEmailAlreadyExistsError,
    UpdateUserOkResult,
)
from supertokens_python.recipe.passwordless.syncio import update_user
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.syncio import get_user, list_users_by_account_info
from supertokens_python.types.base import AccountInfoInput

app = Flask(__name__)

@app.route("/change-email", methods=["POST"])  # type: ignore
@verify_session()
def change_email():
    # highlight-start
    session: SessionContainer = g.supertokens  # type: ignore

    request_body = request.get_json()

    if request_body is None:
        # TODO: handle invalid body error
        return

    # validate the input email
    if not is_valid_email(request_body["email"]):
        # TODO: handle invalid email error
        return

    user_id = session.get_user_id()

    # Then, we check if the email is verified for this user ID or not.
    # It is important to understand that SuperTokens stores email verification
    # status based on the user ID AND the email, and not just the email.
    is_verified = is_email_verified(session.get_recipe_user_id(), request_body["email"])

    if not is_verified:
        if not is_email_change_allowed(
            session.get_recipe_user_id(), request_body["email"], False
        ):
            # Email change is not allowed, send a 400 error
            return {"error": "Email change not allowed"}, 400
        # Before sending a verification email, we check if the email is already
        # being used by another user. If it is, we throw an error.
        user = get_user(user_id)

        if user is not None:
            for tenant_id in user.tenant_ids:
                users_with_same_email = list_users_by_account_info(
                    tenant_id, AccountInfoInput(email=request_body["email"])
                )
                for curr_user in users_with_same_email:
                    # Since one user can be shared across many tenants, we need to check if
                    # the email already exists in any of the tenants that belongs to this user.
                    if curr_user.id != user_id:
                        # TODO handle error, email already exists with another user.
                        return

        # Create and send the email verification link to the user for the new email.
        send_email_verification_email(
            session.get_tenant_id(),
            user_id,
            session.get_recipe_user_id(),
            request_body["email"],
        )

        # TODO send successful email verification response
        return

    # update the users email
    update_response = update_user(
        session.get_recipe_user_id(), email=request_body["email"]
    )

    if isinstance(update_response, UpdateUserOkResult):
        # TODO send successful email update response
        return

    if isinstance(update_response, UpdateUserEmailAlreadyExistsError):
        # TODO handle error, email already exists
        return

    # highlight-end

    raise Exception("Should never reach here")

def is_valid_email(value: str) -> bool:
    return (
        fullmatch(
            r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$',
            value,
        )
        is not None
    )
```

</Tab>
</Tabs>

:::info Multi Tenancy

- Notice that the process loops through all the tenants that this user belongs to check that for each of the tenants, there is no other user with the new email. If this step is not done, then calling `updateEmailOrPassword` would fail because the email is already used by another user in one of the tenants that this user belongs to. In that case, the verification process should not proceed either.
- The `tenantId` of the current session is also passed when calling the `sendEmailVerificationEmail` function, ensuring that the link generated opens the tenant's UI that the user interacts with.
- When calling `updateEmailOrPassword`, it returns `EMAIL_ALREADY_EXISTS_ERROR` if the new email exists in any of the tenants that the user ID is a part of.

:::

#### 3. Update the account on successful email verification

- Update the accounts email on successful email verification.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        Passwordless.init({
            flowType: "USER_INPUT_CODE_AND_MAGIC_LINK",
            contactMethod: "EMAIL_OR_PHONE"
        }),
        EmailVerification.init({
            mode: "REQUIRED",
            override: {
                apis: (oI) => {
                    return {
                        ...oI,
                        verifyEmailPOST: async function (input) {
                            // highlight-start
                            let response = await oI.verifyEmailPOST!(input);
                            if (response.status === "OK") {
                                // This will update the email of the user to the one
                                // that was just marked as verified by the token.
                                await Passwordless.updateUser({
                                    recipeUserId: response.user.recipeUserId,
                                    email: response.user.email,
                                });
                            }
                            return response;
                            // highlight-end
                        },
                    };
                },
            },
        }),
        Session.init(),
    ],
});
```

</Tab>

<Tab value="go">

```go

let app = express();

// highlight-start
app.post("/change-password", verifySession(), async (req: SessionRequest, res: express.Response) => {
    // TODO: see next steps
})

// highlight-end
```
</Tab>

<Tab value="go">

```go

let app = express();

app.post("/change-password", verifySession(), async (req: SessionRequest, res: express.Response) => {
// highlight-start
    // get the supertokens session object from the req
    let session = req.session

    // retrieve the old password from the request body
    let oldPassword = req.body.oldPassword

    // retrieve the new password from the request body
    let updatedPassword = req.body.newPassword

    // get the signed in user's email from the getUserById function
    let userInfo = await supertokens.getUser(session!.getUserId())

    if (userInfo === undefined) {
        throw new Error("Should never come here")
    }

    let loginMethod = userInfo.loginMethods.find((lM) => lM.recipeUserId.getAsString() === session!.getRecipeUserId().getAsString() && lM.recipeId === "emailpassword");
    if (loginMethod === undefined) {
        throw new Error("Should never come here")
    }
    const email = loginMethod.email!;

    // call signin to check that input password is correct
    let isPasswordValid = await EmailPassword.verifyCredentials(session!.getTenantId(), email, oldPassword)

    if (isPasswordValid.status !== "OK") {
        // TODO: handle incorrect password error
        return
    }

    // update the user's password using updateEmailOrPassword
    let response = await EmailPassword.updateEmailOrPassword({
        recipeUserId: session!.getRecipeUserId(),
        password: updatedPassword,
		tenantIdForPasswordPolicy: session!.getTenantId()
    })

    if (response.status === "PASSWORD_POLICY_VIOLATED_ERROR") {
        // TODO: handle incorrect password error
        return
    }
    
    // TODO: send successful password update response
    // highlight-end

})

```

</Tab>

<Tab value="go">

```go
	var requestBody RequestBody
	err := json.NewDecoder(r.Body).Decode(&requestBody)
	if err != nil {
		http.Error(w, err.Error(), http.StatusBadRequest)
		return
	}

	// get the userId from the session
	userID := sessionContainer.GetUserID()

	// get the signed in user's email from the getUserById function
	userInfo, err := emailpassword.GetUserByID(userID)
	if err != nil {
		// TODO: Handle error
		return
	}

	// call signin to check that the input is correct
	isPasswordValid, err := emailpassword.SignIn(sessionContainer.GetTenantId(), userInfo.Email, requestBody.OldPassword)
	if err != nil {
		// TODO: Handle error
		return
	}

	// highlight-start
	if isPasswordValid.WrongCredentialsError != nil {
		// TODO: Handle error
		return
	}

	tenantId := sessionContainer.GetTenantId()
	updateResponse, err := emailpassword.UpdateEmailOrPassword(userID, &userInfo.Email, &requestBody.NewPassword, nil, &tenantId, nil)
	if err != nil {
		// TODO: Handle error
		return
	}

	if updateResponse.PasswordPolicyViolatedError != nil {
		// This error is returned if the new password doesn't match the defined password policy
		// TODO: Handle error
		return
	}
	// TODO: send successful password update response
	// highlight-end

}
```

</Tab>

<Tab value="python">

```python
from flask import g, request

from supertokens_python.recipe.emailpassword.interfaces import (
    PasswordPolicyViolationError,
    WrongCredentialsError,
)
from supertokens_python.recipe.emailpassword.syncio import (
    update_email_or_password,
    verify_credentials,
)
from supertokens_python.recipe.session import SessionContainer
from supertokens_python.recipe.session.framework.flask import verify_session
from supertokens_python.syncio import get_user

@app.route("/change-password", methods=["POST"])  # type: ignore
@verify_session()
def change_password():

    # highlight-start
    session: SessionContainer = g.supertokens  # type: ignore

    # get the signed in user's email from the getUserById function
    users_info = get_user(session.get_user_id())

    if users_info is None:
        raise Exception("TODO: Handle error. User not found.")

    # Find the login method for the current user
    login_method = next(
        (
            lm
            for lm in users_info.login_methods
            if lm.recipe_user_id.get_as_string() == session.get_recipe_user_id().get_as_string()
            and lm.recipe_id == "emailpassword"
        ),
        None,
    )

    if login_method is None:
        raise Exception("Should never come here")

    email = login_method.email

    if email is None:
        raise Exception("Email not found for the user")

    request_body = request.get_json()

    if request_body is None:
        # TODO: handle invalid body error
        return

    # call signin to check that the input password is correct
    isPasswordValid = verify_credentials(
        "public", email, password=request_body["oldPassword"]
    )

    if isinstance(isPasswordValid, WrongCredentialsError):
        # TODO: handle incorrect password error
        return

    # update the users password
    update_response = update_email_or_password(
        session.get_recipe_user_id(),
        password=request_body["newPassword"],
        tenant_id_for_password_policy=session.get_tenant_id(),
    )

    if isinstance(update_response, PasswordPolicyViolationError):
        # TODO: handle password policy violation error
        return

    # TODO: send successful password update response
    # highlight-end
```

</Tab>
</Tabs>

:::info Multi Tenancy
Notice that the `tenantId` passes as an argument to the `signIn` and the `updateEmailOrPassword` functions. This ensures that the current tenant has email password enabled, and ensures that the user's new password matches the password policy defined for their tenant (if different password policies exist for different tenants).

If this user shares access across multiple tenants, their password changes for all tenants.
:::

### 3. Revoke all sessions associated with the user {{optional}}

- Revoking all sessions associated with the user forces them to re-authenticate with their new password.

<Tabs>
<Tab value="nodejs">

```tsx
// the following example uses express

let app = express();

app.post("/change-password", verifySession(), async (req: SessionRequest, res: express.Response) => {

   let userId = req.session!.getUserId();

    /**
     * 
     * ...
     * see previous step
     * ...
     * 
     *  */

    // highlight-start
    // revoke all sessions for the user
    await Session.revokeAllSessionsForUser(userId)

    // revoke the current user's session, this removes the auth cookies, logging out the user on the frontend.
    await req.session!.revokeSession()
    //highlight-end

    // TODO: send successful password update response

})

```
</Tab>

<Tab value="go">

```go
    user_id = session.get_user_id()

    # TODO: see previous step...

    # highlight-start
    # revoke all sessions for the user
    revoke_all_sessions_for_user(user_id)
    # revoke the user's current session, this removes the auth cookies, logging out the user on the frontend
    session.sync_revoke_session()
    # highlight-end

    # TODO: send successful password update response
```
</Tab>

</Tabs>

# Post Authentication - User Management -  User metadata
Source: https://supertokens.com/docs/post-authentication/user-management/user-metadata

## Overview

You can use the `UserMetadata` recipe to store your custom data about each user.
This can be any arbitrary values that are JSON serializable.
The following page shows you how to enable and use the feature.

---

## Enable the `UserMetadata` recipe

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // Initialize other recipes as seen in the quick setup guide
        // highlight-next-line
        UserMetadata.init(),
    ]
});
```

</Tab>
<Tab value="go">

```go

let app = express();

app.post("/updateinfo", verifySession(), async (req, res) => {
  const session = req.session;
  const userId = session.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
  // highlight-end

  res.json({ message: "successfully updated user metadata" });
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
  path: "/updateinfo",
  method: "post",
  options: {
    pre: [
      {
        method: verifySession(),
      },
    ],
  },
  handler: async (req: SessionRequest, res) => {
    const session = req.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
    // highlight-end
    return res.response({ message: "successfully updated user metadata" }).code(200);
  },
});
```

</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post(
  "/updateinfo",
  {
    preHandler: verifySession(),
  },
  async (req, res) => {
    const session = req.session;
    const userId = session.getUserId();

    // highlight-start
    await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
    // highlight-end
    res.send({ message: "successfully updated user metadata" });
  },
);
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateinfo(awsEvent: SessionEvent) {
  const session = awsEvent.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
  // highlight-end

  return {
    body: JSON.stringify({ message: "successfully updated user metadata" }),
    statusCode: 200,
  };
}

exports.handler = verifySession(updateinfo);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/updateinfo", verifySession(), async (ctx: SessionContext, next) => {
  const session = ctx.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
  // highlight-end
  ctx.body = { message: "successfully updated user metadata" };
});
```

</Tab>
<Tab value="loopback">

```tsx

class UpdateInfo {
  constructor(@inject(RestBindings.Http.CONTEXT) private ctx: SessionContext) {}
  @post("/updateinfo")
  @intercept(verifySession())
  @response(200)
  async handler() {
    const session = this.ctx.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
    // highlight-end
    return { message: "successfully updated user metadata" };
  }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function updateInfo(req: any, res: any) {
  await superTokensNextWrapper(
    async (next) => {
      await verifySession()(req, res, next);
    },
    req,
    res,
  );
  const session = (req as SessionRequest).session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
  // highlight-end
  res.json({ message: "successfully updated user metadata" });
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
          return NextResponse.json(err, { status: 500 });
        }
        const userId = session!.getUserId();

        // highlight-start
        await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
        // highlight-end
        return NextResponse.json({ success: "successfully updated user metadata" });
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
  @Post("example")
  @UseGuards(new AuthGuard())
  async postExample(@Session() session: SessionContainer): Promise<{ message: string }> {
    const userId = session.getUserId();

    //highlight-start
    await UserMetadata.updateUserMetadata(userId, { newKey: "data" });
    //highlight-end
    return { message: "successfully updated user metadata" };
  }
}
```

</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

let app = express();

app.post("/updateinfo", verifySession(), async (req, res) => {
  const session = req.session;
  const userId = session.getUserId();

  // highlight-start
  const { metadata } = await UserMetadata.getUserMetadata(userId);
  // highlight-end

  res.json({ preferences: metadata.preferences });
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
  path: "/updateinfo",
  method: "post",
  options: {
    pre: [
      {
        method: verifySession(),
      },
    ],
  },
  handler: async (req: SessionRequest, res) => {
    const session = req.session;
    const userId = session!.getUserId();

    // highlight-start
    const { metadata } = await UserMetadata.getUserMetadata(userId);
    // highlight-end
    return res.response({ preferences: metadata.preferences }).code(200);
  },
});
```

</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post(
  "/updateinfo",
  {
    preHandler: verifySession(),
  },
  async (req, res) => {
    const session = req.session;
    const userId = session.getUserId();

    // highlight-start
    const { metadata } = await UserMetadata.getUserMetadata(userId);
    // highlight-end
    res.send({ preferences: metadata.preferences });
  },
);
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateinfo(awsEvent: SessionEvent) {
  const session = awsEvent.session;
  const userId = session!.getUserId();

  // highlight-start
  const { metadata } = await UserMetadata.getUserMetadata(userId);
  // highlight-end

  return {
    body: JSON.stringify({ preferences: metadata.preferences }),
    statusCode: 200,
  };
}

exports.handler = verifySession(updateinfo);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/updateinfo", verifySession(), async (ctx: SessionContext, next) => {
  const session = ctx.session;
  const userId = session!.getUserId();

  // highlight-start
  const { metadata } = await UserMetadata.getUserMetadata(userId);
  // highlight-end
  ctx.body = { preferences: metadata.preferences };
});
```

</Tab>
<Tab value="loopback">

```tsx

class UpdateInfo {
  constructor(@inject(RestBindings.Http.CONTEXT) private ctx: SessionContext) {}
  @post("/updateinfo")
  @intercept(verifySession())
  @response(200)
  async handler() {
    const session = this.ctx.session;
    const userId = session!.getUserId();

    // highlight-start
    const { metadata } = await UserMetadata.getUserMetadata(userId);
    // highlight-end
    return { preferences: metadata.preferences };
  }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function updateInfo(req: any, res: any) {
  await superTokensNextWrapper(
    async (next) => {
      await verifySession()(req, res, next);
    },
    req,
    res,
  );
  const session = (req as SessionRequest).session;
  const userId = session!.getUserId();

  // highlight-start
  const { metadata } = await UserMetadata.getUserMetadata(userId);
  // highlight-end
  res.json({ preferences: metadata.preferences });
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
          return NextResponse.json(err, { status: 500 });
        }
        const userId = session!.getUserId();

        // highlight-start
        const { metadata } = await UserMetadata.getUserMetadata(userId);
        // highlight-end
        return NextResponse.json({ preferences: metadata.preferences });
    });
}
```

</ConditionalContent>

</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
  @Post("example")
  @UseGuards(new AuthGuard())
  async postExample(@Session() session: SessionContainer): Promise<{ preferences: any }> {
    const userId = session.getUserId();

    //highlight-start
    const { metadata } = await UserMetadata.getUserMetadata(userId);
    //highlight-end
    return { preferences: metadata.preferences };
  }
}
```

</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

### Delete specific fields 

You can do this by calling the update metadata function and setting the field you want to remove to be `null`. For example, if you have the following metadata object for a user:
```json
{
  "preferences": { "theme": "dark" },
  "notifications": { "email": true },
  "todos": ["use-text-notifs"]
}
```

And you want to remove the `"notifications"` field, you can update the metadata object with the following JSON:
```json
{
  "notifications": null
}
```

This would result in the final metadata object:
```json
{
  "preferences": { "theme": "dark" },
  "todos": ["use-text-notifs"]
}
```

:::info Important
You can only remove the root level fields in the metadata object in this way. From the above example, if you set `preferences.theme: null`, then it does not remove the `"theme"` field, but instead sets it to a JSON null value.
:::

In code, it would look like:

<Tabs>
<Tab value="nodejs">
<Tabs>
<Tab value="express">

```tsx

let app = express();

app.post("/updateinfo", verifySession(), async (req, res) => {
  const session = req.session;
  const userId = session.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { notifications: null });
  // highlight-end

  res.json({ message: "successfully updated user metadata" });
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
  path: "/updateinfo",
  method: "post",
  options: {
    pre: [
      {
        method: verifySession(),
      },
    ],
  },
  handler: async (req: SessionRequest, res) => {
    const session = req.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.updateUserMetadata(userId, { notifications: null });
    // highlight-end
    return res.response({ message: "successfully updated user metadata" }).code(200);
  },
});
```

</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post(
  "/updateinfo",
  {
    preHandler: verifySession(),
  },
  async (req, res) => {
    const session = req.session;
    const userId = session.getUserId();

    // highlight-start
    await UserMetadata.updateUserMetadata(userId, { notifications: null });
    // highlight-end
    res.send({ message: "successfully updated user metadata" });
  },
);
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateinfo(awsEvent: SessionEvent) {
  const session = awsEvent.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { notifications: null });
  // highlight-end

  return {
    body: JSON.stringify({ message: "successfully updated user metadata" }),
    statusCode: 200,
  };
}

exports.handler = verifySession(updateinfo);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/updateinfo", verifySession(), async (ctx: SessionContext, next) => {
  const session = ctx.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { notifications: null });
  // highlight-end
  ctx.body = { message: "successfully updated user metadata" };
});
```

</Tab>
<Tab value="loopback">

```tsx

class UpdateInfo {
  constructor(@inject(RestBindings.Http.CONTEXT) private ctx: SessionContext) {}
  @post("/updateinfo")
  @intercept(verifySession())
  @response(200)
  async handler() {
    const session = this.ctx.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.updateUserMetadata(userId, { notifications: null });
    // highlight-end
    return { message: "successfully updated user metadata" };
  }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function updateInfo(req: any, res: any) {
  await superTokensNextWrapper(
    async (next) => {
      await verifySession()(req, res, next);
    },
    req,
    res,
  );
  const session = (req as SessionRequest).session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.updateUserMetadata(userId, { notifications: null });
  // highlight-end
  res.json({ message: "successfully updated user metadata" });
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
          return NextResponse.json(err, { status: 500 });
        }
        const userId = session!.getUserId();

        // highlight-start
        await UserMetadata.updateUserMetadata(userId, { notifications: null });
        // highlight-end
        return NextResponse.json({ message: "successfully updated user metadata" });
    });
}
```

</ConditionalContent>
</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
  @Post("example")
  @UseGuards(new AuthGuard())
  async postExample(@Session() session: SessionContainer): Promise<{ message: string }> {
    const userId = session.getUserId();

    //highlight-start
    await UserMetadata.updateUserMetadata(userId, { notifications: null });
    //highlight-end
    return { message: "successfully updated user metadata" };
  }
}
```

</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

let app = express();

app.post("/updateinfo", verifySession(), async (req, res) => {
  const session = req.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.clearUserMetadata(userId);
  // highlight-end

  res.json({ success: true });
});
```

</Tab>
<Tab value="hapi">

```tsx

let server = Hapi.server({ port: 8000 });

server.route({
  path: "/updateinfo",
  method: "post",
  options: {
    pre: [
      {
        method: verifySession(),
      },
    ],
  },
  handler: async (req: SessionRequest, res) => {
    const session = req.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.clearUserMetadata(userId);
    // highlight-end
    return res.response({ success: true }).code(200);
  },
});
```

</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.post(
  "/updateinfo",
  {
    preHandler: verifySession(),
  },
  async (req, res) => {
    const session = req.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.clearUserMetadata(userId);
    // highlight-end
    res.send({ success: true });
  },
);
```

</Tab>
<Tab value="awsLambda">

```tsx

async function updateinfo(awsEvent: SessionEvent) {
  const session = awsEvent.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.clearUserMetadata(userId);
  // highlight-end

  return {
    body: JSON.stringify({ success: true }),
    statusCode: 200,
  };
}

exports.handler = verifySession(updateinfo);
```

</Tab>
<Tab value="koa">

```tsx

let router = new KoaRouter();

router.post("/updateinfo", verifySession(), async (ctx: SessionContext, next) => {
  const session = ctx.session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.clearUserMetadata(userId);
  // highlight-end
  ctx.body = { success: true };
});
```

</Tab>
<Tab value="loopback">

```tsx

class UpdateInfo {
  constructor(@inject(RestBindings.Http.CONTEXT) private ctx: SessionContext) {}
  @post("/updateinfo")
  @intercept(verifySession())
  @response(200)
  async handler() {
    const session = this.ctx.session;
    const userId = session!.getUserId();

    // highlight-start
    await UserMetadata.clearUserMetadata(userId);
    // highlight-end
    return { success: true };
  }
}
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```tsx

export default async function updateInfo(req: any, res: any) {
  await superTokensNextWrapper(
    async (next) => {
      await verifySession()(req, res, next);
    },
    req,
    res,
  );
  const session = (req as SessionRequest).session;
  const userId = session!.getUserId();

  // highlight-start
  await UserMetadata.clearUserMetadata(userId);
  // highlight-end
  res.json({ success: true });
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```tsx
// @ts-ignore

SuperTokens.init(backendConfig());

export function POST(request: NextRequest) {
    return withSession(request, async (err, session) => {
        if (err) {
          return NextResponse.json(err, { status: 500 });
        }
        const userId = session!.getUserId();

        // highlight-start
        await UserMetadata.clearUserMetadata(userId);
        // highlight-end
        return NextResponse.json({ success: true });
    });
}
```

</ConditionalContent>
</Tab>
<Tab value="nestjs">

```tsx
// @ts-ignore

@Controller()
export class ExampleController {
  @Post("example")
  @UseGuards(new AuthGuard())
  async postExample(@Session() session: SessionContainer): Promise<{ success: boolean }> {
    const userId = session.getUserId();

    //highlight-start
    // For more information about "AuthGuard" and the "Session" decorator please read our NestJS guide.
    await UserMetadata.clearUserMetadata(userId);
    //highlight-end
    return { success: true };
  }
}
```

</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

# Post Authentication - User Management -  User profile management
Source: https://supertokens.com/docs/post-authentication/user-management/user-profile

## Overview

This tutorial shows you how to add comprehensive user profile management to your **SuperTokens** authentication flows.
The guide makes use of the `plugins` functionality which provides a complete profile management interface with customizable form fields, account information display, and automatic third-party data integration.

The functionality integrates with the [progressive profiling plugin](/docs/post-authentication/user-management/progressive-profiling) by default.
This allows you to:
- Gradually collect user information through the progressive profiling flow
- Display collected information in the profile details interface
- Keep both systems synchronized automatically

## Before you start

The profile details plugin supports only the `React` and `NodeJS` SDKs.
Support for other platforms is under active development.

You need to start from a working **SuperTokens** setup.
If you haven't done that already, please refer to the [Quickstart Guides](/docs/quickstart/introduction).

## Steps

### 1. Initialize the backend plugin

#### 1.1 Install the plugin

```bash
npm install @supertokens-plugins/profile-details-nodejs
```

#### 1.2 Update your backend SDK configuration

The backend plugin exposes new endpoints which, in turn, get used by the frontend implementation.

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes (Session recipe is required)
  ],
  experimental: {
    plugins: [
      ProfileDetailsPlugin.init({
        sections: [
          {
            id: "personal-details",
            label: "Personal Information",
            description: "Your personal details",
            fields: [
              {
                id: "firstName",
                label: "First Name",
                type: "string",
                required: true,
                placeholder: "Enter your first name",
              },
              {
                id: "lastName",
                label: "Last Name",
                type: "string",
                required: true,
                placeholder: "Enter your last name",
              },
              {
                id: "company",
                label: "Company",
                type: "string",
                required: false,
                placeholder: "Enter your company name",
              },
            ],
          },
          {
            id: "preferences",
            label: "Preferences",
            description: "Customize your experience",
            fields: [
              {
                id: "avatar",
                label: "Profile Picture",
                type: "image-url",
                required: false,
                placeholder: "https://example.com/avatar.jpg",
              },
              {
                id: "theme",
                label: "Preferred Theme",
                type: "select",
                required: false,
                options: [
                  { value: "light", label: "Light" },
                  { value: "dark", label: "Dark" },
                  { value: "auto", label: "Auto" },
                ],
                defaultValue: "auto",
              },
            ],
          },
        ],
        registerSectionsForProgressiveProfiling: true, // Optional: defaults to true
      }),
    ],
  },
});
```

##### Supported field types

The plugin supports the following field types:

| Field Type | Description | Value Type | Example Use Case |
|------------|-------------|------------|------------------|
| `string` | Single-line text input | `string` | Name, title, company |
| `text` | Multi-line text area | `string` | Bio, description, comments |
| `number` | Numeric input | `number` | Age, salary, experience |
| `boolean` | Checkbox input | `boolean` | Newsletter subscription |
| `toggle` | Toggle switch | `boolean` | Feature preferences |
| `email` | Email input with validation | `string` | Contact email |
| `phone` | Phone number input | `string` | Contact number |
| `date` | Date picker | `string` (ISO 8601 format) | Birth date, start date |
| `select` | Dropdown selection | `string` | Country, department, role |
| `multiselect` | Multiple selection dropdown | `string[]` | Skills, interests, languages |
| `password` | Password input | `string` | API keys, secure tokens |
| `url` | URL input with validation | `string` | Website, social profiles |
| `image-url` | Image URL input with preview | `string` | Profile picture, logo |

##### Third-party data integration

The plugin automatically integrates with third-party authentication providers to populate profile fields.
When users sign in using external providers, the plugin maps provider data to profile fields (if the fields are configured):
    - `firstName`: Maps from `name`, `given_name`, or `first_name`
    - `lastName`: Maps from `family_name` or `last_name`
    - `avatar`: Maps from `picture` or `avatar_url`

:::info no-title
You can customize how third-party data maps to your profile fields by overriding the function `getFieldValueFromThirdPartyUserInfo`.

```typescript

SuperTokens.init({
  // ... other config
  experimental: {
    plugins: [
      ProfileDetailsPlugin.init({
        override: (oI) => ({
          ...oI,
          getFieldValueFromThirdPartyUserInfo: (providerId, field, rawUserInfoFromProvider, profile) => {
	    return rawUserInfoFromProvider[field.id];
          },
        }),
      }),
    ],
  },
});
```
:::

### 2. Initialize the frontend plugin

#### 2.1 Install the plugin

```bash
npm install @supertokens-plugins/profile-details-react
```

#### 2.2 Update your frontend SDK configuration

Initialize the frontend plugin in your existing configuration.
With the following setup the `/user/profile` path renders the profile details page.

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      ProfileDetailsPlugin.init(),
    ],
  },
});
```

:::info
The user profile page gets rendered by default on the `/user/profile` path.
If you want to change the path, you have to initialize the `profile-base-react` plugin with the `profilePagePath` option.

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      ProfileBasePlugin.init({
        profilePagePath: "/user/profile",
      }),
      ProfileDetailsPlugin.init(),
    ],
  },
});
```
:::

### 3. Test the implementation

Authenticate and then visit the `/user/profile` path.
You should see the new interface that renders the profile data.

<img
	alt="Progressive profiling setup interface"
	width="700px"
	src="/img/user-profile.png"
/>

## Customization

### Custom field components

To add custom rendering behavior for fields you have to pass an override during plugin initialization.

```typescript

SuperTokens.init({
  // ... other config
  experimental: {
    plugins: [
      ProfileDetailsPlugin.init({
        override: (oI) => ({
          ...oI,
          fieldInputComponentMap: (originalMap) => ({
            ...originalMap,
            string: CustomStringInput,
          }),
          fieldViewComponentMap: (originalMap) => ({
            ...originalMap,
            string: CustomStringView,
          }),
        }),
      }),
    ],
  },
});
```

### Custom user interface

To create your own UI you can use the `usePluginContext` hook.
It exposes an interface which you can use to call the endpoints exposed by the backend plugin.

```typescript

function CustomProfileComponent() {
  const { api, t, fieldInputComponentMap } = usePluginContext();
  const [profile, setProfile] = useState(null);

  const handleGetDetails = async () => {
    const result = await api.getDetails();
    if (result.status === "OK") {
      setProfile(result.profile);
    }
  };

  const handleUpdateProfile = async (data) => {
    const result = await api.updateProfile({ data });
    if (result.status === "OK") {
      console.log("Profile updated successfully");
    }
  };

  return (
    <div>
      <h2>{t("PL_CD_SECTION_ACCOUNT_LABEL")}</h2>
      <button onClick={handleGetDetails}>Load Profile Details</button>
      {/* Your custom form components */}
    </div>
  );
}
```


Besides profile details management, you can also explore other user management features:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/user-management/progressive-profiling">
    <ReferenceCard.Title>
      Progressive Profiling
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Gradually collect user information through customizable forms.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/post-authentication/user-management/user-banning">
    <ReferenceCard.Title>
      User Banning
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Implement user banning functionality to restrict access.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/additional-verification/user-roles/introduction">
    <ReferenceCard.Title>
      User Roles
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Implement role-based access control for your users.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/plugins/introduction">
    <ReferenceCard.Title>
     Plugins Reference 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
     General information on how plugins work.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Post Authentication - User Management -  Account deduplication
Source: https://supertokens.com/docs/post-authentication/user-management/account-deduplication

## Overview

Users may forget the initial method they used to sign up and may create multiple accounts with the same email ID - leading to a poor user experience.
Preventing this from happening refers to account deduplication.

As an example, assume that your app has Google and GitHub login.
There exists a user who had signed up with Google using their email ID - `user@gmail.com`.
If this user then tries to sign up with GitHub, which has this same email (`user@gmail.com`), your app disallows this. It shows them an appropriate message like "Your account already exists via Google sign in. Please use that instead."

### Comparison to account linking

Related to this problem is also the concept of account linking.
The difference is that whilst deduplication prevents duplicate sign ups, account linking allows duplicate sign ups, but implicitly merges the duplicate accounts into one.

## Steps

### 1. Override the authentication recipes

The approach to implementing account deduplication is to override the backend functions / APIs.
This way, you can check if a user already exists and return an error to the frontend if the condition is true.

<Tabs>
<Tab value="nodejs">

```tsx

let recipeList = [
    Passwordless.init({
        contactMethod: "EMAIL", // REMOVE_FROM_OUTPUT
        flowType: "USER_INPUT_CODE_AND_MAGIC_LINK", // REMOVE_FROM_OUTPUT
        override: {
            apis: (originalImplementation) => {
                return {
                    ...originalImplementation,
                    createCodePOST: async function (input) {
                        if ("email" in input) {
                            let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                                email: input.email
                            });
                            if (existingUsers.length === 0) {
                                // this means this email is new so we allow sign up
                                return originalImplementation.createCodePOST!(input);
                            }
                            if (existingUsers.find(u =>
                                u.loginMethods.find(lM => lM.hasSameEmailAs(input.email) && lM.recipeId === "passwordless") !== undefined)) {
                                // this means that the existing user is a passwordless login user. So we allow it
                                return originalImplementation.createCodePOST!(input);
                            }
                            return {
                                status: "GENERAL_ERROR",
                                message: "Seems like you already have an account with another method. Please use that instead."
                            }
                        }
                        // phone number based login, so we allow it.
                        return originalImplementation.createCodePOST!(input);
                    },
                }
            }
        }
    }),
    ThirdParty.init({
        override: {
            functions: (originalImplementation) => {
                return {
                    ...originalImplementation,
                    signInUp: async function (input) {
                        let existingUsers = await supertokens.listUsersByAccountInfo(input.tenantId, {
                            email: input.email
                        });
                        if (existingUsers.length === 0) {
                            // this means this email is new so we allow sign up
                            return originalImplementation.signInUp(input);
                        }
                        if (existingUsers.find(u =>
                            u.loginMethods.find(lM => lM.hasSameThirdPartyInfoAs({
                                id: input.thirdPartyId,
                                userId: input.thirdPartyUserId
                            }) && lM.recipeId === "thirdparty") !== undefined)) {
                            // this means we are trying to sign in with the same social login. So we allow it
                            return originalImplementation.signInUp(input);
                        }
                        // this means that the email already exists with another social or passwordless login method, so we throw an error.
                        throw new Error("Cannot sign up as email already exists");
                    }
                }
            },
            apis: (originalImplementation) => {
                return {
                    ...originalImplementation,
                    signInUpPOST: async function (input) {
                        try {
                            return await originalImplementation.signInUpPOST!(input);
                        } catch (err: any) {
                            if (err.message === "Cannot sign up as email already exists") {
                                // this error was thrown from our function override above.
                                // so we send a useful message to the user
                                return {
                                    status: "GENERAL_ERROR",
                                    message: "Seems like you already have an account with another method. Please use that instead."
                                }
                            }
                            throw err;
                        }
                    }
                }
            }
        }
    })
]
```

</Tab>
<Tab value="go">

```go
							// so we send a useful message to the user
							return tpmodels.SignInUpPOSTResponse{
								GeneralError: &supertokens.GeneralErrorResponse{
									Message: "Seems like you already have an account with another method. Please use that instead.",
								},
							}, nil
						}

						return resp, err
					}

					return originalImplementation
				},
			},
		}),
	}
}
```

</Tab>
<Tab value="python">

```python
from typing import Any, Dict, Optional, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import list_users_by_account_info
from supertokens_python.recipe import passwordless, thirdparty
from supertokens_python.recipe.passwordless.interfaces import (
    APIInterface as PasswordlessAPIInterface,
)
from supertokens_python.recipe.passwordless.interfaces import (
    APIOptions as PasswordlessAPIOptions,
)
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.thirdparty.interfaces import (
    APIInterface as ThirdPartyAPIInterface,
)
from supertokens_python.recipe.thirdparty.interfaces import (
    APIOptions as ThirdPartyAPIOptions,
)
from supertokens_python.recipe.thirdparty.interfaces import (
    RecipeInterface,
)
from supertokens_python.recipe.thirdparty.provider import Provider, RedirectUriInfo
from supertokens_python.recipe.thirdparty.types import (
    RawUserInfoFromProvider,
    ThirdPartyInfo,
)
from supertokens_python.types import GeneralErrorResponse
from supertokens_python.types.base import AccountInfoInput

def override_thirdparty_functions(original_implementation: RecipeInterface):
    original_sign_in_up = original_implementation.sign_in_up

    async def sign_in_up(
        third_party_id: str,
        third_party_user_id: str,
        email: str,
        is_verified: bool,
        oauth_tokens: Dict[str, Any],
        raw_user_info_from_provider: RawUserInfoFromProvider,
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        user_context: Dict[str, Any],
    ):
        existing_users = await list_users_by_account_info(
            tenant_id, AccountInfoInput(email=email)
        )
        if len(existing_users) == 0:
            # this means this email is new so we allow sign up
            return await original_sign_in_up(
                third_party_id,
                third_party_user_id,
                email,
                is_verified,
                oauth_tokens,
                raw_user_info_from_provider,
                session,
                should_try_linking_with_session_user,
                tenant_id,
                user_context,
            )

        if any(
            any(
                lm.recipe_id == "thirdparty"
                and lm.has_same_third_party_info_as(
                    ThirdPartyInfo(third_party_user_id, third_party_id)
                )
                for lm in user.login_methods
            )
            for user in existing_users
        ):
            # this means we are trying to sign in with the same social login. So we allow it
            return await original_sign_in_up(
                third_party_id,
                third_party_user_id,
                email,
                is_verified,
                oauth_tokens,
                raw_user_info_from_provider,
                session,
                should_try_linking_with_session_user,
                tenant_id,
                user_context,
            )

        # this means that the email already exists with another social login method.
        # so we throw an error.
        raise Exception("Cannot sign up as email already exists")

    original_implementation.sign_in_up = sign_in_up

    return original_implementation

def override_thirdparty_apis(original_implementation: ThirdPartyAPIInterface):
    original_sign_in_up_post = original_implementation.sign_in_up_post

    async def sign_in_up_post(
        provider: Provider,
        redirect_uri_info: Optional[RedirectUriInfo],
        oauth_tokens: Optional[Dict[str, Any]],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: ThirdPartyAPIOptions,
        user_context: Dict[str, Any],
    ):
        try:
            return await original_sign_in_up_post(
                provider,
                redirect_uri_info,
                oauth_tokens,
                session,
                should_try_linking_with_session_user,
                tenant_id,
                api_options,
                user_context,
            )
        except Exception as e:
            if str(e) == "Cannot sign up as email already exists":
                return GeneralErrorResponse(
                    "Seems like you already have an account with another social login provider. Please use that instead."
                )
            raise e

    original_implementation.sign_in_up_post = sign_in_up_post
    return original_implementation

def override_passwordless_apis(original_implementation: PasswordlessAPIInterface):
    original_create_code_post = original_implementation.create_code_post

    async def create_code_post(
        email: Union[str, None],
        phone_number: Union[str, None],
        session: Optional[SessionContainer],
        should_try_linking_with_session_user: Union[bool, None],
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ):
        if email is not None:
            existing_users = await list_users_by_account_info(
                tenant_id, AccountInfoInput(email=email)
            )
            if len(existing_users) == 0:
                # this means this email is new so we allow sign up
                return await original_create_code_post(
                    email,
                    phone_number,
                    session,
                    should_try_linking_with_session_user,
                    tenant_id,
                    api_options,
                    user_context,
                )

            if any(
                user.login_methods
                and any(
                    lm.recipe_id == "passwordless" and lm.has_same_email_as(email)
                    for lm in user.login_methods
                )
                for user in existing_users
            ):
                # this means that the existing user is a passwordless login user. So we allow it
                return await original_create_code_post(
                    email,
                    phone_number,
                    session,
                    should_try_linking_with_session_user,
                    tenant_id,
                    api_options,
                    user_context,
                )

            return GeneralErrorResponse(
                "Seems like you already have an account with another method. Please use that instead."
            )

        # phone number based login, so we allow it.
        return await original_create_code_post(
            email,
            phone_number,
            session,
            should_try_linking_with_session_user,
            tenant_id,
            api_options,
            user_context,
        )

    original_implementation.create_code_post = create_code_post
    return original_implementation

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        passwordless.init(
            contact_config=...,  # type: ignore
            flow_type="...",  # type: ignore
            override=passwordless.InputOverrideConfig(
                apis=override_passwordless_apis,
            ),
        ),
        thirdparty.init(
            override=thirdparty.InputOverrideConfig(
                apis=override_thirdparty_apis, functions=override_thirdparty_functions
            )
        ),
    ],
)
```

</Tab>
</Tabs>

In the above code snippet, override the `signInUpPOST` (third party recipe) and the `createCodePOST` (passwordless recipe) API as well as the `signInUp` recipe function.

The frontend calls the `signInUpPOST` API after the user returns to the app from the third-party provider's login page. The API then exchanges the auth code with the provider and calls the `signInUp` function with the user's email and third-party info.

The system calls the `createCodePOST` API when the user enters their email, or phone number during passwordless login. This API generates the passwordless OTP / link and sends it to the user's email / phone.

The `signInUp` recipe function is overridden to:
- Get all ThirdParty or Passwordless users that have the same input email.
- If no users exist with that email, it means that this is a new email and the system calls the `originalImplementation` function to create a new user.
- If instead, a user exists, but has the same `thirdPartyId` and `thirdPartyUserId`, implying that this is a sign in (for example a user who had signed up with Google is signing in with Google), the operation proceeds by calling the `originalImplementation` function.
- If neither of the conditions above match, it means that the user is trying to sign up with a third party provider whilst they already have an account with another provider or via passwordless login. Here, the system throws an error with some custom message.

Finally, the `signInUpPOST` API is overridden to catch that custom error and return a [general error status](/docs/references/backend-sdks/api-overrides#error-management) to the frontend with a message displayed to the user in the sign in form.

The `createCodePOST` API is also overridden to perform similar checks:
- If the input is phone number based, then the system calls the `originalImplementation` function allowing sign up or sign in. This is OK since social login is always email based, there is no scope of duplication.
- Otherwise, get all ThirdParty or Passwordless users that have the same input email.
- If no users exist with that email, it means that this is a new email and the system calls the `originalImplementation` function to create a new user.
- Else, check if the existing user is not a Third Party login user, implying that it's a Passwordless login user. Here, the `originalImplementation` function is also called to allow the user to sign in.
- If neither of the conditions above match, it means that the user is trying to sign up with passwordless login whilst they already have an account with a third party provider. Here, the system returns an appropriate message to display on the frontend.

:::info Multi Tenancy

For a multi tenant setup, the customisations above ensure that multiple accounts with the same email don't exist within a single tenant. To ensure no duplication across all tenants, when fetching the list of existing users, loop through all tenants in the app. You can fetch them by using the `listAllTenants` function of the multi tenancy recipe.

:::

# Post Authentication - User Management -  User banning
Source: https://supertokens.com/docs/post-authentication/user-management/user-banning

## Overview

This tutorial shows you how to add a user banning feature to your SuperTokens authentication flows.
The guide makes use of the plugins functionality which provides the ability to ban/unban users.

## How it works

The plugin makes use of the `UserRoles` feature to keep track of banned users.
When you ban someone, they get assigned a new role, `banned`, and their session gets revoked immediately.
Additionally, the default session validation logic gets overridden to prevent users with the banned role from accessing the application.

### Caching

To avoid extra network calls during session verification, the plugin uses an in-memory cache to keep track of the ban status.
The cache gets reloaded during the first session verification, after a server start, causing a slight increase in latency.
If you are working with a serverless environment or with distributed applications, you can implement your own caching strategy through overrides.

## Before you start

The user banning plugin supports only the `React` and `NodeJS` SDKs. 
Support for other platforms is under active development.
Besides initializing the plugin, you also have to include the `UserRoles` recipe in your SuperTokens configuration.

## Steps

### 1. Initialize the backend plugin

#### 1.1 Install the plugin

```bash
npm install @supertokens-plugins/user-banning-nodejs
```

#### 1.2 Update your backend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    UserRoles.init(), // Required: UserRoles recipe must be initialized
    // your other recipes
  ],
  experimental: {
    plugins: [
      UserBanningPlugin.init({
	userBanningPermission: "ban-user", // Optional: defaults to "ban-user"
	bannedUserRole: "banned", // Optional: defaults to "banned"
      }),
    ],
  }
});
```

:::warning no-title
Make sure to also initialize the `UserRoles` recipe if you haven't already.
:::

### 2. Initialize the frontend plugin

#### 2.1 Install the plugin

```bash
npm install @supertokens-plugins/user-banning-react
```

#### 2.2 Update your frontend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      UserBanningPlugin.init({
	userBanningPermission: "ban-user", // Should match backend config
	bannedUserRole: "banned", // Should match backend config
	onPermissionFailureRedirectPath: "/", // Optional: defaults to "/"
      }),
    ],
  }
});
```

### 3. Ban users

#### 3.1 Using the user banning interface

The plugin provides a complete administrative interface accessible at `/admin/ban-user`. 
Before you access the interface, make sure that your user has the required permission, `ban-user` by default.
Read the [role management actions page](/docs/additional-verification/user-roles/role-management-actions#add-permissions) for instructions on how to add permissions to your users.

<img
	alt="User banning UI"
	width="700px"
	src="/img/user-banning.png"
/>

From the interface you can check the banning status of a user.
Based on that status, you can either ban or remove the ban for that account.

#### 3.2 Using direct API calls

You can also manage user bans programmatically using the exposed API endpoints.

##### Ban/unban user

```javascript
// Ban a user
const banResponse = await fetch("/plugin/supertokens-plugin-user-banning/ban?tenantId=public", {
  method: "POST",
  credentials: "include", // Include session cookies
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "user@example.com",
    // You can also pass the userId instead of the email
    // userId: "user123", 
    isBanned: true, // true to ban, false to remove ban
  }),
});

const banResult = await banResponse.json();
if (banResult.status === "OK") {
  console.log("User banned successfully");
} else {
  console.error("Failed to ban user:", banResult.message);
}

// Remove ban from a user
const unbanResponse = await fetch("/plugin/supertokens-plugin-user-banning/ban?tenantId=public", {
  method: "POST",
  credentials: "include",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "user@example.com",
    isBanned: false,
  }),
});
```

##### Check ban status

```javascript
// Check if a user is banned
const statusResponse = await fetch(
  "/plugin/supertokens-plugin-user-banning/ban?tenantId=public&email=user@example.com",
  {
    method: "GET",
    credentials: "include",
  }
);

const status = await statusResponse.json();
if (status.status === "OK") {
  console.log("User is banned:", status.banned);
} else {
  console.error("Error checking ban status:", status.message);
}
```

## Customization

### Implement a custom user interface

To create a custom user interface you can use the `usePluginContext` hook.
It allows you to access the plugin's API methods and configuration in custom React components:

```typescript

function MyCustomAdminComponent() {
  const { api, pluginConfig, t } = usePluginContext();

  const handleBanUser = async (email: string) => {
    try {
      const result = await api.updateBanStatus("public", email, true);
      if (result.status === "OK") {
        console.log("User banned successfully");
      } else {
        console.error("Failed to ban user:", result.message);
      }
    } catch (error) {
      console.error("Error:", error);
    }
  };

  const handleCheckBanStatus = async (email: string) => {
    try {
      const result = await api.getBanStatus("public", email);
      if (result.status === "OK") {
        console.log("User has ban:", result.banned);
      } else {
        console.error("Error:", result.message);
      }
    } catch (error) {
      console.error("Error:", error);
    }
  };

  return (
    <div>
      <h2>{t("PL_UB_BAN_PAGE_TITLE")}</h2>
      <button onClick={() => handleBanUser("user@example.com")}>
        {t("PL_UB_BAN_USER_BUTTON")}
      </button>
      <button onClick={() => handleCheckBanStatus("user@example.com")}>
        Check Ban Status
      </button>
    </div>
  );
}
```


Besides user banning you can also look into other user management features and security measures:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/additional-verification/attack-protection-suite/introduction">
    <ReferenceCard.Title>
      Attack Protection Suite
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Prevent suspicious authentication attempts.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/additional-verification/user-roles/introduction">
    <ReferenceCard.Title>
      User Roles
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Implement role-based access control for your users.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/plugins/introduction">
    <ReferenceCard.Title>
     Plugins Reference 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
     General information on how plugins work.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Post Authentication - User Management -  Progressive profiling
Source: https://supertokens.com/docs/post-authentication/user-management/progressive-profiling

## Overview

This tutorial shows you how to add progressive profiling functionality to your **SuperTokens** authentication flows.
The guide makes use of the `plugins` functionality which provides a step-by-step user profile collection system with customizable forms and field types.
This way you can gather user information gradually, during the sign up process.

## How it works

The plugin breaks profile collection into manageable sections.
It automatically enforces profile completion through session claims, redirecting users to the setup page until their profile is complete.
The system provides dynamic validation, progress tracking, and flexible storage options for collected data.

## Before you start

The progressive profiling plugin supports only the `React` and `NodeJS` SDKs.
Support for other platforms is under active development.

The implementation is in early stages and APIs might change.
For more information on how plugins work refer to the [references page](/docs/references/plugins/introduction).

You need to start from a working **SuperTokens** setup.
If you haven't done that already, please refer to the [Quickstart Guides](/docs/quickstart/introduction).

## Steps

### 1. Initialize the backend plugin

#### 1.1 Install the plugin

```bash
npm install @supertokens-plugins/progressive-profiling-nodejs
```

#### 1.2 Update your backend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes (Session recipe is required)
  ],
  experimental: {
    plugins: [
      ProgressiveProfilingPlugin.init({
        sections: [
          {
            id: "basic-info",
            label: "Basic Information",
            description: "Tell us about yourself",
            fields: [
              {
                id: "firstName",
                label: "First Name",
                type: "string",
                required: true,
                placeholder: "Enter your first name",
              },
              {
                id: "lastName",
                label: "Last Name",
                type: "string",
                required: true,
                placeholder: "Enter your last name",
              },
              {
                id: "company",
                label: "Company",
                type: "string",
                required: false,
                placeholder: "Enter your company name",
              },
            ],
          },
          {
            id: "preferences",
            label: "Preferences",
            description: "Customize your experience",
            fields: [
              {
                id: "notifications",
                label: "Email Notifications",
                type: "boolean",
                required: false,
                defaultValue: true,
              },
              {
                id: "theme",
                label: "Preferred Theme",
                type: "select",
                required: false,
                options: [
                  { value: "light", label: "Light" },
                  { value: "dark", label: "Dark" },
                  { value: "auto", label: "Auto" },
                ],
                defaultValue: "auto",
              },
            ],
          },
        ],
      }),
    ],
  },
});
```

##### Supported field types

The plugin supports the following field types:

| Field Type | Description | Example Use Case |
|------------|-------------|------------------|
| `string` | Single-line text input | Name, title, company |
| `text` | Multi-line text area | Bio, description, comments |
| `number` | Numeric input | Age, salary, years of experience |
| `boolean` | Checkbox input | Newsletter subscription, terms acceptance |
| `toggle` | Toggle switch | Feature preferences, notifications |
| `email` | Email input with validation | Contact email, secondary email |
| `phone` | Phone number input | Contact number, emergency contact |
| `date` | Date picker | Birth date, start date |
| `select` | Dropdown selection | Country, department, role |
| `multiselect` | Multiple selection dropdown | Skills, interests, languages |
| `password` | Password input | API keys, secure tokens |
| `url` | URL input with validation | Website, social profiles |
| `image-url` | Image URL input with preview | Profile picture, logo |

:::info no-title
The plugin provides built-in validation for form fields:
- **Required Fields**: Automatically validates that required fields are not empty
- **Field Type Validation**: Ensures values match the expected field type
:::

### 2. Initialize the frontend plugin

#### 2.1 Install the plugin

```bash
npm install @supertokens-plugins/progressive-profiling-react
```

#### 2.2 Update your frontend SDK configuration

```typescript

SuperTokens.init({
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      ProgressiveProfilingPlugin.init({
        setupPagePath: "/user/setup", // Optional: defaults to "/user/setup"
        requireSetup: true, // Optional: defaults to true
        showStartSection: true, // Optional: defaults to true
        showEndSection: true, // Optional: defaults to true
        onSuccess: async (data) => {
          // Optional: callback after successful profile completion
          console.log("Profile completed:", data);
        },
      }),
    ],
  },
});
```

### 3. Test the implementation

With this configuration, users automatically get redirected to the profile setup page after authentication.
Try to authenticate and check if you get sent to the new form.

<img
	alt="Progressive profiling setup interface"
	width="700px"
	src="/img/progressive-profiling.png"
/>

## Customization

### Storage handlers

By default, the plugin stores profile data using the `User Metadata` recipe.
You can also implement your custom storage solution by overriding the `defaultStorageHandlerSetFields` and `defaultStorageHandlerGetFields` functions.

```typescript

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      ProgressiveProfilingPlugin.init({
        sections: [
          {
            id: "basic-info",
            label: "Basic Information",
            description: "Tell us about yourself",
            fields: [
              {
                id: "firstName",
                label: "First Name",
                type: "string",
                required: true,
                placeholder: "Enter your first name",
              },
              {
                id: "lastName",
                label: "Last Name",
                type: "string",
                required: true,
                placeholder: "Enter your last name",
              },
              {
                id: "company",
                label: "Company",
                type: "string",
                required: false,
                placeholder: "Enter your company name",
              },
            ],
          },
        ],
	override: (oI) => ({
	  ...oI,
	  defaultStorageHandlerSetFields: ({ pluginFormFields, data, session, userContext }) => {
	    const userId = session.getUserId(userContext);
	    const profile = pluginFormFields.reduce(
	      (acc, field) => {
		const newValue = data.find((d) => d.fieldId === field.id)?.value;
		const existingValue = existingProfile?.[field.id];
		return {
		  ...acc,
		  [field.id]: newValue ?? existingValue ?? field.defaultValue,
		};
	      },
	      { ...existingProfile }
	    );

	    // Implement your own logic for storing profile data
	    await customSetProfileData(userId, profile);
	  },
	  defaultStorageHandlerGetFields: ({ pluginFormFields, session, userContext }) => {
	    const userId = session.getUserId(userContext);
	    // Implement your own logic for fetching profile data
	    const existingProfile = await customGetProfileData(userId);

	    return pluginFormFields.map((field) => ({
	      sectionId: field.sectionId,
	      fieldId: field.id,
	      value: existingProfile[field.id] ?? field.defaultValue,
	    });
	  },
	}),
      }),
    ],
  },
});
```

### User interface

To create your own UI you can use the `usePluginContext` hook.
It exposes an interface which you can use to interface with the endpoints exposed by the backend plugin. 

```typescript

function CustomProfileComponent() {
  const { api, t } = usePluginContext();
  const [profile, setProfile] = useState([]);

  const handleLoadProfile = async () => {
    const result = await api.getProfile();
    if (result.status === "OK") {
      setProfile(result.data);
    }
  };

  const handleUpdateProfile = async (data) => {
    const result = await api.updateProfile({ data });
    if (result.status === "OK") {
      console.log("Profile updated successfully");
    } else if (result.status === "INVALID_FIELDS") {
      console.error("Validation errors:", result.errors);
    }
  };

  return (
    <div>
      <h2>{t("PL_PP_SECTION_PROFILE_START_LABEL")}</h2>
      <button onClick={handleLoadProfile}>Load Profile</button>
      {/* Your custom form components */}
    </div>
  );
}
```

:::info pre-built UI
You can integrate the pre-built UI into other pages/components by importing the `ProgressiveProfilingWrapper` component:

```typescript
function MyApp() {
  return (
    <div>
      <ProgressiveProfilingWrapper />
    </div>
  );
}
```
:::

### Form fields validation

To change the default validation behavior you can override the `validateField` function:

```ts

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      ProgressiveProfilingPlugin.init({
        sections: [
          {
            id: "basic-info",
            label: "Basic Information",
            description: "Tell us about yourself",
            fields: [
              {
                id: "firstName",
                label: "First Name",
                type: "string",
                required: true,
                placeholder: "Enter your first name",
              },
              {
                id: "lastName",
                label: "Last Name",
                type: "string",
                required: true,
                placeholder: "Enter your last name",
              },
              {
                id: "company",
                label: "Company",
                type: "string",
                required: false,
                placeholder: "Enter your company name",
              },
            ],
          },
        ],
	override: (oI) => ({
	  ...oI,
	  validateField: ({ field, value }) => {
	    // Custom logic to validate field values
	    if(field.required && value === "") {
	      return "Field is required";
	    }

	    // Return undefined if validation passes
	    return undefined;
	  },
	}),
      }),
    ],
  },
});

```


Besides progressive profiling, you can also explore other user management features:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/user-management/user-banning">
    <ReferenceCard.Title>
      User Banning
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Implement user banning functionality to restrict access.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/additional-verification/user-roles/introduction">
    <ReferenceCard.Title>
      User Roles
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Implement role-based access control for your users.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/plugins/introduction">
    <ReferenceCard.Title>
     Plugins Reference 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
     General information on how plugins work.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Post Authentication - Account Linking -  Important concepts
Source: https://supertokens.com/docs/post-authentication/account-linking/important-concepts

## Overview

The following page describes concepts that are relevant towards understanding how account linking works in **SuperTokens**.

## References

Each authentication recipe has a unique *user* object.

### Primary and non-primary users

The system identifies a primary or a non-primary user by the `isPrimaryUser` boolean within the user object.
The primary user ID remains constant when accounts link to it.

A user can become a primary user only if no other primary users share the same email, third-party information, or phone number across all tenants. This applies to all tenants to which the user belongs.
Hence, two primary users with the same email address, one using email/password login and the other using social login.

:::info Multi-tenancy
Additionally, the following scenario is not permitted in a multi-tenant context:
- User A is a primary user with email `test@example.com` and belongs to tenants `t1` and `t2`.
- User B is a primary user with email `test@example.com` and belongs to tenant `t2`.

This is not allowed because there are two primary users with the same email in tenant `t2`.
:::

For accounts to link, one user must be a primary user.
The resulting user ID of the linked accounts becomes the primary user's ID.
For example, if User A is a primary user with user ID `u1` and links to User B (a non-primary user) with user ID `u2`, the resulting user's primary ID becomes `u1`.
The recipe ID remains `u1` for User A and `u2` for User B.

**Tenant Considerations:**

*   When designating a user as a primary user, the system verifies the primary user condition (as defined above) across all tenants to which the user belongs.
*   When linking two accounts, the primary user condition and account linking condition must satisfy across the union of all tenants to which the primary and non-primary users belong. For example, if User A (tenant `t1`, `t2`) links to User B (tenant `t3`), the system checks the conditions across `t1`, `t2`, and `t3`.

### Primary user ID and recipe user ID

For most purposes, you care about the user's primary user ID.
For example, when a user with two login methods, email password and social login, logs in, you get back the same primary user ID when you get their user ID from the session (or read the `sub` claim in the JWT).

However, if you want to identify what the login method used for the current session is, you can use the session's `recipeUserId`.
Then you can compare its value to the `recipeUserId` in each of the `loginMethods` in the user object.

Some functions from the backend SDK also accept a `recipeUserId` as a parameter.
For example, the `updateEmailOrPassword` function from the `emailpassword` recipe takes in a `recipeUserId` to determine which login method needs the update.
If it took a `string` user ID instead, and you passed it a user's primary user ID, it may unintentionally lead to updating the wrong login method's email or password. It may also throw an error if the primary user is not an email password user.

### User unlinking

User unlinking is the process of removing a login method from a user. For example, if a user has both email password and social login, and they want to remove their social login, you can use the unlinking function from the backend SDK.

A few scenarios exist here:
1. If unlinking a login method that **is not** associated with the primary user, it results in two users: one as the primary user and the other as the non-primary user.
For example, if User A (primary user, with email password login) links with User B (social login), and then you unlink User B, this results in two separate users: User A (primary user), with one login method (email password) and User B (non-primary user) with social login.
The primary user ID of user B changes to be equal to their recipe user ID.
2. If you unlink a login method associated with the primary user, it deletes the login method of the primary user ID.
For example, if User A (primary user, with email password login) links with User B (social login), and then you unlink User A, this results in the deletion of the email password user.
Only User B remains, which is a social login user, and its primary user ID equals User A's primary user ID (even though the system deleted the login method for A).
Any metadata, role, sessions info continues to exist.
3. If unlinking a User A which is a primary user ID, but it has not linked users, it results in this user becoming a non-primary user.

:::important
All the above checks happen automatically. You don't need to worry about them. But it is important to understand what's happening.
:::

## Security 

Below is the list of all points in time when account linking occurs, and for each point, you can see the list of security checks that happen:

### During sign up

#### First case

- Email is `e1`
- Email verification: `false` (is the case with email password sign up or social login with a provider that does not require email verification)

##### Checks done:
- If there is no primary user with the same email, then sign up is not allowed if there exists any other non-primary account with the same email and that account is not verified.
This occurs because if not, there is a risk that if this user signs up and becomes a primary user, the other account (which could be malicious), might resend a verification email. The user might click on it (since they signed up) and verify the malicious account, thereby linking it to their account.
This way, the malicious user gains access to the victim's account.
- If there exists a primary user with the same email, then the system rejects the sign up of this new user.
This occurs because if allowed, and this sign up is from a malicious user, then the actual user (the primary user owner) may get an email for verification, and might click it (since they did sign up previously).
This causes the new, malicious account to link, thereby giving the malicious user access to the victim's account.

###### What users see: 
- In case of email password login, users see an account already exists error. In this case, they can try logging in with another method, or go through the password reset flow, which creates a new email password account for them as well as verify it.
- In case of social login, users see that they should try a different login method for security reasons.

#### Second case

- Email is `e1`
- Email verified: `true` (this is the case with social login with a provider that requires email verification, like Google, or it could be a passwordless sign up)

##### Checks done:
- Same as in the first case. 
- If there exists a primary user with the same email, then the system allows sign up only if there exists at least one login method in the primary user with email `e1` which the system has verified.
This occurs because if not, then the following account takeover is possible:
    - Malicious user signs up with email password, with email `e2`, verifies it, and becomes a primary user.
    - They then change their email to `e1`, and keep it in an unverified state.
    - The actual user (victim) does a Google sign in with email `e1`.
    - If this sign up is not stopped, then the new sign up links to the primary user, and the malicious user gains access to the victim's account.

##### What users see: 
- Users see that they should try a different login method for security reasons.

### During sign in

#### First case
- Email is `e1`
- Email verified: `false`
- User is not a primary user

##### Checks done:
- If there exists another user with the same email, and they are not a primary user, but their email remains unverified, the system disallows this sign in because if it allowed it, and this user verifies their email, it results in this user becoming a primary user.
If the other account then sends an email verification email, this user may click on it (they may not get too suspicious), and verify the other account, thereby linking it to their account.
This way, the other account, which may belong to a malicious user, gains access to the victim's account.
- If there exists another user with the same email, and they are not a primary user, the system disallows signing in.
This occurs because if allowed, and this sign in is from a malicious user, then the actual user (the primary user owner) may get an email for verification, and might click it (since they did sign up previously).
This causes the new, malicious account to link, thereby giving the malicious user access to the victim's account.

##### What users see:
- For email password sign in, users see a wrong credentials error message.
This prompts them to go through the password reset flow, which also marks the email as verified, thereby allowing them to sign in.
This also blocks sign ins from malicious users, since the new password is only known to the actual owner of the email.
- For passwordless or social login, users see that they should try a different login method for security reasons.

#### Second case
- The user first does a social login sign up with email `e1`.
- They then change their email to `e2` on the provider and tries signing in again.
- The third party provider does not verify emails, resulting in `e2` remaining unverified.

##### Checks done:
- If the social login user is **not** a primary user, and there exists another primary user with email `e2`, then the system disallows sign in here.
This occurs because if allowed, and this sign in is from a malicious user, then the actual user (the primary user owner) may get an email for verification, and might click it (since they did sign up previously).
This causes the new, malicious account to link, thereby giving the malicious user access to the victim's account.
- If this user is a primary user, and there exists another primary user with email `e2`, the system disallows sign in because there can't be two primary users with the same email.
The system rejects the email update which happens during sign in for social login.

##### What users see:
- For the first point, users see a message asking them to try a different login method, or contact support for security reasons.
- For the second case, users see that email update is not allowed and to contact support.

### During the password reset flow

- Malicious user has email password and a social login account with email `e1`, and the system links them both.
- They then change their email to `e2` for the email password login, which belongs to the victim.
- Actual owner of `e2` tries to sign up, but sees that their account already exists (Case 1), they then try to sign in, but can't cause they don't know the password.
They try the password reset flow.

#### Checks done:
- In this case, we deny generating the password reset token because if we did, then the real user would change the password of the email password account, and also mark it as verified.
They would have access to the account, however, the malicious user could also then login using social login (with email `e1`) to access the same account. 

During password reset, the system does not generate a token if the email password account for that email associates with a primary account that also has other emails / phone numbers. If the email for which the password is being reset is not verified for any of the login methods in that primary user, the token is not generated.

#### What users see:
- They see a message telling them that the reset password link was not generated because of account takeover risk, and to contact support.

### During the email update flow:
- A user has email `e1`, and they want to change it to email `e2`

#### Checks done:
- If the user's account is not a primary user, and there exists another primary user with email `e2`, then the system disallows email update here.
This occurs because if allowed, and this email update is from a malicious user, then the actual user (the primary user owner) may get an email for verification, and might click it (since they did sign up previously).
This causes the system to link the new, malicious account, thereby giving the malicious user access to the victim's account.
- If this user is a primary user, and there exists another primary user with email `e2`, the system disallows email update because there can't be two primary users with the same email.

#### What users see:
- If the email update is happening during sign in of social login, users see a message that email update is not allowed and to contact support.
- If this is happening post login (from a settings page), then you can send any message you want to the user, since this would be your custom API.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/account-linking/automatic-account-linking" label="Automatic Account Linking" />
  <ReferenceCard href="/docs/post-authentication/account-linking/manual-account-linking" label="Manual Account Linking" />
  <ReferenceCard href="/docs/post-authentication/account-linking/link-social-accounts" label="Link Social Accounts" />
  <ReferenceCard href="/docs/post-authentication/account-linking/add-passwords-to-an-existing-account" label="Add Passwords to an Existing Account" />
</ReferenceCard.Grid>

# Post Authentication - Account Linking -  Automatic account linking
Source: https://supertokens.com/docs/post-authentication/account-linking/automatic-account-linking

## Overview

Automatic account linking is a feature that allows users to automatically sign in to their existing account using more than one login method. On a high level, SuperTokens automatically links the accounts for the different login methods provided that:
- Their emails or phone numbers are the same.
- They have verified their emails or phone numbers.

SuperTokens ensures that accounts are automatically linked only if there is no risk of account takeover.

## Before you start



## Steps

### 1. Enable the recipe

You can enable this feature by providing the following callback implementation on the backend SDK:

<Tabs>
<Tab value="nodejs">

```tsx

// Prevent account linking if the user already exists in your database
function checkIfUserHasAssociatedInformation(accountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined): boolean {
  if(!accountInfo.recipeUserId || !user) return false;

  const userId = accountInfo.recipeUserId.getAsString();
  const hasAssociatedInformation = false

  return hasAssociatedInformation;
}

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: any) => {
                // This step is required if you are saving user information in your own database.
                const hasAssociatedInformation = checkIfUserHasAssociatedInformation(newAccountInfo, user);
                if (hasAssociatedInformation) {
                    return {
                        shouldAutomaticallyLink: false,
                    }
                }
                return {
                    shouldAutomaticallyLink: true,
                    shouldRequireVerification: true
                }
            }
        })
        // highlight-end
    ]
});
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import accountlinking
from supertokens_python.types import User
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.accountlinking.types import AccountInfoWithRecipeIdAndUserId, ShouldNotAutomaticallyLink, ShouldAutomaticallyLink
from typing import Dict, Any, Optional, Union

# Prevent account linking if the user already exists in your database
async def check_if_user_has_associated_information(account_info: AccountInfoWithRecipeIdAndUserId, user: Optional[User]) -> bool:
    if not account_info.recipe_user_id or not user:
        return False

    _user_id = account_info.recipe_user_id.get_as_string()
    # Add your own implementation here
    has_associated_information = False

    return has_associated_information

async def should_do_automatic_account_linking(
    new_account_info: AccountInfoWithRecipeIdAndUserId,
    user: Optional[User],
    session: Optional[SessionContainer],
    tenant_id: str,
    user_context: Dict[str, Any]
) -> Union[ShouldNotAutomaticallyLink, ShouldAutomaticallyLink]:
    has_associated_information = await check_if_user_has_associated_information(new_account_info, user)
    # This step is required if you are saving user information in your own database.
    if has_associated_information:
        return ShouldNotAutomaticallyLink()
    
    return ShouldAutomaticallyLink(should_require_verification=True)

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework='...', # type: ignore
    recipe_list=[
        accountlinking.init(should_do_automatic_account_linking=should_do_automatic_account_linking)
    ],
)
```

</Tab>
</Tabs>

<Accordion>

## Input 

| Argument | Type | Description |
|----------|------|-------------|
| `newAccountInfo` | `AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }` | Contains information about the user whose account is going to link or become a primary user. Includes email, social login info, phone number, and login method (`emailpassword`, `thirdparty`, or `passwordless`). May contain `recipeUserId` during account linking. Note: When `newAccountInfo.recipeUserId !== undefined && user !== undefined`, extra logic checks if the user ID has associated data in your application db to prevent data loss. |
| `user` | `User \| undefined` | If not `undefined`, indicates `newAccountInfo` user links to this user. If `undefined`, `newAccountInfo` user becomes a primary user. |
| `session` | `SessionContainerInterface \| undefined` | Session object of the user who is linking. `undefined` for first factor login. Defined if user completed first factor and calls sign up/in API again (MFA or social login linking). |
| `tenant` | `string` | ID of the tenant the user is signing in/up to. |
| `userContext` | `any` | User defined context object. |

## Output

| Argument | Type | Description |
|----------|------|-------------|
| `shouldAutomaticallyLink` | `boolean` | If `true`, `newAccountInfo` links or becomes primary user during API call (subject to security checks). If `false`, no account linking operation occurs. |
| `shouldRequireVerification` | `boolean` | If `true`, account linking only happens if `newAccountInfo` verifies. **Strongly recommended to keep as `true` for security.** |

</Accordion>

<br />

:::important
If you are returning `shouldRequireVerification` as `true`, then you need to also [enable the email verification recipe](/docs/additional-verification/email-verification/initial-setup) in `REQUIRED` mode. This means that if the login method does not inherently verify the email (like for email password login), SuperTokens requires the user to go through the email verification flow first. Then, it attempts auto linking of the account. For other login methods like sign in with Google, the email is already verified during login. The user does not need to verify the email again, and account linking occurs immediately.

If you enable email verification in `OPTIONAL` mode, the user can access the account after email password login. However, account linking only occurs after they verify their email later on. This is risky because while the user had access to their email password account after sign up, they could lose access after verification and account linking completes due to the change in the primary user ID. A callback is available to help migrate data from one user ID to another.
:::

You can use the input of the function to dynamically decide if you want to do account linking for a particular user and / or login method or not.

## References

### Automatic account linking scenarios

#### During sign up

If there exists another account with the same email or phone number within the current tenant, the new account links to the existing account if:
    - The existing account is a primary user
    - If `shouldRequireVerification` is `true`, the new account needs creation via a method that has the email as verified (for example via passwordless or google login). If the new method doesn't inherently verify the email (like in email password login), the accounts link post email verification.
    - Your implementation for `shouldDoAutomaticAccountLinking` returns `true` for the `shouldAutomaticallyLink` boolean.

#### During sign in

If the current user is not already linked and if there exists another user with the same email or phone number within the current tenant, the accounts link if:
    - The user signing into is not a primary user, and the other user with the same email / phone number is a primary user
    - If `shouldRequireVerification` is `true`, the current account (that's signing into) has its email as verified.
    - Your implementation for `shouldDoAutomaticAccountLinking` returns `true` for the `shouldAutomaticallyLink` boolean.

#### After email verification

If the current user whose email got verified is not a primary user, and there exists another primary user in the same tenant with the same email, then the two accounts link if:
    - Your implementation for `shouldDoAutomaticAccountLinking` returns `true` for the `shouldAutomaticallyLink` boolean.

:::info no-title
For a primary user, if two login methods (L1 & L2) share the same email, but L1's email verifies and L2's does not, SuperTokens automatically verifies L2's email under these conditions:
-   The user logs in with L2.
-   The `updateEmailOrPassword` (email password recipe) or `updateUser` (passwordless recipe) function calls to update L2's email to match L1's.
:::

#### During the password reset flow

If there already exists a user with the same email in a non email password recipe (social login for example), and the user is doing a password reset flow, a new email password user creates and links to the existing account if:
    - The non email password user is a primary user.
    - Your implementation for `shouldDoAutomaticAccountLinking` returns `true` for the `shouldAutomaticallyLink` boolean.

:::info Email update implications
When updating a user's login email, SuperTokens ensures account linking conditions remain valid.
A primary user's email cannot update to match another primary user's email.

User A has login methods `AL1` (email `e1`) and `AL2` (email `e1`). User B has login methods `BL1` (email `e2`) and `BL2` (email `e3`). Updating `AL1`'s email to `e2` or `e3` is not allowed, as it would create two primary users with the same email.

**Email updates occur in these scenarios:**

*   `updateEmailOrPassword` function (email password recipe)
*   `updateUser` function (passwordless recipe)
*   Social login (if email from provider has changed)

If the update violates account linking rules, the operation fails:

*   Function calls return a status indicating the update was impossible.
*   Social login API calls return a status prompting the user to contact support.
:::

### User data changes during account linking

When two accounts link, the primary user ID of the non primary user changes.
For example, if User A has a primary user ID `p1` and user B, which is a non primary user, has a user ID of `p2`, and they link, then the primary user ID of User B changes to `p1`.

This has an effect that if the user logs in with login method from User B, the `session.getUserId()` returns `p1`.
If there was any older data associated with User B (against user ID `p2`), in your database, that data essentially becomes "lost".

To prevent this scenario, you should:
- Make sure that you return `false` for `shouldAutomaticallyLink` boolean in the `shouldDoAutomaticAccountLinking` function implementation if there exists a `recipeUserId` in the `newAccountInfo` object, and if you have some information related to that user ID in your own database.
This appears in the [code snippet above](#enabling-automatic-account-linking).
- If you do not want to return `false` in this case, and want the accounts to link, then make sure to implement the `onAccountLinked` callback:
<br />
    ```tsx

    supertokens.init({
        supertokens: {
            connectionURI: "...",
            apiKey: "..."
        },
        appInfo: {
            apiDomain: "...",
            appName: "...",
            websiteDomain: "..."
        },
        recipeList: [
            AccountLinking.init({
                shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: any) => {
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: true
                    }
                },
                // highlight-start
                onAccountLinked: async (user: User, newAccountInfo: RecipeLevelUser, userContext: any) => {
                    let olderUserId = newAccountInfo.recipeUserId.getAsString()
                    let newUserId = user.id;

                    // TODO: migrate data from olderUserId to newUserId in your database... 
                }
                // highlight-end
            })
        ]
    });
    ```

:::caution
If your logic in `onAccountLinked` throws an error, then it is not called again, and still results in linking the accounts. However, the end user would see an error on the UI as the API returns a `500` status code. They can retry the login action and log into the primary user's account as expected. 
:::

### Error status codes

The following is a list of error status codes that the end user might see during their interaction with the login UI (as a general error message in the pre-built UI).

<Accordion px="4">

## `ERR_CODE_001` 

- This can happen during creating a password reset code in the email password flow:
    - API path and method: `/user/password/reset/token POST` 
    - Output JSON:
    ```json
    {
        "status": "PASSWORD_RESET_NOT_ALLOWED",
        "reason":
            "Reset password link was not created because of account take over risk. Please contact support. (ERR_CODE_001)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:

    <img src="/img/account-linking/err_001.png" alt="pre-built UI screenshot showing error message for ERR_CODE_001." style={{ height: "400px" }}/>

- Below is the scenario for when this status returns:
    
A malicious user, User A, which is a primary user, has login methods with email `e1` (social login) and email `e1` (`emailpassword` login). If user A changes their `emailpassword` email to `e2` (which is in unverified state), and the real user of `e2` (the victim) tries to sign up via email password, they see a message saying that the email already exists. The victim may then try to do a password reset (thinking they had previously signed up). If this happens, and the victim resets the password (since they are the real owner of the email), then they can login to the account, and the attacker can spy on what the user is doing via their third party login method.

To prevent this scenario, enforcement ensures that the password link is only generated if the primary user has at least one login method that has the input email ID and verifies it, or if not, checks that the primary user has no other login method with a different email, or phone number. If these cases are not satisfied, then the system returns the error code `ERR_CODE_001`.

- To resolve this, you would have to manually verify the user's identity and check that they own each of the emails / phone numbers associated with the primary user. Once verified, you can manually mark the email from the email password account as verified, and then ask them to go through the password reset flow once again. If they do not own each of the emails / phone numbers associated with the account, you can manually unlink the login methods which they do not own, and then ask them to go through the password reset flow once again. **You can do these actions using the user management dashboard.**

## `ERR_CODE_002`

- This can happen during the passwordless recipe's create or consume code API (during sign up):
    - API path and method: `/signinup/code POST` or `/signinup/code/consume POST`
    - Output JSON:
    ```json
    {
        "status": "SIGN_IN_UP_NOT_ALLOWED",
        "reason": "Cannot sign in / up due to security reasons. Please try a different login method or contact support. (ERR_CODE_002)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:

    <img src="/img/account-linking/err_002.png" alt="pre-built UI screenshot showing error message for ERR_CODE_002." style={{ height: "400px" }} />

- Below is an example scenario for when this status returns (one amongst many):
A user is trying to sign up using passwordless login method with email `e1`. There exists an email password login method with `e1`, which remains unverified (owned by an attacker). If this scenario occurs, and then the attacker initiates the email verification flow for the email password method, the real user might click on the verification email (since they signed up, they do not get suspicious), and then the attacker's login method links to the passwordless login method. This way, the attacker gains access to the user's account.

    To prevent this, sign up with passwordless login is not allowed in case there exists another account with the same email and remains unverified.

- To resolve this issue, you should ask the user to try another login method (which already has their email), or then mark their email as verified in the other account that has the same email, before asking them to retry passwordless login. **You can do these actions using the user management dashboard.**

## `ERR_CODE_003`

This used to be an error code which is no longer valid and you can ignore it.

## `ERR_CODE_004`
  
- This can happen during the third party recipe's `/signinup` API (during sign in):
    - API path and method: `/signinup POST`
    - Output JSON:
    ```json
    {
        "status": "SIGN_IN_UP_NOT_ALLOWED",
        "reason": "Cannot sign in / up due to security reasons. Please try a different login method or contact support. (ERR_CODE_004)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:
    <img src="/img/account-linking/err_004.png" alt="Pre-built UI screenshot showing error for message ERR_CODE_004." style={{ height: "400px" }}/>

- Below is an example scenario for when this status returns (one amongst many):
There exists a `thirdparty` user with email `e1`, sign in with Google (owned by the victim, and the email is verified). There exists another `thirdparty` login method with email, `e2` (owned by an attacker), such as login with GitHub. The attacker then goes to their GitHub and changes their email to `e1` (which is in unverified state). The next time the attacker tries to login, via GitHub, they see this error code. Login is prevented, because if it wasn't, then the attacker might send an email verification link to `e1`, and if the victim clicks on it, then the attacker's account will link to the victim's account.

- To resolve this issue, you can delete the login method that has the unverified email, or if manually mark the unverified account as verified (if you confirm the identity of its owner). **You can do these actions using the user management dashboard.**

## `ERR_CODE_005`

- This can happen during the third party recipe's `signinup` API (during sign in):
    - API path and method: `/signinup POST`
    - Output JSON:
    ```json
    {
        "status": "SIGN_IN_UP_NOT_ALLOWED",
        "reason": "Cannot sign in / up because new email cannot be applied to existing account. Please contact support. (ERR_CODE_005)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:
    <img src="/img/account-linking/err_005.png" alt="Pre-built UI screenshot showing error message for ERR_CODE_005." style={{ height: "400px" }}/>

- Below is as example scenario for when this status returns (one amongst many):
There exists a primary, third party user with email `e1`, sign in with Google. There exists another email password user with email `e2`, which is a primary user. If the user changes their email on Google to `e2`, and then try logging in via Google, they see this error code. This occurs because if it wasn't, then it would result in two primary users having the same email, which violates one of the account linking rules.

- To resolve this issue, you can make one of the primary users as non primary (use the unlink button against the login method on the user management dashboard). Once the user is not a primary user, you can ask the user to re-login with that method, and it should auto link that account with the existing primary user.

## `ERR_CODE_006`

- This can happen during the third party recipe's `signinup` API (during sign up):
    - API path and method: `/signinup POST`
    - Output JSON:
    ```json
    {
        "status": "SIGN_IN_UP_NOT_ALLOWED",
        "reason": "Cannot sign in / up because new email cannot be applied to existing account. Please contact support. (ERR_CODE_006)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:
    <img src="/img/account-linking/err_006.png" alt="Pre-built UI screenshot showing error message for ERR_CODE_006." style={{ height: "400px" }}/>

- Below is as example scenario for when this status returns (one amongst many):
A user is trying to sign up using third party login method with email `e1`. There exists an email password login method with `e1`, which remains unverified (owned by an attacker). If the third party sign up is allowed, and then the attacker initiates the email verification flow for the email password method, the real user might click on the verification email (since they signed up, they do not get suspicious), and then the attacker's login method links to the third party login method. This way, the attacker has access to the user's account.

    To prevent this, sign up with third party login is not allowed in case there exists another account with the same email and remains unverified.

- To resolve this issue, you should ask the user to try another login method (which already has their email), or then manually mark their email as verified in the other account that has the same email, before asking them to retry third party login. **You can do these actions using the user management dashboard.**

## `ERR_CODE_007`

- This can happen during the email password sign up API:
    - API path and method: `/signup POST`
    - Output JSON:
    ```json
    {
        "status": "SIGN_UP_NOT_ALLOWED",
        "reason": "Cannot sign up due to security reasons. Please try logging in, use a different login method or contact support. (ERR_CODE_007)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:
    <img src="/img/account-linking/err_007.png" alt="Pre-built UI screenshot showing error message for ERR_CODE_007." style={{ height: "400px" }}/>

- Below is as example scenario for when this status returns (one amongst many):
There exists a primary, social login account with email `e1`, sign in with Google. If an attacker tries to sign up with email password with email `e1`, the system sends an email verification email to the victim, and they may click it since they had previously signed up with Google. This links the attacker's account to the victim's account.

- To resolve this issue, you can ask the user to try and login, or go through the reset password flow.

## `ERR_CODE_008`

- This can happen during the email password sign in API:
    - API path and method: `/signin POST`
    - Output JSON:
    ```json
    {
        "status": "SIGN_IN_NOT_ALLOWED",
        "reason": "Cannot sign in due to security reasons. Please try resetting your password, use a different login method or contact support. (ERR_CODE_008)"
    }
    ```
    - The pre-built UI on the frontend displays this error in the following way:
    <img src="/img/account-linking/err_008.png" alt="Pre-built UI screenshot showing error message for ERR_CODE_008." style={{ height: "400px" }}/>

- Below is as example scenario for when this status returns (one amongst many):
There exists a primary, social login account with email `e1`, sign in with Google. There also exists an email password account (owned by the attacker) that remains unverified with the same email `e1` (this is not a primary user). If the attacker tries to sign in with email password, they see this error. This occurs because if it wasn't, then the attacker might send an email verification email on sign in, and the actual user may click on it (since they had previously signed up). Upon verifying that account, the system links the attacker's account to the victim's account.

- To resolve this issue, you can ask the user to try the reset password flow.

## `ERR_CODE_014`

- This can happen when adding a password to an existing session user:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_014)"
        }
        ```
- An example scenario of when in the following scenario:
- Let's say that the app configures to not have automatic account linking during the first factor.
    - A user creates an email password account with email `e1`, verifies it, and links social login account to it with email `e2`.
- The user logs out, and then creates a social login account with email `e1`. Then, they receive a request to add a password to this account. Since an email password account with `e1` already exists, SuperTokens tries and links that to this new account, but fails, since the email password account with `e1` is already a primary user.

- To resolve this, it is recommended to manually link the `e1` social login account with the `e1` email password account. Alternatively, enable automatic account linking for first factor to prevent the above scenario.

## `ERR_CODE_015`

- This can happen when adding a password to an existing session user:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_015)"
        }
        ```
- An example scenario of when in the following scenario:
    - A user creates a social login account with email `e1` which becomes a primary user.
    - The user logs out, and creates another social login account with email `e2`, which also becomes a primary user.
- The user receives a request to add a password for the new account with an option to also specify an email with it (this is strange, but theoretically possible). They enter the email `e1` for the email password account.
- This causes this type of error since the linking of the new social login and email account fails since there already exists another primary user with the same (`e1`) email.

- To resolve this, it is recommended not allowing users to specify an email when asking them to add a password for their account.

## `ERR_CODE_016`

- This can happen when adding a password to an existing session user:
    - API Path is `/signup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_UP_NOT_ALLOWED",
            "reason": "Cannot sign up due to security reasons. Please contact support. (ERR_CODE_016)"
        }
        ```
- An example scenario of when in the following scenario:
    - Let's say that the app is configured to not have automatic account linking during the first factor.
    - A user signs up with a social login account using Google with email `e1`, and they add another social account, with Facebook, with the same email.
    - The user logs out and creates another social login account with email `e1` (say GitHub), and then tries and adds a password to this account with email `e1`. Here, SuperTokens tries and makes the GitHub login a primary user, but fails, since the email `e1` is already a primary user (with Google login). 

- To resolve this, it is recommended that you manually link the `e1` GitHub social login account with the `e1` Google social login account. Or you can enable automatic account linking for first factor and this way, the above scenario will not happen.

## `ERR_CODE_020`

- This can happen during association of a third party login to an existing session's account.
    - API Path is `/signinup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_020)"
        }
        ```
- This can happen when the third party account that is trying to link to the session's account is not verified. It could happen when you are trying to associate a social login account to a user, but that social account's email is not verified (and if the email of that account is not the same as the current session's account's email). 
- To resolve this, you can return `shouldRequireVerification` as `false` in the `shouldDoAutomaticAccountLinking` function implementation, or you can only allow users to link social login accounts that give verified accounts.

## `ERR_CODE_021`

- This can happen during association of a third party login to an existing session's account.
    - API Path is `/signinup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_021)"
        }
        ```
- This can happen when the third party account that is trying to link to the session's account is already linked with another primary user.

## `ERR_CODE_022`

- This can happen during association of a third party login to an existing session's account.
    - API Path is `/signinup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_022)"
        }
        ```
- This can happen when the third party account that is trying to link to the session's account has the same email as another primary user. 

## `ERR_CODE_023`

- This can happen during association of a third party login to an existing session's account.
    - API Path is `/signinup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_023)"
        }
        ```
- To link the third party user with the session user, we need to make sure that the session user is a primary user. However, that can fail if there exists another primary user with the same email as the session user, and in this case, this error returns to the frontend.

## `ERR_CODE_024`

- This happens during third party sign in, when the user is trying to sign in with a non-primary user, and the third party provider does not verify their email, and their exists a primary user with the same email. This can also happen the other way around wherein the user is trying to sign in with the primary user (unverified email), and there exists a non-primary user with the same email. 
    - API Path is `/signinup POST`.
    - Output JSON:
        ```json
        {
            "status": "SIGN_IN_UP_NOT_ALLOWED",
            "reason": "Cannot sign in / up due to security reasons. Please contact support. (ERR_CODE_024)"
        }
        ```
- You can resolve this by deleting the (non primary) user that has the same email ID, or by manually marking the email of the user as verified for the login method that they are trying to sign in with.

</Accordion>

#### Changing the error message on the frontend

If you want to display a different message to the user, or use a different status code, you can change them on the frontend via [the language translation feature](/docs/references/frontend-sdks/prebuilt-ui/translations).

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/account-linking/manual-account-linking" label="Manual account linking" />
  <ReferenceCard href="/docs/post-authentication/account-linking/link-social-accounts" label="Link social accounts" />
  <ReferenceCard href="/docs/post-authentication/account-linking/add-passwords-to-an-existing-account" label="Add passwords to account" />
  <ReferenceCard href="/docs/post-authentication/account-linking/important-concepts" label="Important concepts" />
  <ReferenceCard href="/docs/post-authentication/user-management/account-deduplication" label="Account deduplication" />
</ReferenceCard.Grid>

# Post Authentication - Account Linking -  Manual account linking
Source: https://supertokens.com/docs/post-authentication/account-linking/manual-account-linking

## Overview

Manual account linking allows you to take control of when and which accounts link.
With this, you can implement flows like:
- Connecting social login accounts to an existing account post login.
- Adding a password to an account that a social or passwordless login created.
- Linking accounts which don't have the same email or phone number, or have a different identifier altogether.

## Before you start



## Steps

### 1. Initialize the account linking recipe

<Tabs>
<Tab value="nodejs">

```tsx

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        AccountLinking.init()
        // highlight-end
    ]
});
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo, SupertokensConfig
from supertokens_python.recipe import accountlinking

init(
    app_info=InputAppInfo(
        app_name="...",
        api_domain="...",
        website_domain="...",
    ),
    supertokens_config=SupertokensConfig(
        connection_uri="...",
    ),
    framework='...', # type: ignore
    recipe_list=[
        accountlinking.init()
    ],
)
```

</Tab>
</Tabs>

In the above, SuperTokens does not automatically link accounts (during sign up or sign in APIs) by returning `shouldAutomaticallyLink: false`. Initializing the recipe is still important to use the functions from the SDK as shown below.

It is of course possible to [enable auto account linking](./automatic-account-linking) and still use the functions for manual account linking below.

### 2. Create a primary user

To link two accounts, you first need to make one of them a primary user:

<Tabs>
<Tab value="nodejs">

```tsx

async function makeUserPrimary(recipeUserId: RecipeUserId) {
    let response = await AccountLinking.createPrimaryUser(recipeUserId);
    if (response.status === "OK") {
        if (response.wasAlreadyAPrimaryUser) {
            // The input user was already a primary user and accounts can be linked to it.
        } else {
            // User is now primary and accounts can be linked to it.
        }
        let modifiedUser = response.user;
        console.log(modifiedUser.isPrimaryUser); // will print true
    } else if (response.status === "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR") {
        // This happens if there already exists another primary user with the same email or phone number
        // in at least one of the tenants that this user belongs to. 
    } else if (response.status === "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR") {
        // This happens if this user is already linked to another primary user.
    }
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.accountlinking.asyncio import create_primary_user
from supertokens_python.types import RecipeUserId

async def make_user_primary(recipe_user_id: RecipeUserId):
    response = await create_primary_user(recipe_user_id)
    if response.status == "OK":
        if response.was_already_a_primary_user:
            # The input user was already a primary user and accounts can be linked to it.
            pass
        else:
            # User is now primary and accounts can be linked to it.
            pass
        modified_user = response.user
        print(modified_user.is_primary_user)  # will print True
    elif response.status == "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR":
        # This happens if there already exists another primary user with the same email or phone number
        # in at least one of the tenants that this user belongs to. 
        pass
    elif response.status == "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR":
        # This happens if this user is already linked to another primary user.
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.accountlinking.syncio import create_primary_user
from supertokens_python.types import RecipeUserId

def make_user_primary(recipe_user_id: RecipeUserId):
    response = create_primary_user(recipe_user_id)
    if response.status == "OK":
        if response.was_already_a_primary_user:
            # The input user was already a primary user and accounts can be linked to it.
            pass
        else:
            # User is now primary and accounts can be linked to it.
            pass
        modified_user = response.user
        print(modified_user.is_primary_user)  # will print True
    elif response.status == "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR":
        # This happens if there already exists another primary user with the same email or phone number
        # in at least one of the tenants that this user belongs to. 
        pass
    elif response.status == "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR":
        # This happens if this user is already linked to another primary user.
        pass
```

</Tab>
</Tabs>

</Tab>
</Tabs>

### 3. Link accounts

Once a user has become a primary user, you can link other accounts to this user:

<Tabs>
<Tab value="nodejs">

```tsx

// we are linking the input recipeUserId to the primaryUserId
async function linkAccounts(primaryUserId: string, recipeUserId: RecipeUserId) {
    let response = await AccountLinking.linkAccounts(recipeUserId, primaryUserId);
    if (response.status === "OK") {
        if (response.accountsAlreadyLinked) {
            // The input users were already linked
        } else {
            // The two users are now linked
        }
        let modifiedUser = response.user;
        console.log(modifiedUser.loginMethods); // this will now contain the login method of the recipeUserId as well.
    } else if (response.status === "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR") {
        // This happens if there already exists another primary user with the same email or phone number
        // as the recipeUserId's account. 
    } else if (response.status === "INPUT_USER_IS_NOT_A_PRIMARY_USER") {
        // This happens if the input primaryUserId is not actually a primary user ID.
        // You can call createPrimaryUserId and call linkAccountsAgain
    } else if (response.status === "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR") {
        // This happens if the input recipe user ID is already linked to another primary user.
        // You can call unlink accounts on the recipe user ID and then try linking again.
    }
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.accountlinking.asyncio import link_accounts
from supertokens_python.types import RecipeUserId

async def link_accounts_helper(primary_user_id: str, recipe_user_id: RecipeUserId):
    response = await link_accounts(recipe_user_id, primary_user_id)
    if response.status == "OK":
        if response.accounts_already_linked:
            # The input users were already linked
            pass
        else:
            # The two users are now linked
            pass
        modified_user = response.user
        print(modified_user.login_methods)  # this will now contain the login method of the recipeUserId as well.
    elif response.status == "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR":
        # This happens if there already exists another primary user with the same email or phone number
        # as the recipeUserId's account. 
        pass
    elif response.status == "INPUT_USER_IS_NOT_A_PRIMARY_USER":
        # This happens if the input primaryUserId is not actually a primary user ID.
        # You can call create_primary_user and call link_accounts again
        pass
    elif response.status == "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR":
        # This happens if the input recipe user ID is already linked to another primary user.
        # You can call unlink_accounts on the recipe user ID and then try linking again.
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.accountlinking.syncio import link_accounts
from supertokens_python.types import RecipeUserId

def link_accounts_helper(primary_user_id: str, recipe_user_id: RecipeUserId):
    response = link_accounts(recipe_user_id, primary_user_id)
    if response.status == "OK":
        if response.accounts_already_linked:
            # The input users were already linked
            pass
        else:
            # The two users are now linked
            pass
        modified_user = response.user
        print(modified_user.login_methods)  # this will now contain the login method of the recipeUserId as well.
    elif response.status == "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR":
        # This happens if there already exists another primary user with the same email or phone number
        # as the recipeUserId's account. 
        pass
    elif response.status == "INPUT_USER_IS_NOT_A_PRIMARY_USER":
        # This happens if the input primaryUserId is not actually a primary user ID.
        # You can call create_primary_user and call link_accounts again
        pass
    elif response.status == "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR":
        # This happens if the input recipe user ID is already linked to another primary user.
        # You can call unlink_accounts on the recipe user ID and then try linking again.
        pass
```

</Tab>
</Tabs>

</Tab> 
</Tabs>

### 4. Unlink accounts

If you want to unlink an account from its primary user ID, you can use the following function:

<Tabs>
<Tab value="nodejs">

```tsx

async function unlinkAccount(recipeUserId: RecipeUserId) {
    let response = await AccountLinking.unlinkAccount(recipeUserId);
    if (response.status === "OK") {
        if (response.wasLinked) {
            // This means that we unlinked the account from its primary user ID
        } else {
            // This means that the user was never linked in the first place
        }

        if (response.wasRecipeUserDeleted) {
            // This is true if we call unlinkAccount on the recipe user ID of the primary user ID user.
            // We delete this user because if we don't and we call getUserById() on this user's ID, SuperTokens
            // won't know which user info to return - the primary user, or the recipe user.
            // Note that even though the recipe user is deleted, the session, metadata, roles etc for this
            // primary user is still intact, and calling getUserById(primaryUserId) will still return
            // the user object with the other login methods.
        } else {
            // There not exists a user account which is not a primary user, with the recipeUserId = to the 
            // input recipeUserId.
        }

    }
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

<Tabs>
<Tab value="asyncio">

```python
from supertokens_python.recipe.accountlinking.asyncio import unlink_account
from supertokens_python.types import RecipeUserId

async def unlink_account_helper(recipe_user_id: RecipeUserId):
    response = await unlink_account(recipe_user_id)
    if response.was_linked:
        # This means that we unlinked the account from its primary user ID
        pass
    else:
        # This means that the user was never linked in the first place
        pass

    if response.was_recipe_user_deleted:
        # This is true if we call unlink_account on the recipe user ID of the primary user ID user.
        # We delete this user because if we don't and we call get_user_by_id() on this user's ID, SuperTokens
        # won't know which user info to return - the primary user, or the recipe user.
        # Note that even though the recipe user is deleted, the session, metadata, roles etc for this
        # primary user is still intact, and calling get_user_by_id(primary_user_id) will still return
        # the user object with the other login methods.
        pass
    else:
        # There now exists a user account which is not a primary user, with the recipe_user_id equal to the 
        # input recipe_user_id.
        pass
```

</Tab>
<Tab value="syncio">

```python
from supertokens_python.recipe.accountlinking.syncio import unlink_account
from supertokens_python.types import RecipeUserId

def unlink_account_helper(recipe_user_id: RecipeUserId):
    response = unlink_account(recipe_user_id)
    if response.was_linked:
        # This means that we unlinked the account from its primary user ID
        pass
    else:
        # This means that the user was never linked in the first place
        pass

    if response.was_recipe_user_deleted:
        # This is true if we call unlink_account on the recipe user ID of the primary user ID user.
        # We delete this user because if we don't and we call get_user_by_id() on this user's ID, SuperTokens
        # won't know which user info to return - the primary user, or the recipe user.
        # Note that even though the recipe user is deleted, the session, metadata, roles etc for this
        # primary user is still intact, and calling get_user_by_id(primary_user_id) will still return
        # the user object with the other login methods.
        pass
    else:
        # There now exists a user account which is not a primary user, with the recipe_user_id equal to the 
        # input recipe_user_id.
        pass
```

</Tab>
</Tabs>

</Tab>
</Tabs>

### 5. Convert a `userId` into a `recipeUserId`

If you notice, the input to a lot of the functions above is of type `RecipeUserId`.
You can convert a string userID into a `RecipeUserId` in the following way:

<Tabs>
<Tab value="nodejs">

```tsx

async function getAsRecipeUserIdType(userId: string) {
    return SuperTokens.convertToRecipeUserId(userId);
}
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

```python
from supertokens_python.types import RecipeUserId

user_id = "some_user_id";
recipe_user_id = RecipeUserId(user_id)
```

</Tab>
</Tabs>

The reason for this type is that it prevents bugs wherein a function expects a recipe user ID (like `createNewSession`, or `updateEmailOrPassword` from email password recipe). However, you might pass in the primary user ID instead.

### 6. Other helper functions

Our SDK also exposes other helper functions:

- `AccountLinking.createPrimaryUserIdOrLinkAccounts`: Given a recipe user ID, this function attempts linking it with any primary user ID that has the same email or phone number associated with it. If no such primary user exists, this function makes the input user account a primary one.

- `AccountLinking.getPrimaryUserThatCanBeLinkedToRecipeUserId`: Given a recipe user ID, this function returns a primary user ID which this user can link to, based on matching emails / phone numbers. If no such primary user exists, this function returns `undefined`.

- `AccountLinking.canCreatePrimaryUser`: Given a recipe user ID, this function returns a status `OK` if the user can become a primary user, and a different status otherwise (indicating why it can't become a primary user). A user can become a primary user if there exists no other primary user with the same email or phone number across all the tenants that this user belongs to.

- `AccountLinking.canLinkAccounts`: Given a `recipeUserId` and a primary user ID, this function returns a status `OK` if the accounts can link, and if not, it returns a different status (indicating why the accounts can't link). Accounts can link if the recipe user ID is not already linked to another primary user, and if the resulting primary user does not have any email / phone number in common with another primary user across all the tenants that it belongs to.

- `AccountLinking.isSignUpAllowed`: Given the login info (email for example) of the new user, who is trying to sign up, this function returns `true` if it's safe to allow them to sign up, `false` otherwise. See the [error codes in the automatic account linking page](./automatic-account-linking#support-status-codes) to see why this might return `false`.

- `AccountLinking.isSignInAllowed`: Given the login info (email for example) of a user, who is trying to sign in, this function returns `true` if it's safe to allow them to sign in, `false` otherwise. See the [error codes in the automatic account linking page](./automatic-account-linking#support-status-codes) to see why this might return `false`.

- `AccountLinking.isEmailChangeAllowed`: Given the recipe user ID and the new email for update, this function returns `true` if it's safe to update the email, else `false`. Below are the conditions in which `false` returns:
    - If the input recipe user is a primary user, then ensure that the new email doesn't belong to any other primary user. If it does, the change is not allowed since multiple primary users can't have the same email.
    - If the recipe user is not a primary user, and if the new email is not verified, then check if there exists a primary user with the same email. If it exists, do not allow the email change. The disallowance occurs because if this email changes, and the system sends an email verification email, then the primary user may end up clicking on the link by mistake, causing account linking to happen which can result in account takeover if this recipe user is malicious.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/account-linking/automatic-account-linking" label="Automatic account linking" />
  <ReferenceCard href="/docs/post-authentication/account-linking/link-social-accounts" label="Link social accounts" />
  <ReferenceCard href="/docs/post-authentication/account-linking/add-passwords-to-an-existing-account" label="Add passwords to account" />
  <ReferenceCard href="/docs/post-authentication/user-management/account-deduplication" label="Account deduplication" />
</ReferenceCard.Grid>

# Post Authentication - Account Linking -  Link social accounts
Source: https://supertokens.com/docs/post-authentication/account-linking/link-social-accounts

## Overview

The following guide shows you how to link a social account to an existing user account.

The idea here is to reuse the existing sign up APIs, but call them with a session's access token.
The APIs then create a new recipe user for that login method based on the input, and then link that to the session user.
Of course, there are security checks done to ensure there is no account takeover risk, and this guide goes through them as well.

## Before you start



We do not provide pre-built UI for this flow since it's probably something you want to add in your settings page or during the sign up process. This guide focuses on which APIs to call from your own UI.

The frontend code snippets below refer to the `supertokens-web-js` SDK. You can continue to use this even if you have initialised the `supertokens-auth-react` SDK, on the frontend. 

## Steps

### 1. Enable account linking on the backend SDK

<Tabs>
<Tab value="nodejs">

```tsx

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: any) => {
                if (user === undefined) {
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: true
                    }
                }
                if (session !== undefined && session.getUserId() === user.id) {
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: true
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                }
            }
        })
        // highlight-end
    ]
});
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
</Tabs>

In the above implementation of `shouldDoAutomaticAccountLinking`, account linking is only allowed if the input session is present. This means that the process is trying to link a social login account to an existing session user. Otherwise, account linking is not allowed, which means that first factor account linking does not occur. If you want to enable that too, you can see [the automatic account linking page](./automatic-account-linking).

### 2. Create a UI to show social login buttons and handle login

First, you need to detect which social login methods are already linked to the user. You can do this by inspecting the [user object](/docs/references/backend-sdks/user-object) on the backend and checking the `thirdParty.id` property (the values are like `google`, `facebook` etc).

Then you have to create your own UI which asks the user to pick a social login provider to connect to. Once they click on one, redirect them to that provider's page. After login, the provider redirects the user back to your application (on the same path as the first factor login). You then call the APIs to consume the OAuth tokens and link the user.

The exact implementation of the above is available [in the initial setup documentation](/docs/authentication/social/initial-setup). The two big differences in the implementation are:
- When you call the `signinup` API, you need to provide the session's access token in the request. If you are using the frontend SDK, the frontend network interceptors automatically handle this. The access token enables the backend to get a session and then link the social login account to session user.
- New types of failure scenarios exist when calling the `signinup` API which are impossible during first factor login. To learn more about them, see the [error codes section](./automatic-account-linking#err_code_001) (> `ERR_CODE_008`).

### 3. Remove the social login access token and user profile info on the backend

Once you call the `signinup` API from the frontend, SuperTokens verifies the OAuth tokens and fetches the user's profile info from the third party provider. SuperTokens also links the newly created recipe user to the session user.

To fetch the new user object and also the third party profile, you can override the `signinup` recipe function:

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        // override the thirdparty sign in / up function
                        signInUp: async function (input) {

                            let existingUser: User | undefined = undefined;
                            if (input.session !== undefined) {
                                existingUser = await SuperTokens.getUser(input.session.getUserId());
                            }

                            let response = await originalImplementation.signInUp(input);

                            if (response.status === "OK") {

                                let accessToken = response.oAuthTokens["access_token"];

                                let firstName = response.rawUserInfoFromProvider.fromUserInfoAPI!["first_name"];

                                if (input.session !== undefined && response.user.id === input.session.getUserId()) {
                                    if (response.user.loginMethods.length === existingUser!.loginMethods.length + 1) {
                                        // new social account was linked to session user
                                    } else {
                                        // social account was already linked to the session
                                        // user from before
                                    }
                                }
                            }

                            return response;
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
</Tabs>

Notice in the above snippet that the check is for `input.session !== undefined && response.user.id === input.session.getUserId()`. This ensures that the custom logic runs only if it's linking a social account to your session account, and not during first factor login.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/account-linking/automatic-account-linking" label="Automatic Account Linking" />
  <ReferenceCard href="/docs/post-authentication/account-linking/add-passwords-to-an-existing-account" label="Add Passwords to an Account" />
  <ReferenceCard href="/docs/post-authentication/account-linking/manual-account-linking" label="Manual Account Linking" />
  <ReferenceCard href="/docs/authentication/social/initial-setup" label="Social Login Setup" />
  <ReferenceCard href="/docs/post-authentication/user-management/common-actions" label="User Management Actions" />
</ReferenceCard.Grid>

# Post Authentication - Account Linking -  Add passwords to an existing account
Source: https://supertokens.com/docs/post-authentication/account-linking/add-passwords-to-an-existing-account

## Overview

There may be scenarios in which you want to add a password to an account created using a social provider or passwordless login.
This guide walks you through how to do this.

The idea here is to reuse the existing sign up APIs, but call them with a session's access token.
The APIs then create a new recipe user for that login method based on the input, and then link that to the session user.
Of course, there are security checks done to ensure there is no account takeover risk, and this guide goes through them as well.

## Before you start



We do not provide pre-built UI for this flow since it's probably something you want to add in your settings page or during the sign up process. This guide focuses on which APIs to call from your own UI.

The frontend code snippets below refer to the `supertokens-web-js` SDK. You can continue to use this even if you have initialised the `supertokens-auth-react` SDK, on the frontend. 

## Steps

### 1. Enable account linking and `emailpassword` on the backend SDK

<Tabs >
<Tab value="nodejs">

```tsx

supertokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "..."
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        // highlight-start
        EmailPassword.init(),
        AccountLinking.init({
            shouldDoAutomaticAccountLinking: async (newAccountInfo: AccountInfoWithRecipeId & { recipeUserId?: RecipeUserId }, user: User | undefined, session: SessionContainerInterface | undefined, tenantId: string, userContext: any) => {
                if (user === undefined) {
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: true
                    }
                }
                if (session !== undefined && session.getUserId() === user.id) {
                    return {
                        shouldAutomaticallyLink: true,
                        shouldRequireVerification: true
                    }
                }
                return {
                    shouldAutomaticallyLink: false
                }
            }
        })
        // highlight-end
    ]
});
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
</Tabs>

In the above implementation of `shouldDoAutomaticAccountLinking`, account linking is only allowed if the input session is present. This means that the system links an email password account to an existing session user. Otherwise, account linking is not allowed, which means that first factor account linking is not enabled. If you want to enable that too, you can see the [automatic account linking documentation](./automatic-account-linking).

### 2. Create a UI to show a password input to the user and handle the submit event

:::important
If you want to use password based auth as a second factor, or for step up auth, see the docs in the [MFA recipe](/docs/additional-verification/mfa/introduction) instead. The guide below is only meant for if you want to add a password for a user and allow them to login via email password for first factor login.
:::

First, you need to detect if there already exists a password for the user. You can do this by inspecting the [user object](/docs/references/backend-sdks/user-object) on the backend and checking if there is an `emailpassword` login method.

Then, if no such login method exists, you have to show a UI in which the user can add a password to their account. The [password validation documentation](/docs/authentication/email-password/customize-the-sign-up-form#change-field-validators#changing-the-default-email-and-password-validators) contains the default password validation rules.

You also need to fetch the email of the user before you call the email password sign up API. You can fetch this using the user object. If the `user` object does not have an email (which can only happen if the first factor is phone OTP), then you should ask the user to go through an email OTP flow via the passwordless recipe. This step should occur before asking them to set a password. The email OTP flow also results in creating a passwordless user account and linking it to the session user.

Once you have the email on the frontend, you should call the sign up API. The two big differences in the implementation are:
- When you call the sign up API, you need to provide the session's access token in the request. If you are using the frontend SDK, this process happens automatically via the frontend network interceptors. The access token enables the backend to get a session and then link the email password account to session user.
- New types of failure scenarios exist when calling the sign up API which are impossible during first factor login. To learn more about them, see the [error codes section](./automatic-account-linking#err_code_001) (> `ERR_CODE_008`).

### 3. Check for email match in the backend sign up API
Since the frontend specifies the email, verify it in the backend API before using it (since the frontend shouldn't be trusted). You can do this by overriding the email password sign up API:

<Tabs >
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signUpPOST: async function (input) {
                            if (input.session !== undefined) {
                                // this means that we are trying to add a password to the session user
                                const inputEmail = input.formFields.find(f => f.id === "email")!.value;
                                let sessionUserId = input.session.getUserId();
                                let userObject = await SuperTokens.getUser(sessionUserId);
                                if (userObject!.emails.find(e => e === inputEmail) === undefined) {
                                    // this means that the input email does not belong to this user.
                                    return {
                                        status: "GENERAL_ERROR",
                                        message: "Cannot use this email to add a password for this user"
                                    }
                                }
                            }
                            return await originalImplementation.signUpPOST!(input);
                        }
                    }
                }
            }
            // highlight-end
        }),
        Session.init({ /* ... */ })
    ]
});
```

</Tab>
<Tab value="go">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
<Tab value="python">

:::note
At the moment this feature is not supported through the Go SDK.
:::

</Tab>
</Tabs>

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/post-authentication/account-linking/automatic-account-linking" label="Automatic account linking" />
  <ReferenceCard href="/docs/post-authentication/account-linking/link-social-accounts" label="Link social accounts" />
  <ReferenceCard href="/docs/post-authentication/account-linking/manual-account-linking" label="Manual account linking" />
  <ReferenceCard href="/docs/authentication/email-password/password-hashing" label="Password hashing" />
</ReferenceCard.Grid>

# Post Authentication - Dashboard -  Setting up the dashboard
Source: https://supertokens.com/docs/post-authentication/dashboard/initial-setup

## Overview

The following page shows you how to set up the dashboard recipe and access the web interface.
You can check the next diagram to understand how the dashboard integrates with your application.

<Tabs
defaultValue="ms"
values={[
{label: 'Managed service', value: 'ms'},
{label: 'Self hosted', value: 'ss'},
]}>
<TabItem value="ms">
<img src="/img/architecture/managed_service_generic.png" alt="Flowchart of architecture when using SuperTokens managed service" />
</TabItem>
<TabItem value="ss">
<img src="/img/architecture/self_hosted_generic.png" alt="Flowchart of architecture when self-hosting SuperTokens" />
</TabItem>
</Tabs>

## Steps

### 1. Initialize the `Dashboard` recipe



To get started, initialize the Dashboard recipe in the `recipeList`.

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    // TODO: Initialise other recipes
    // highlight-start
    Dashboard.init(),
    // highlight-end
  ],
});
```

</Tab>
<Tab value="go">

```go
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import dashboard

init(
    app_info=InputAppInfo(
        api_domain="...", app_name="...", website_domain="..."),
    framework='...',  # type: ignore
    recipe_list=[
        # TODO: Initialise other recipes
        # highlight-start
        dashboard.init(),
        # highlight-end
    ]
)
```

</Tab>
</Tabs>

#### Update your content security policy {{optional}}

<Tabs>
<Tab value="nodejs">

If your backend returns a `Content-Security-Policy` header, you encounter the following UI displaying the Content Security Policy violation details. Follow the instructions provided in this UI to make necessary adjustments to your backend Content Security Policy configuration.

![Content Security Policy error handled UI](/img/dashboard/csp-error.png)

For example, to address the error message displayed in the above screenshot, you need to modify your `original policy`. In the given example, it appears as follows:

```text
script-src:
  'self' 
  'unsafe-inline' 
  https://google.com

img-src:
  https://google.com
```

To resolve this issue, make the following adjustments:

```text
script-src:
  'self' 
  'unsafe-inline' 
  https://google.com

img-src:
  https://google.com
  https://cdn.jsdelivr.net/gh/supertokens/

```
Essentially, you need to include the domain listed as the  `Blocked URI` in your violated directive block within your original policy.
</Tab>
<Tab value="go">

If you return a `Content-Security-Policy` header from your backend, you need to include the following directives for the user management dashboard to work correctly.

```text
script-src:
  'self' 
  'unsafe-inline' 
  https://cdn.jsdelivr.net/gh/supertokens/
img-src:
  https://cdn.jsdelivr.net/gh/supertokens/
  https://purecatamphetamine.github.io/
```

</Tab>
<Tab value="python">

If you return a `Content-Security-Policy` header from your backend, you need to include the following directives for the user management dashboard to work correctly.

```text
script-src:
  'self' 
  'unsafe-inline' 
  https://cdn.jsdelivr.net/gh/supertokens/
img-src:
  https://cdn.jsdelivr.net/gh/supertokens/
  https://purecatamphetamine.github.io/
```

</Tab>
</Tabs>

### 2. Access the dashboard

:::important
The backend SDK serves the user management dashboard, and you have to use your API domain when trying to visit the dashboard.
:::

Navigate to `<API_DOMAIN><API_BASE_PATH>/dashboard` to view the dashboard.

:::note
If you are using Next.js, upon integrating the backend SDK into your Next.js API folder, the dashboard becomes accessible by default at `<API_DOMAIN>/api/auth/dashboard`. For frameworks other than Next.js, access it at `<API_DOMAIN>/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, navigate to `<API_DOMAIN><API_BASE_PATH>/dashboard` to access the dashboard.
:::

<img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />

### 3. Create dashboard credentials

:::info Paid Feature
You can create 3 dashboard users* for free. 

If you need to create additional users:

- For self hosted users, please [sign up](https://supertokens.com/auth) to generate a license key and follow the instructions sent to you by email.
- For managed service users, you can click on the "enable paid features" button on [the dashboard](https://supertokens.com/dashboard-saas), and follow the steps from there on.

*: A dashboard user is a user that can log into and view the user management dashboard. These users are independent to the users of your application
:::

When you first set up SuperTokens, there are no credentials created for the dashboard. If you click the "Add a new user" button in the dashboard login screen you can see the command you need to execute to create credentials.

<img src="/img/dashboard/signup.png" alt="Dashboard sign up screen UI" />

To create credentials you need to make a request to SuperTokens core. 

- The example above uses the demo core `https://try.supertokens.com`, replace this with the connection URI you pass to the backend SDK when initialising SuperTokens.
- Replace `<YOUR-API-KEY>` with your API key. If you are using a self hosted SuperTokens core there is no API key by default. In that case you can either skip or ignore the `api-key` header.
- Replace `<YOUR_EMAIL>` and `<YOUR_PASSWORD>` with the appropriate values.

:::caution
If using self-hosted SuperTokens core, you need to make sure that you add an API key to the core in case it's exposed to the internet. Otherwise, anyone can create or modify dashboard users.

You can add an API key to the core by following the instructions "Auth flow customizations" > "SuperTokens core settings" > "Adding API keys" page.
:::

### 4. Update dashboard credentials

You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page.

<img src="/img/dashboard/forgot-password.png" alt="Reset your password screen UI" />

To update credentials you need to make a request to SuperTokens core. 

- The example above uses the demo core `https://try.supertokens.com`, replace this with the connection URI you pass to the backend SDK when initialising SuperTokens.
- Replace `<YOUR-API-KEY>` with your API key. If you are using a self hosted SuperTokens core there is no API key by default. In that case you can either skip or ignore the `api-key` header.
- Replace `<YOUR_EMAIL>` and `<YOUR_NEW_PASSWORD>` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email

### 5. Restrict access to dashboard users

When using the dashboard recipe, you can restrict access to certain features by providing a list of emails considered as "admins." If a dashboard user logs in with an email not present in this list, they can only perform read operations. All write operations result in the backend SDKs failing the request.

You can provide an array of emails to the backend SDK when initialising the dashboard recipe:

:::important
- Not providing an admins array results in all dashboard users having both read and write operations.
- Providing an empty array as admins results in all dashboard users having only read access.
:::

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
  appInfo: {
    apiDomain: "...",
    appName: "...",
    websiteDomain: "...",
  },
  recipeList: [
    // TODO: Initialise other recipes
    // highlight-start
    Dashboard.init({
      admins: [
        "johndoe@gmail.com",
      ],
    }),
    // highlight-end
  ],
});
```

</Tab>
<Tab value="go">

```go
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import dashboard

init(
    app_info=InputAppInfo(
        api_domain="...", app_name="...", website_domain="..."),
    framework='...',  # type: ignore
    recipe_list=[
        # TODO: Initialise other recipes
        # highlight-start
        dashboard.init(
          admins=[
            "johndoe@gmail.com",
          ],
        ),
        # highlight-end
    ]
)
```

</Tab>
</Tabs>

# Post Authentication - Dashboard -  User management
Source: https://supertokens.com/docs/post-authentication/dashboard/user-management

## Overview

With the user management dashboard you can view the list of users and their details.
You can also perform different operations on these users as mentioned below.

--- 

## Create users

If you have created your app, you may not have any users to show on the dashboard.

<img src="/img/dashboard/no-users.png" alt="Empty dashboard screen UI" />

## List users

Navigate to your frontend app and create a user (via the sign-up flow). On creation, if you head back to the dashboard and refresh the page, you see that user:

<img src="/img/dashboard/one-user.png" alt="One user in dashboard screen UI" />

---

## View user details

When you select a user you can view detailed information about the user such as email, phone number, user metadata, etc.

<img src="/img/dashboard/user-info.png" alt="User details page screen UI part one" />

<img src="/img/dashboard/user-info-continued.png" alt="User details page screen UI part two" />

---

## Edit user details

You can edit user information and perform actions such as resetting a user's password or revoking sessions for a user.

<img src="/img/dashboard/reset-password.png" alt="Change password modal UI" />

:::info Note
Enable some features such as user metadata and email verification in your backend before you can use them in the user management dashboard.
:::

---

## Create user roles and permissions

:::caution no-title
This feature is only available through the Node.js SDK.
:::

When you first use the `UserRoles` recipe, the list of roles is empty. To create roles, click on the "Add Role" button.

<img src="/img/dashboard/no-roles-created.png" alt="No roles created"/>

This action opens a modal, enabling you to create a role along with its associated permissions. Permissions are essentially a list of strings assigned to a specific role.

---

## List user roles 

:::caution no-title
This feature is only available through the Node.js SDK.
:::

<img src="/img/dashboard/create-role.png" alt="Create role"/>

After creating a role, the UI should display a list of all roles in your app.

<img src="/img/dashboard/roles-list.png" alt="Roles list"/>

You can preview the role you created by clicking on the role row. The modal provides options to edit or delete the role.

<img src="/img/dashboard/preview-role.png" alt="Preview role"/>

---

## Assign user roles

:::caution no-title
This feature is only available through the Node.js SDK.
:::

To assign a specific role to a user, start by finding the user in the dashboard. Upon clicking the user, navigate to the user details page where you find a section for user roles.

If the selected user has associations with multiple tenants, you can choose a `tenantId` from the dropdown menu to specify the tenant for which you'd like to assign roles.

<img src="/img/dashboard/select-tenant.png" alt="Select tenant"/>

Click the edit button to start assigning roles. Then, select the "Assign Role" button, and a modal appears with a list of available roles for assignment to this user.

<img src="/img/dashboard/assign-role.png" alt="Assign role"/>

--- 

## Remove user roles

:::caution no-title
This feature is only available through the Node.js SDK.
:::

To remove a role assigned to a user, click on the "X" icon next to that specific role.

<img src="/img/dashboard/view-assigned-roles.png" alt="View assigned role"/>

# Post Authentication - Dashboard -  Tenant management
Source: https://supertokens.com/docs/post-authentication/dashboard/tenant-management

## Overview

This page shows you what actions you can perform on tenants through the dashboard.

:::info Caution

This is only available with Node and Python SDKs.

:::

<img src="/img/dashboard/tenant-management/landing.png" alt="Tenant Management Landing"/>

---

## Create a new tenant

Clicking on `Add Tenant` prompts you to enter the tenant id. Once you enter the tenant id, click on `Create Now` to create the tenant. You then proceed to the Tenant Details page where you can further manage the newly created tenant.

<img src="/img/dashboard/tenant-management/create-tenant.gif" alt="Create Tenant"/>

## View tenant details

Upon selection or creation of a tenant, the Tenant Details page appears. The sections appear below.

<img src="/img/dashboard/tenant-management/details.png" alt="Tenant details"/>

### Tenant ID and users

The first section shows the tenant ID and the number of users in that tenant. Clicking on `See Users` takes you to the [user management page](/docs/post-authentication/dashboard/user-management) where you can view and manage the users for the selected tenant.

<img src="/img/dashboard/tenant-management/tenant-users.png" alt="Tenant users"/>

### Enabled login methods

This section displays the login methods available for the tenant. By enabling these toggles, you can make the corresponding login methods accessible to the users within the tenant.

Appropriate recipes must be active to turn on the login methods. For example,

- to turn on `emailpassword`, initialize the EmailPassword recipe in the backend.
- to turn on `OTP Phone`, initialize the Passwordless recipe with `flowType` `USER_INPUT_CODE` and contactMethod `PHONE`

:::info

If you are using the Auth React SDK, make sure to enable [usesDynamicLoginMethods](/docs/authentication/enterprise/common-domain-login#3-tell-supertokens-about-the-saved-tenantid-from-the-previous-step) to ensure the frontend automatically shows the login methods based on the selection here.

:::

<img src="/img/dashboard/tenant-management/login-methods.png" alt="Login Methods"/>

### Secondary factors

This section displays the secondary factors available for the tenant. By enabling these toggles, the corresponding factor becomes active for all users of the tenant. Refer to [MultiFactor Authentication docs](/docs/additional-verification/mfa/introduction) for more information.

[MultiFactorAuth](/docs/additional-verification/mfa/initial-setup) recipe must initialize to enable Secondary Factors.

Also, initialize appropriate recipes in the backend SDK to use a secondary factor. For example,

- to turn on TOTP, initialize the TOTP recipe in the backend.
- to turn on `OTP Phone`, initialize the Passwordless recipe with `flowType` `USER_INPUT_CODE` and contactMethod `PHONE`

<img src="/img/dashboard/tenant-management/secondary-factors.png" alt="Secondary Factors"/>

### Core configuration

<img src="/img/dashboard/tenant-management/core-config.png" alt="Core Configuration"/>

This section shows the current configuration values in core for the tenant. You can edit some of these settings by clicking the `pencil` icon next to the property.

<img src="/img/dashboard/tenant-management/edit-core-config.png" alt="Edit Core Configuration"/>

:::caution

Some configuration values may not be editable since they inherit from the App. If using SuperTokens managed hosting, you can modify them in the SaaS Dashboard. Else, if you are self-hosting the SuperTokens core, edit them via Docker environment variables or the `configuration.yaml` file.

:::

---

## Manage `ThirdParty` providers

The Social/Enterprise providers section becomes available once `Third Party` login method is active for the tenant.

Initially, configure a new provider.

<img src="/img/dashboard/tenant-management/add-provider-prompt.png" alt="Add provider prompt"/>

Later on, you can configure new or existing third-party providers from the **Social/Enterprise providers** section.

<img src="/img/dashboard/tenant-management/third-party-providers.png" alt="Social/Enterprise providers"/>

### Configure a new provider

When adding a new third-party provider, you receive a list of available options, including built-in enterprise and social providers, custom, and SAML.

<img src="/img/dashboard/tenant-management/new-provider.png" alt="New Provider"/>

Upon selection of the desired provider, provide further details such as `Client ID`, `Client Secret`, etc.

<img src="/img/dashboard/tenant-management/new-provider-details.png" alt="New Provider Details"/>

#### Enterprise providers

For the Enterprise providers, provide certain extra information before proceeding to the Provider details. For example, Active Directory provider requires a `Directory ID` before editing further details.

<img src="/img/dashboard/tenant-management/active-directory.png" alt="Additional configuration for Active Directory"/>

#### Custom providers

If a Social/Enterprise provider is not available in the list of built-in providers, you can still use them by selecting the `Add Custom Provider` option.

Start off by providing `ThirdParty ID`, `Name` and Client details such as `Client ID`, `Secret`, `Scope`, etc.

<img src="/img/dashboard/tenant-management/custom-provider-basic-details.png" alt="Custom Provider basic details"/>

If using an OpenID compliant provider, you could add the `OIDC Discovery Endpoint`. Otherwise, configure the provider by manually providing `Authorization Endpoint`, `Token Endpoint`, `User Info Endpoint`, etc.

<img src="/img/dashboard/tenant-management/openid-configuration.png" alt="OpenID configuration"/>

Finally, clicking on `Save` adds the Social/enterprise provider for the tenant.

#### SAML providers

To add a SAML provider, use the `Add SAML Provider` option. For more information on what is SAML and how it works with SuperTokens, refer [SAML docs](/docs/authentication/enterprise/saml/what-is-saml).

Upon selection, provide the `Boxy URL` and the `Boxy API Key`.

:::important

To use SAML providers, an additional Boxy HQ service is necessary. You can either self-host yourself or email for a managed instance. Details for them are also available on this page.

:::

<img src="/img/dashboard/tenant-management/saml-prompt.png" alt="Boxy SAML Prompt"/>

On continuing, you are further asked for the SAML configuration. You have an option to either provide SAML XML directly or via the Metadata URL from the Provider. Also, fill in other details such as `Suffix`, `Name`, `Redirect URLs` and click on `Save` to add the SAML provider.

:::caution

Adding ThirdParty suffix is not compulsory, however if you wish to add multiple SAML providers for a tenant, you need to add unique suffixes for each of them.

:::

<img src="/img/dashboard/tenant-management/saml-config.png" alt="Boxy SAML `Config`"/>

If you did not provide the `Boxy API Key`, you need to add the `Client ID` and `Secret` obtained by calling the Boxy APIs manually. More details are [available here](/docs/authentication/enterprise/saml/boxy-hq-guide#4-upload-the-base64-xml-string-to-saml-jackson).

<img src="/img/dashboard/tenant-management/saml-config-via-api.png" alt="Boxy SAML `Config` via `API`"/>

# Deployment -  Migrate from MySQL to PostgreSQL
Source: https://supertokens.com/docs/deployment/migrate-from-mysql

## Overview

This tutorial shows you how to migrate your **SuperTokens** database from **MySQL** to **PostgreSQL**.
The migration involves exporting data from MySQL, setting up a PostgreSQL database with the same schema version, and importing the data with proper format conversions.

## Before you start

The tutorial assumes the following:

- You have access to both your `MySQL` and `PostgreSQL` databases
- Both databases are running on the same version of **SuperTokens Core**
- You have administrative privileges on both databases

## Steps

### 1. Create a backup of your MySQL database

Create a final backup of your MySQL database.
The instructions for this step are specific to your database management system.

### 2. Prepare the PostgreSQL database

Start the same version of [`supertokens-postgresql`](https://hub.docker.com/r/supertokens/supertokens-postgresql) to initialize the schema in the database.

:::warning
Make sure to use the same version as the `supertokens-mysql` instance that you are currently running.
:::

### 3. Export data from MySQL

#### 3.1 Export standard tables

Run the following command to export most of your data:

```bash
mysqldump supertokens --fields-terminated-by ','  --fields-enclosed-by '"' --fields-escaped-by '\'  --no-create-info --tab /var/lib/mysql-files/
```

:::info

If you do not have permissions to write to the database filesystem you can use the following python script to export tables one by one:
<Accordion>
## Export script
```python
#!/usr/bin/env python3
```

This exports the `public_key` field as hexadecimal text for proper conversion to PostgreSQL's Binary Data (BYTEA) format.

### 4. Transfer data files

If necessary, copy the exported CSV files to a location where the `PostgreSQL` database can access them.

### 5. Import data into the PostgreSQL database

Next, you need to import the data into your PostgreSQL database.

#### 5.1. Disable triggers

Connect to your PostgreSQL database and disable triggers to prevent constraint violations during import.

```sql
SET session_replication_role = 'replica';
```

:::info
If you cannot disable the triggers, use the order specified in the next step.
The *With Order* shows you how to import everything one by one without triggering the constraints.
:::

#### 5.2 Import the standard tables

For most tables, you can import the data directly.

<Tabs>
<TabItem value="without-order" label="Without specifying column order">
```sql
COPY <table_name> FROM '/pg-data-host/<table_name>.csv' 
CSV DELIMITER ',' QUOTE '"' ESCAPE '\' NULL as '\N';
```
</TabItem>

<TabItem value="with-order" label="With specifying column order">
```bash
#!/bin/bash

PG_HOST="PG_HOST"
PG_PORT="5432"
PG_USER="PG_USER"
PG_DB="PG_DB"
PG_PASS="PG_PASS"
CSV_DIR="./mysql"

import_table() {
    local table=$1
    local columns=$2
    local csv_file="${CSV_DIR}/${table}.csv"

    if [ ! -f "$csv_file" ]; then
        echo "File not found: $csv_file, skipping"
        return
    fi

    echo "Importing table: $table"

    if [ -z "$columns" ] || [ "$columns" = "*" ]; then
        PGPASSWORD=$PG_PASS psql -h $PG_HOST -p $PG_PORT -U $PG_USER -d $PG_DB -c \
            "\\COPY $table FROM '$csv_file' WITH (FORMAT csv, HEADER true);"
    else
        PGPASSWORD=$PG_PASS psql -h $PG_HOST -p $PG_PORT -U $PG_USER -d $PG_DB -c \
            "\\COPY $table ($columns) FROM '$csv_file' WITH (FORMAT csv, HEADER true);"
    fi

    if [ $? -eq 0 ]; then
        echo "Successfully imported $table"
    else
        echo "ERROR importing $table"
    fi
}

echo "Starting PostgreSQL import"

import_table "apps" ""
import_table "tenants" ""
import_table "key_value" "app_id, tenant_id, name, value, created_at_time"
import_table "all_auth_recipe_users" "app_id, tenant_id, user_id, primary_or_recipe_user_id, is_linked_or_is_a_primary_user, recipe_id, time_joined, primary_or_recipe_user_time_joined"
import_table "app_id_to_user_id" "app_id, user_id, recipe_id, primary_or_recipe_user_id, is_linked_or_is_a_primary_user"
import_table "bulk_import_users" "id, app_id, primary_user_id, raw_data, status, error_msg, created_at, updated_at"
import_table "dashboard_user_sessions" "app_id, session_id, user_id, time_created, expiry"
import_table "dashboard_users" "app_id, user_id, email, password_hash, time_joined"
import_table "emailpassword_pswd_reset_tokens" "app_id, user_id, token, email, token_expiry"
import_table "emailpassword_user_to_tenant" "app_id, tenant_id, user_id, email"
import_table "emailpassword_users" "app_id, user_id, email, password_hash, time_joined"
import_table "emailverification_tokens" "app_id, tenant_id, user_id, email, token, token_expiry"
import_table "emailverification_verified_emails" "app_id, user_id, email"
import_table "jwt_signing_keys" "app_id, key_id, key_string, algorithm, created_at"
import_table "oauth_clients" "app_id, client_id, client_secret, enable_refresh_token_rotation, is_client_credentials_only"
import_table "oauth_logout_challenges" "app_id, challenge, client_id, post_logout_redirect_uri, session_handle, state, time_created"
import_table "oauth_m2m_tokens" "app_id, client_id, iat, exp"
import_table "oauth_sessions" "gid, app_id, client_id, session_handle, external_refresh_token, internal_refresh_token, jti, exp"
import_table "passwordless_codes" "app_id, tenant_id, code_id, device_id_hash, link_code_hash, created_at"
import_table "passwordless_devices" "app_id, tenant_id, device_id_hash, email, phone_number, link_code_salt, failed_attempts"
import_table "passwordless_user_to_tenant" "app_id, tenant_id, user_id, email, phone_number"
import_table "passwordless_users" "app_id, user_id, email, phone_number, time_joined"
import_table "role_permissions" "app_id, role, permission"
import_table "roles" "app_id, role"
import_table "session_access_token_signing_keys" "app_id, created_at_time, value"
import_table "session_info" "app_id, tenant_id, session_handle, user_id, refresh_token_hash_2, session_data, expires_at, created_at_time, jwt_user_payload, use_static_key"
import_table "tenant_first_factors" "connection_uri_domain, app_id, tenant_id, factor_id"
import_table "tenant_required_secondary_factors" "connection_uri_domain, app_id, tenant_id, factor_id"
import_table "tenant_thirdparty_providers" "connection_uri_domain, app_id, tenant_id, third_party_id, name, authorization_endpoint, authorization_endpoint_query_params, token_endpoint, token_endpoint_body_params, user_info_endpoint, user_info_endpoint_query_params, user_info_endpoint_headers, jwks_uri, oidc_discovery_endpoint, require_email, user_info_map_from_id_token_payload_user_id, user_info_map_from_id_token_payload_email, user_info_map_from_id_token_payload_email_verified, user_info_map_from_user_info_endpoint_user_id, user_info_map_from_user_info_endpoint_email, user_info_map_from_user_info_endpoint_email_verified"
import_table "thirdparty_user_to_tenant" "app_id, tenant_id, user_id, third_party_id, third_party_user_id"
import_table "thirdparty_users" "app_id, third_party_id, third_party_user_id, user_id, email, time_joined"
import_table "totp_used_codes" "app_id, tenant_id, user_id, code, is_valid, expiry_time_ms, created_time_ms"
import_table "tenant_configs" "connection_uri_domain, app_id, tenant_id, core_config, email_password_enabled, passwordless_enabled, third_party_enabled, is_first_factors_null"
import_table "totp_user_devices" "app_id, user_id, device_name, secret_key, period, skew, verified, created_at"
import_table "totp_users" "app_id, user_id"
import_table "user_last_active" "app_id, user_id, last_active_time"
import_table "user_metadata" "app_id, user_id, user_metadata"
import_table "user_roles" "app_id, tenant_id, user_id, role"
import_table "userid_mapping" "app_id, supertokens_user_id, external_user_id, external_user_id_info"
import_table "webauthn_account_recovery_tokens" "app_id, tenant_id, user_id, email, token, expires_at"
import_table "webauthn_generated_options" "app_id, tenant_id, id, challenge, email, rp_id, rp_name, origin, expires_at, created_at, user_presence_required, user_verification"
import_table "webauthn_user_to_tenant" "app_id, tenant_id, user_id, email"
import_table "webauthn_users" "app_id, user_id, email, rp_id, time_joined"

echo ""
echo "Import complete!"

```
</TabItem>

</Tabs>

#### 5.3 Handle the third-party provider clients table

The `tenant_thirdparty_provider_clients` table requires special handling.
You need to do this to differences between the `MySQL` `JSON` and `PostgreSQL` `text[]` formats.

<Steps>

## Create a staging table

```sql
CREATE TABLE tenant_thirdparty_provider_clients_raw (
    connection_uri_domain VARCHAR(256) DEFAULT '' NOT NULL,
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    third_party_id VARCHAR(28) NOT NULL,
    client_type VARCHAR(64) DEFAULT '' NOT NULL,
    client_id VARCHAR(256) NOT NULL,
    client_secret TEXT,
    scope JSONB,
    force_pkce BOOLEAN,
    additional_config TEXT
);
```

## Import data into the staging table:

```sql
COPY tenant_thirdparty_provider_clients_raw FROM '/host/tenant_thirdparty_provider_clients.txt' 
CSV DELIMITER ',' QUOTE '"' ESCAPE '\' NULL as '\N';
```

## Convert and insert into the final table:

```sql
INSERT INTO tenant_thirdparty_provider_clients (
    connection_uri_domain, app_id, tenant_id, third_party_id, client_type,
    client_id, client_secret, force_pkce, additional_config, scope
)
SELECT
    connection_uri_domain, app_id, tenant_id, third_party_id, client_type,
    client_id, client_secret, force_pkce, additional_config,
    ARRAY(
        SELECT jsonb_array_elements_text(scope->jsonb_object_keys(scope))
    )
FROM tenant_thirdparty_provider_clients_raw;
```

</Steps>

#### 5.4 Handle the WebAuthn credentials table

The `webauthn_credentials` table requires conversion from MySQL Binary Large Object, `BLOB`, to PostgreSQL Binary Data, `BYTEA` format.

<Steps>

## Create a staging table

```sql
CREATE TABLE IF NOT EXISTS webauthn_credentials_staging (
   id VARCHAR(256) NOT NULL,
   app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
   rp_id VARCHAR(256) NOT NULL,
   user_id CHAR(36),
   counter BIGINT NOT NULL,
   public_key TEXT NOT NULL,
   transports TEXT NOT NULL,
   created_at BIGINT NOT NULL,
   updated_at BIGINT NOT NULL
);
```

## Import the hexadecimal data

```sql
COPY webauthn_credentials_staging FROM '/host/webauthn_credentials_hex.txt' 
CSV DELIMITER ',' QUOTE '"' ESCAPE '\' NULL as '\N';
```

## Convert and insert into the final table

```sql
INSERT INTO webauthn_credentials (
   id, app_id, rp_id, user_id, counter, public_key, transports, created_at, updated_at
)
SELECT 
   id, app_id, rp_id, user_id, counter, 
   decode(public_key, 'hex'), 
   transports, created_at, updated_at 
FROM webauthn_credentials_staging;
```

</Steps>

#### 5.5 Delete the staging tables

Delete the two temporary tables.

```
DROP TABLE webauthn_credentials_staging;
DROP TABLE tenant_thirdparty_provider_clients_raw;
```

#### 5.6 Re-enable triggers

After importing all data, re-enable the triggers:

```sql
SET session_replication_role = 'origin';
```

### 6. Verify the migration

Verify that all data migrated successfully by comparing record counts between your MySQL and PostgreSQL databases:

```bash
#!/bin/bash

MYSQL_HOST="DB_HOST"
MYSQL_PORT="3306"
MYSQL_USER="DB_USER"
MYSQL_DB="DB_NAME"
MYSQL_PASS="DB_PASS"

PG_HOST="PG_HOST"
PG_PORT="5432"
PG_USER="PG_USER"
PG_DB="PG_DB"
PG_PASS="PG_PASS"

echo "Comparing table row counts between MySQL and PostgreSQL"

echo "Getting table list from MySQL"
TABLES=$(mysql -h $MYSQL_HOST -P $MYSQL_PORT -u $MYSQL_USER -p$MYSQL_PASS \
  -N -e "SHOW TABLES" $MYSQL_DB)

if [ $? -ne 0 ]; then
    echo "ERROR: Failed to get table list from MySQL"
    exit 1
fi

TOTAL_TABLES=$(echo "$TABLES" | wc -l)
echo "Found $TOTAL_TABLES tables"
echo ""

MATCH_COUNT=0
MISMATCH_COUNT=0
ERROR_COUNT=0

for TABLE in $TABLES; do
    MYSQL_COUNT=$(mysql -h $MYSQL_HOST -P $MYSQL_PORT -u $MYSQL_USER -p$MYSQL_PASS \
        -N -e "SELECT COUNT(*) FROM $TABLE" $MYSQL_DB 2>&1)

    if [ $? -ne 0 ]; then
        echo "$TABLE - MySQL: ERROR, PostgreSQL: -, Status: ERROR"
        ERROR_COUNT=$((ERROR_COUNT + 1))
        continue
    fi

    PG_COUNT=$(PGPASSWORD=$PG_PASS psql -h $PG_HOST -p $PG_PORT -U $PG_USER -d $PG_DB \
        -t -c "SELECT COUNT(*) FROM $TABLE" 2>&1)

    if [ $? -ne 0 ]; then
        echo "$TABLE - MySQL: $MYSQL_COUNT, PostgreSQL: ERROR, Status: ERROR"
        ERROR_COUNT=$((ERROR_COUNT + 1))
        continue
    fi

    MYSQL_COUNT=$(echo $MYSQL_COUNT | xargs)
    PG_COUNT=$(echo $PG_COUNT | xargs)

    if [ "$MYSQL_COUNT" = "$PG_COUNT" ]; then
        echo "$TABLE - MySQL: $MYSQL_COUNT, PostgreSQL: $PG_COUNT, Status: ✓ MATCH"
        MATCH_COUNT=$((MATCH_COUNT + 1))
    else
        echo "$TABLE - MySQL: $MYSQL_COUNT, PostgreSQL: $PG_COUNT, Status: ✗ MISMATCH"
        MISMATCH_COUNT=$((MISMATCH_COUNT + 1))
    fi
done

echo "Summary:"
echo "  Total tables:     $TOTAL_TABLES"
echo "  Matching:         $MATCH_COUNT"
echo "  Mismatched:       $MISMATCH_COUNT"
echo "  Errors:           $ERROR_COUNT"
echo ""

if [ $MISMATCH_COUNT -eq 0 ] && [ $ERROR_COUNT -eq 0 ]; then
    echo "✓ All tables match!"
    exit 0
else
    echo "✗ Some tables have mismatches or errors"
    exit 1
fi
```

If the numbers match, you have successfully migrated your SuperTokens data from `MySQL` to `PostgreSQL` :tada:

# Deployment -  Self-hosting SuperTokens
Source: https://supertokens.com/docs/deployment/self-host-supertokens

<DescriptionText>
  See how you can run **SuperTokens** in your own infrastructure.
</DescriptionText>

<Separator />

## Overview 

One of the main features of **SuperTokens** is that you can run it using your own resources.
This way you have full control over the authentication data and you can scale based on your needs.

## Before you start

To deploy the Core Service you must configure two things: the actual API and the database.
- The core service can be deployed using a **Docker** image or directly inside your VM.
- The supported database is **PostgreSQL**. The minimum required version is `13.0`.

:::info
**SuperTokens Core** has dropped **MySQL** and **MongoDB** support with the `11.0.0` release.
If you want to reference the old documentation, please [open this page](/docs/legacy/core/v10/self-host-supertokens).
:::

## Steps

### 1. Install SuperTokens core

#### With docker

```bash
docker run -p 3567:3567 -d registry.supertokens.io/supertokens/supertokens-postgresql:latest
```

- To see all the environment variables available, please see [the README file](https://github.com/supertokens/supertokens-docker-postgresql/blob/master/README.md).
- The above command starts the container with an in-memory database. This means you **do not need to connect it to PostgreSQL to test out SuperTokens**.

#### Without docker

##### 1. Download SuperTokens

<Steps>
  ## Visit the [open source download page](https://SuperTokens.com/use-oss).
  ## Click on the "Binary" tab. 
  ## Choose your database.
  ## Download the SuperTokens zip file for your OS.
</Steps>

Once downloaded, remove the zip, and you see a folder named `supertokens`.

##### 2. Install SuperTokens

<OSTabs>
<OSTab value="linux">

```bash
# sudo is required so that the supertokens 
# command can be added to your PATH variable.

cd supertokens
sudo ./install
```
</OSTab>

<OSTab value="mac">

```bash

cd supertokens
./install

```
:::caution
You may get an error like `java cannot be opened because the developer cannot be verified`. To solve this, visit System Preferences > Security & Privacy > General Tab, and then click on the Allow button at the bottom. Then retry the command above.
:::

</OSTab>

<OSTab value="windows">

```batch

Rem run as an Administrator. This is required so that the supertokens 
Rem command can be added to your PATH.

cd supertokens
install.bat

```
</OSTab>
</OSTabs>

:::important
After installing, you can delete the downloaded folder as you no longer need it.

Make any changes to the configuration in the `config.yaml` file in the installation directory, as specified in the output of the `supertokens --help` command.
:::

##### 3. Start the core service 

Running the following command starts the service.
```bash
supertokens start [--host=...] [--port=...]
```
- The above command starts the container with an in-memory database.
- To see all available options please run `supertokens start --help`

:::info Tip
To stop the service, run the following command:
```bash
supertokens stop
```
:::

### 2. Test that the service is running 

Open a browser and visit `http://localhost:3567/hello`. If you see a page that says `Hello` back, then the container started successfully!

If you are having issues with starting the docker image, please feel free to reach out [over email](mailto:support@supertokens.com) or [via Discord](https://supertokens.com/discord).

:::tip
The `/hello` route checks whether the database connection is correctly set up and only returns a 200 status code if there is no issue.

If you are using Kubernetes or docker swarm, this endpoint is perfect for doing readiness and liveness probes.
:::

### 3. Connect the backend SDK with SuperTokens 

- The default `port` for SuperTokens is `3567`. You can change this by binding a different port in the `docker run` command. For example, `docker run -p 8080:3567` runs SuperTokens on port `8080` on your machine.
- The connection info goes in the `supertokens` object in the `init` function on your backend:

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

supertokens.init({
    // highlight-start
    supertokens: {
        connectionURI: "http://localhost:3567",
        apiKey: "someKey" // OR can be undefined
    },
    // highlight-end
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: []
});
```

</Tab>
<Tab value="go">

```go
```

You can skip this step if you want SuperTokens to write to your own database.
In this case, you need to provide your database's name as shown in the step below.

#### 4.2 Connect SuperTokens to your database 

##### With docker

:::caution
Host being `localhost` / `127.0.0.1` does not work in a docker image. Instead, please provide the database's local / public host name or IP address.

You also need to make the database listen on all the IPs of the local machine.
Edit the `postgresql.conf` configuration file and set the value of `listen_addresses` to `0.0.0.0`.
:::

:::caution
It is important to use the `postgresql://` scheme designator in the PostgreSQL Connection URI. Using `postgres://` will lead to a startup error.
:::

```bash

docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e POSTGRESQL_CONNECTION_URI="postgresql://username:pass@host/dbName" \
    -d registry.supertokens.io/supertokens/supertokens-postgresql

# OR

docker run \
    -p 3567:3567 \
    // highlight-start
    -e POSTGRESQL_USER="username" \
    -e POSTGRESQL_PASSWORD="password" \
	-e POSTGRESQL_HOST="host" \
	-e POSTGRESQL_PORT="5432" \
    -e POSTGRESQL_DATABASE_NAME="supertokens" \
    // highlight-end
    -d registry.supertokens.io/supertokens/supertokens-postgresql
```

:::tip
You can also provide the table schema by setting the `POSTGRESQL_TABLE_SCHEMA` option.
:::

##### Without docker

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

postgresql_connection_uri: "postgresql://username:pass@host/dbName"

# OR

postgresql_user: "username"

postgresql_password: "password"

postgresql_host: "host"

postgresql_port: "5432"

postgresql_database_name: "supertokens"
```

You can also provide the table schema by setting the `postgresql_table_schema` option.

:::info
The required tables should create automatically if the database user has table creation permission.
If not, you can create them manually using the following snippet.

<Accordion>
  ## Database tables

```sql
CREATE TABLE apps (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    created_at_time BIGINT,
    CONSTRAINT apps_pkey PRIMARY KEY (app_id)
);

CREATE TABLE tenants (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    created_at_time BIGINT,
    CONSTRAINT tenants_pkey PRIMARY KEY (app_id, tenant_id),
    CONSTRAINT tenants_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX tenants_app_id_index ON tenants (app_id);

CREATE TABLE tenant_configs (
    connection_uri_domain VARCHAR(256) DEFAULT '' NOT NULL,
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    core_config TEXT,
    email_password_enabled BOOLEAN,
    passwordless_enabled BOOLEAN,
    third_party_enabled BOOLEAN,
    is_first_factors_null BOOLEAN,
    CONSTRAINT tenant_configs_pkey PRIMARY KEY (connection_uri_domain, app_id, tenant_id)
);

CREATE TABLE tenant_thirdparty_providers (
    connection_uri_domain VARCHAR(256) DEFAULT '' NOT NULL,
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    third_party_id VARCHAR(28) NOT NULL,
    name VARCHAR(64),
    authorization_endpoint TEXT,
    authorization_endpoint_query_params TEXT,
    token_endpoint TEXT,
    token_endpoint_body_params TEXT,
    user_info_endpoint TEXT,
    user_info_endpoint_query_params TEXT,
    user_info_endpoint_headers TEXT,
    jwks_uri TEXT,
    oidc_discovery_endpoint TEXT,
    require_email BOOLEAN,
    user_info_map_from_id_token_payload_user_id VARCHAR(64),
    user_info_map_from_id_token_payload_email VARCHAR(64),
    user_info_map_from_id_token_payload_email_verified VARCHAR(64),
    user_info_map_from_user_info_endpoint_user_id VARCHAR(64),
    user_info_map_from_user_info_endpoint_email VARCHAR(64),
    user_info_map_from_user_info_endpoint_email_verified VARCHAR(64),
    CONSTRAINT tenant_thirdparty_providers_pkey PRIMARY KEY (connection_uri_domain, app_id, tenant_id, third_party_id),
    CONSTRAINT tenant_thirdparty_providers_tenant_id_fkey FOREIGN KEY (connection_uri_domain, app_id, tenant_id) REFERENCES public.tenant_configs(connection_uri_domain, app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX tenant_thirdparty_providers_tenant_id_index ON tenant_thirdparty_providers (connection_uri_domain, app_id, tenant_id);

CREATE TABLE tenant_thirdparty_provider_clients (
    connection_uri_domain VARCHAR(256) DEFAULT '' NOT NULL,
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    third_party_id VARCHAR(28) NOT NULL,
    client_type VARCHAR(64) DEFAULT '' NOT NULL,
    client_id VARCHAR(256) NOT NULL,
    client_secret TEXT,
    scope VARCHAR(128)[],
    force_pkce BOOLEAN,
    additional_config TEXT,
    CONSTRAINT tenant_thirdparty_provider_clients_pkey PRIMARY KEY (connection_uri_domain, app_id, tenant_id, third_party_id, client_type),
    CONSTRAINT tenant_thirdparty_provider_clients_third_party_id_fkey FOREIGN KEY (connection_uri_domain, app_id, tenant_id, third_party_id) REFERENCES public.tenant_thirdparty_providers(connection_uri_domain, app_id, tenant_id, third_party_id) ON DELETE CASCADE
);

CREATE INDEX tenant_thirdparty_provider_clients_third_party_id_index ON tenant_thirdparty_provider_clients (connection_uri_domain, app_id, tenant_id, third_party_id);

CREATE TABLE tenant_first_factors (
  connection_uri_domain VARCHAR(256) DEFAULT '' NOT NULL,
  app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
  tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
  factor_id VARCHAR(128),
  CONSTRAINT tenant_first_factors_pkey PRIMARY KEY (connection_uri_domain, app_id, tenant_id, factor_id),
  CONSTRAINT tenant_first_factors_tenant_id_fkey FOREIGN KEY (connection_uri_domain, app_id, tenant_id) REFERENCES public.tenant_configs(connection_uri_domain, app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX IF NOT EXISTS tenant_first_factors_tenant_id_index ON tenant_first_factors (connection_uri_domain, app_id, tenant_id);

CREATE TABLE tenant_required_secondary_factors (
  connection_uri_domain VARCHAR(256) DEFAULT '' NOT NULL,
  app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
  tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
  factor_id VARCHAR(128),
  CONSTRAINT tenant_required_secondary_factors_pkey PRIMARY KEY (connection_uri_domain, app_id, tenant_id, factor_id),
  CONSTRAINT tenant_required_secondary_factors_tenant_id_fkey FOREIGN KEY (connection_uri_domain, app_id, tenant_id) REFERENCES public.tenant_configs(connection_uri_domain, app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX IF NOT EXISTS tenant_default_required_factor_ids_tenant_id_index ON tenant_required_secondary_factors (connection_uri_domain, app_id, tenant_id);

CREATE TABLE key_value (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    name VARCHAR(128) NOT NULL,
    value TEXT,
    created_at_time BIGINT,
    CONSTRAINT key_value_pkey PRIMARY KEY (app_id, tenant_id, name),
    CONSTRAINT key_value_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX key_value_tenant_id_index ON key_value (app_id, tenant_id);

CREATE TABLE app_id_to_user_id (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    recipe_id VARCHAR(128) NOT NULL,
    primary_or_recipe_user_id CHAR(36) NOT NULL,
    is_linked_or_is_a_primary_user BOOLEAN NOT NULL DEFAULT FALSE,
    CONSTRAINT app_id_to_user_id_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT app_id_to_user_id_primary_or_recipe_user_id_fkey FOREIGN KEY(app_id, primary_or_recipe_user_id) REFERENCES app_id_to_user_id (app_id, user_id) ON DELETE CASCADE,
    CONSTRAINT app_id_to_user_id_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX app_id_to_user_id_app_id_index ON app_id_to_user_id (app_id);

CREATE INDEX app_id_to_user_id_primary_user_id_index ON app_id_to_user_id (primary_or_recipe_user_id, app_id);

CREATE TABLE all_auth_recipe_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    primary_or_recipe_user_id CHAR(36) NOT NULL,
    is_linked_or_is_a_primary_user BOOLEAN NOT NULL DEFAULT FALSE,
    recipe_id VARCHAR(128) NOT NULL,
    time_joined BIGINT NOT NULL,
    primary_or_recipe_user_time_joined BIGINT NOT NULL,
    CONSTRAINT all_auth_recipe_users_pkey PRIMARY KEY (app_id, tenant_id, user_id),
    CONSTRAINT all_auth_recipe_users_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE,
    CONSTRAINT all_auth_recipe_users_primary_or_recipe_user_id_fkey FOREIGN KEY(app_id, primary_or_recipe_user_id) REFERENCES public.app_id_to_user_id (app_id, user_id) ON DELETE CASCADE,
    CONSTRAINT all_auth_recipe_users_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.app_id_to_user_id(app_id, user_id) ON DELETE CASCADE
);

CREATE INDEX all_auth_recipe_users_pagination_index1 ON all_auth_recipe_users
    (app_id, tenant_id, primary_or_recipe_user_time_joined DESC, primary_or_recipe_user_id DESC);

CREATE INDEX all_auth_recipe_users_pagination_index2 ON all_auth_recipe_users
    (app_id, tenant_id, primary_or_recipe_user_time_joined ASC, primary_or_recipe_user_id DESC);

CREATE INDEX all_auth_recipe_users_pagination_index3 ON all_auth_recipe_users
    (recipe_id, app_id, tenant_id, primary_or_recipe_user_time_joined DESC, primary_or_recipe_user_id DESC);

CREATE INDEX all_auth_recipe_users_pagination_index4 ON all_auth_recipe_users
    (recipe_id, app_id, tenant_id, primary_or_recipe_user_time_joined ASC, primary_or_recipe_user_id DESC);

CREATE INDEX all_auth_recipe_users_primary_user_id_index ON all_auth_recipe_users
    (primary_or_recipe_user_id, app_id);

CREATE INDEX all_auth_recipe_users_recipe_id_index ON all_auth_recipe_users
    (app_id, recipe_id, tenant_id);

CREATE INDEX all_auth_recipe_user_id_index ON all_auth_recipe_users (app_id, user_id);

CREATE INDEX all_auth_recipe_tenant_id_index ON all_auth_recipe_users (app_id, tenant_id);

CREATE TABLE userid_mapping (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    supertokens_user_id character(36) NOT NULL,
    external_user_id VARCHAR(128) NOT NULL,
    external_user_id_info TEXT,
    CONSTRAINT userid_mapping_external_user_id_key UNIQUE (app_id, external_user_id),
    CONSTRAINT userid_mapping_pkey PRIMARY KEY (app_id, supertokens_user_id, external_user_id),
    CONSTRAINT userid_mapping_supertokens_user_id_key UNIQUE (app_id, supertokens_user_id),
    CONSTRAINT userid_mapping_supertokens_user_id_fkey FOREIGN KEY (app_id, supertokens_user_id) REFERENCES public.app_id_to_user_id(app_id, user_id) ON DELETE CASCADE
);

CREATE INDEX userid_mapping_supertokens_user_id_index ON userid_mapping (app_id, supertokens_user_id);

CREATE TABLE dashboard_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    password_hash VARCHAR(256) NOT NULL,
    time_joined BIGINT NOT NULL,
    CONSTRAINT dashboard_users_email_key UNIQUE (app_id, email),
    CONSTRAINT dashboard_users_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT dashboard_users_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX dashboard_users_app_id_index ON dashboard_users (app_id);

CREATE TABLE dashboard_user_sessions (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    session_id character(36) NOT NULL,
    user_id character(36) NOT NULL,
    time_created BIGINT NOT NULL,
    expiry BIGINT NOT NULL,
    CONSTRAINT dashboard_user_sessions_pkey PRIMARY KEY (app_id, session_id),
    CONSTRAINT dashboard_user_sessions_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.dashboard_users(app_id, user_id) ON UPDATE CASCADE ON DELETE CASCADE
);

CREATE INDEX dashboard_user_sessions_expiry_index ON dashboard_user_sessions (expiry);

CREATE INDEX dashboard_user_sessions_user_id_index ON dashboard_user_sessions (app_id, user_id);

CREATE TABLE session_access_token_signing_keys (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    created_at_time BIGINT NOT NULL,
    value TEXT,
    CONSTRAINT session_access_token_signing_keys_pkey PRIMARY KEY (app_id, created_at_time),
    CONSTRAINT session_access_token_signing_keys_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX access_token_signing_keys_app_id_index ON session_access_token_signing_keys (app_id);

CREATE TABLE session_info (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    session_handle VARCHAR(255) NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    refresh_token_hash_2 VARCHAR(128) NOT NULL,
    session_data TEXT,
    expires_at BIGINT NOT NULL,
    created_at_time BIGINT NOT NULL,
    jwt_user_payload TEXT,
    use_static_key BOOLEAN NOT NULL,
    CONSTRAINT session_info_pkey PRIMARY KEY (app_id, tenant_id, session_handle),
    CONSTRAINT session_info_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX session_expiry_index ON session_info (expires_at);

CREATE INDEX session_info_tenant_id_index ON session_info (app_id, tenant_id);

CREATE TABLE user_last_active (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    last_active_time BIGINT,
    CONSTRAINT user_last_active_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT user_last_active_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX user_last_active_app_id_index ON user_last_active (app_id);

CREATE TABLE emailpassword_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    password_hash VARCHAR(256) NOT NULL,
    time_joined BIGINT NOT NULL,
    CONSTRAINT emailpassword_users_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT emailpassword_users_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.app_id_to_user_id(app_id, user_id) ON DELETE CASCADE
);

CREATE TABLE emailpassword_user_to_tenant (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    CONSTRAINT emailpassword_user_to_tenant_email_key UNIQUE (app_id, tenant_id, email),
    CONSTRAINT emailpassword_user_to_tenant_pkey PRIMARY KEY (app_id, tenant_id, user_id),
    CONSTRAINT emailpassword_user_to_tenant_user_id_fkey FOREIGN KEY (app_id, tenant_id, user_id) REFERENCES public.all_auth_recipe_users(app_id, tenant_id, user_id) ON DELETE CASCADE
);

CREATE TABLE emailpassword_pswd_reset_tokens (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    token VARCHAR(128) NOT NULL,
    token_expiry BIGINT NOT NULL,
    email VARCHAR(256),
    CONSTRAINT emailpassword_pswd_reset_tokens_pkey PRIMARY KEY (app_id, user_id, token),
    CONSTRAINT emailpassword_pswd_reset_tokens_token_key UNIQUE (token),
    CONSTRAINT emailpassword_pswd_reset_tokens_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.app_id_to_user_id(app_id, user_id) ON UPDATE CASCADE ON DELETE CASCADE
);

CREATE INDEX emailpassword_password_reset_token_expiry_index ON emailpassword_pswd_reset_tokens (token_expiry);

CREATE INDEX emailpassword_pswd_reset_tokens_user_id_index ON emailpassword_pswd_reset_tokens (app_id, user_id);

CREATE TABLE emailverification_verified_emails (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    email VARCHAR(256) NOT NULL,
    CONSTRAINT emailverification_verified_emails_pkey PRIMARY KEY (app_id, user_id, email),
    CONSTRAINT emailverification_verified_emails_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX emailverification_verified_emails_app_id_index ON emailverification_verified_emails (app_id);

CREATE TABLE emailverification_tokens (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    email VARCHAR(256) NOT NULL,
    token VARCHAR(128) NOT NULL,
    token_expiry BIGINT NOT NULL,
    CONSTRAINT emailverification_tokens_pkey PRIMARY KEY (app_id, tenant_id, user_id, email, token),
    CONSTRAINT emailverification_tokens_token_key UNIQUE (token),
    CONSTRAINT emailverification_tokens_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX emailverification_tokens_index ON emailverification_tokens (token_expiry);

CREATE INDEX emailverification_tokens_tenant_id_index ON emailverification_tokens (app_id, tenant_id);

CREATE TABLE thirdparty_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    third_party_id VARCHAR(28) NOT NULL,
    third_party_user_id VARCHAR(256) NOT NULL,
    user_id character(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    time_joined BIGINT NOT NULL,
    CONSTRAINT thirdparty_users_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT thirdparty_users_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.app_id_to_user_id(app_id, user_id) ON DELETE CASCADE
);

CREATE INDEX thirdparty_users_email_index ON thirdparty_users (app_id, email);

CREATE INDEX thirdparty_users_thirdparty_user_id_index ON thirdparty_users (app_id, third_party_id, third_party_user_id);

CREATE TABLE thirdparty_user_to_tenant (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    third_party_id VARCHAR(28) NOT NULL,
    third_party_user_id VARCHAR(256) NOT NULL,
    CONSTRAINT thirdparty_user_to_tenant_pkey PRIMARY KEY (app_id, tenant_id, user_id),
    CONSTRAINT thirdparty_user_to_tenant_third_party_user_id_key UNIQUE (app_id, tenant_id, third_party_id, third_party_user_id),
    CONSTRAINT thirdparty_user_to_tenant_user_id_fkey FOREIGN KEY (app_id, tenant_id, user_id) REFERENCES public.all_auth_recipe_users(app_id, tenant_id, user_id) ON DELETE CASCADE
);

CREATE TABLE passwordless_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    email VARCHAR(256),
    phone_number VARCHAR(256),
    time_joined BIGINT NOT NULL,
    CONSTRAINT passwordless_users_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT passwordless_users_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.app_id_to_user_id(app_id, user_id) ON DELETE CASCADE
);

CREATE TABLE passwordless_user_to_tenant (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id character(36) NOT NULL,
    email VARCHAR(256),
    phone_number VARCHAR(256),
    CONSTRAINT passwordless_user_to_tenant_email_key UNIQUE (app_id, tenant_id, email),
    CONSTRAINT passwordless_user_to_tenant_phone_number_key UNIQUE (app_id, tenant_id, phone_number),
    CONSTRAINT passwordless_user_to_tenant_pkey PRIMARY KEY (app_id, tenant_id, user_id),
    CONSTRAINT passwordless_user_to_tenant_user_id_fkey FOREIGN KEY (app_id, tenant_id, user_id) REFERENCES public.all_auth_recipe_users(app_id, tenant_id, user_id) ON DELETE CASCADE
);

CREATE TABLE passwordless_devices (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    device_id_hash character(44) NOT NULL,
    email VARCHAR(256),
    phone_number VARCHAR(256),
    link_code_salt character(44) NOT NULL,
    failed_attempts integer NOT NULL,
    CONSTRAINT passwordless_devices_pkey PRIMARY KEY (app_id, tenant_id, device_id_hash),
    CONSTRAINT passwordless_devices_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX passwordless_devices_email_index ON passwordless_devices (app_id, tenant_id, email);

CREATE INDEX passwordless_devices_phone_number_index ON passwordless_devices (app_id, tenant_id, phone_number);

CREATE INDEX passwordless_devices_tenant_id_index ON passwordless_devices (app_id, tenant_id);

CREATE TABLE passwordless_codes (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    code_id character(36) NOT NULL,
    device_id_hash character(44) NOT NULL,
    link_code_hash character(44) NOT NULL,
    created_at BIGINT NOT NULL,
    CONSTRAINT passwordless_codes_link_code_hash_key UNIQUE (app_id, tenant_id, link_code_hash),
    CONSTRAINT passwordless_codes_pkey PRIMARY KEY (app_id, tenant_id, code_id),
    CONSTRAINT passwordless_codes_device_id_hash_fkey FOREIGN KEY (app_id, tenant_id, device_id_hash) REFERENCES public.passwordless_devices(app_id, tenant_id, device_id_hash) ON UPDATE CASCADE ON DELETE CASCADE
);

CREATE INDEX passwordless_codes_created_at_index ON passwordless_codes (app_id, tenant_id, created_at);

CREATE INDEX passwordless_codes_device_id_hash_index ON passwordless_codes (app_id, tenant_id, device_id_hash);

CREATE TABLE jwt_signing_keys (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    key_id VARCHAR(255) NOT NULL,
    key_string TEXT NOT NULL,
    algorithm VARCHAR(10) NOT NULL,
    created_at BIGINT,
    CONSTRAINT jwt_signing_keys_pkey PRIMARY KEY (app_id, key_id),
    CONSTRAINT jwt_signing_keys_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX jwt_signing_keys_app_id_index ON jwt_signing_keys (app_id);

CREATE TABLE user_metadata (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    user_metadata TEXT NOT NULL,
    CONSTRAINT user_metadata_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT user_metadata_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX user_metadata_app_id_index ON user_metadata (app_id);

CREATE TABLE roles (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    role VARCHAR(255) NOT NULL,
    CONSTRAINT roles_pkey PRIMARY KEY (app_id, role),
    CONSTRAINT roles_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX roles_app_id_index ON roles (app_id);

CREATE TABLE role_permissions (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    role VARCHAR(255) NOT NULL,
    permission VARCHAR(255) NOT NULL,
    CONSTRAINT role_permissions_pkey PRIMARY KEY (app_id, role, permission),
    CONSTRAINT role_permissions_role_fkey FOREIGN KEY (app_id, role) REFERENCES public.roles(app_id, role) ON DELETE CASCADE
);

CREATE INDEX role_permissions_permission_index ON role_permissions (app_id, permission);

CREATE INDEX role_permissions_role_index ON role_permissions (app_id, role);

CREATE TABLE user_roles (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    role VARCHAR(255) NOT NULL,
    CONSTRAINT user_roles_pkey PRIMARY KEY (app_id, tenant_id, user_id, role),
    CONSTRAINT user_roles_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE
);

CREATE INDEX user_roles_role_index ON user_roles (app_id, tenant_id, role);

CREATE INDEX user_roles_tenant_id_index ON user_roles (app_id, tenant_id);

CREATE INDEX user_roles_app_id_role_index ON user_roles (app_id, role);

CREATE TABLE totp_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    CONSTRAINT totp_users_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT totp_users_app_id_fkey FOREIGN KEY (app_id) REFERENCES public.apps(app_id) ON DELETE CASCADE
);

CREATE INDEX totp_users_app_id_index ON totp_users (app_id);

CREATE TABLE totp_user_devices (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    device_name VARCHAR(256) NOT NULL,
    secret_key VARCHAR(256) NOT NULL,
    period integer NOT NULL,
    skew integer NOT NULL,
    verified BOOLEAN NOT NULL,
    created_at BIGINT,
    CONSTRAINT totp_user_devices_pkey PRIMARY KEY (app_id, user_id, device_name),
    CONSTRAINT totp_user_devices_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.totp_users(app_id, user_id) ON DELETE CASCADE
);

CREATE INDEX totp_user_devices_user_id_index ON totp_user_devices (app_id, user_id);

CREATE TABLE totp_used_codes (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id VARCHAR(128) NOT NULL,
    code VARCHAR(8) NOT NULL,
    is_valid BOOLEAN NOT NULL,
    expiry_time_ms BIGINT NOT NULL,
    created_time_ms BIGINT NOT NULL,
    CONSTRAINT totp_used_codes_pkey PRIMARY KEY (app_id, tenant_id, user_id, created_time_ms),
    CONSTRAINT totp_used_codes_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES public.tenants(app_id, tenant_id) ON DELETE CASCADE,
    CONSTRAINT totp_used_codes_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES public.totp_users(app_id, user_id) ON DELETE CASCADE
);

CREATE INDEX totp_used_codes_expiry_time_ms_index ON totp_used_codes (app_id, tenant_id, expiry_time_ms);

CREATE INDEX totp_used_codes_tenant_id_index ON totp_used_codes (app_id, tenant_id);

CREATE INDEX totp_used_codes_user_id_index ON totp_used_codes (app_id, user_id);

CREATE TABLE IF NOT EXISTS bulk_import_users (
    id CHAR(36),
    app_id VARCHAR(64) NOT NULL DEFAULT 'public',
    primary_user_id VARCHAR(36),
    raw_data TEXT NOT NULL,
    status VARCHAR(128) DEFAULT 'NEW',
    error_msg TEXT,
    created_at BIGINT NOT NULL, 
    updated_at BIGINT NOT NULL, 
    CONSTRAINT bulk_import_users_pkey PRIMARY KEY(app_id, id),
    CONSTRAINT bulk_import_users__app_id_fkey FOREIGN KEY(app_id) REFERENCES apps(app_id) ON DELETE CASCADE
);

CREATE INDEX IF NOT EXISTS bulk_import_users_status_updated_at_index ON bulk_import_users (app_id, status, updated_at);

CREATE INDEX IF NOT EXISTS bulk_import_users_pagination_index1 ON bulk_import_users (app_id, status, created_at DESC, id DESC);
 
CREATE INDEX IF NOT EXISTS bulk_import_users_pagination_index2 ON bulk_import_users (app_id, created_at DESC, id DESC);

CREATE INDEX IF NOT EXISTS session_info_user_id_app_id_index ON session_info (user_id, app_id);

CREATE INDEX IF NOT EXISTS emailverification_verified_emails_app_id_email_index ON emailverification_verified_emails
(app_id, email);

CREATE TABLE IF NOT EXISTS webauthn_account_recovery_tokens (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id CHAR(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    token VARCHAR(256) NOT NULL,
    expires_at BIGINT NOT NULL,
    CONSTRAINT webauthn_account_recovery_token_pkey PRIMARY KEY (app_id, tenant_id, user_id, token),
    CONSTRAINT webauthn_account_recovery_token_user_id_fkey FOREIGN KEY (app_id, tenant_id, user_id) REFERENCES 
    all_auth_recipe_users(app_id, tenant_id, user_id) ON DELETE CASCADE
);

CREATE TABLE IF NOT EXISTS webauthn_credentials (
    id VARCHAR(256) NOT NULL,
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    rp_id VARCHAR(256) NOT NULL,
    user_id CHAR(36),
    counter BIGINT NOT NULL,
    public_key BYTEA NOT NULL,
    transports TEXT NOT NULL,
    created_at BIGINT NOT NULL,
    updated_at BIGINT NOT NULL,
    CONSTRAINT webauthn_credentials_pkey PRIMARY KEY (app_id, rp_id, id),
    CONSTRAINT webauthn_credentials_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES webauthn_users
    (app_id, user_id) ON DELETE CASCADE
);

CREATE TABLE IF NOT EXISTS webauthn_generated_options (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public'NOT NULL,
    id CHAR(36) NOT NULL,
    challenge VARCHAR(256) NOT NULL,
    email VARCHAR(256),
    rp_id VARCHAR(256) NOT NULL,
    rp_name VARCHAR(256) NOT NULL,
    origin VARCHAR(256) NOT NULL,
    expires_at BIGINT NOT NULL,
    created_at BIGINT NOT NULL,
    user_presence_required BOOLEAN DEFAULT false NOT NULL,
    user_verification VARCHAR(12) DEFAULT 'preferred' NOT NULL,
    CONSTRAINT webauthn_generated_options_pkey PRIMARY KEY (app_id, tenant_id, id),
    CONSTRAINT webauthn_generated_options_tenant_id_fkey FOREIGN KEY (app_id, tenant_id) REFERENCES tenants
    (app_id, tenant_id) ON DELETE CASCADE
);

CREATE TABLE IF NOT EXISTS webauthn_user_to_tenant (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    tenant_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id CHAR(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    CONSTRAINT webauthn_user_to_tenant_email_key UNIQUE (app_id, tenant_id, email),
    CONSTRAINT webauthn_user_to_tenant_pkey PRIMARY KEY (app_id, tenant_id, user_id),
    CONSTRAINT webauthn_user_to_tenant_user_id_fkey FOREIGN KEY (app_id, tenant_id, user_id) REFERENCES 
    all_auth_recipe_users(app_id, tenant_id, user_id) ON DELETE CASCADE
);

CREATE TABLE IF NOT EXISTS webauthn_users (
    app_id VARCHAR(64) DEFAULT 'public' NOT NULL,
    user_id CHAR(36) NOT NULL,
    email VARCHAR(256) NOT NULL,
    rp_id VARCHAR(256) NOT NULL,
    time_joined BIGINT NOT NULL,
    CONSTRAINT webauthn_users_pkey PRIMARY KEY (app_id, user_id),
    CONSTRAINT webauthn_users_user_id_fkey FOREIGN KEY (app_id, user_id) REFERENCES app_id_to_user_id(app_id, 
    user_id) ON DELETE CASCADE
);

CREATE INDEX IF NOT EXISTS webauthn_user_to_tenant_email_index ON webauthn_user_to_tenant (app_id, email);
CREATE INDEX IF NOT EXISTS webauthn_user_challenges_expires_at_index ON webauthn_generated_options (app_id, tenant_id, expires_at);
CREATE INDEX IF NOT EXISTS webauthn_credentials_user_id_index ON webauthn_credentials (user_id);
CREATE INDEX IF NOT EXISTS webauthn_account_recovery_token_token_index ON webauthn_account_recovery_tokens (app_id, tenant_id, token);
CREATE INDEX IF NOT EXISTS webauthn_account_recovery_token_expires_at_index ON webauthn_account_recovery_tokens (expires_at DESC);
CREATE INDEX IF NOT EXISTS webauthn_account_recovery_token_email_index ON webauthn_account_recovery_tokens (app_id, tenant_id, email);

```

</Accordion>

:::

#### 4.3 Test the connection 

To test, start SuperTokens and run the following query in your database

```sql
SELECT * FROM key_value;
```
If you see at least one row, it means that the connection has been successfully completed! 

#### 4.4 Rename database tables {{optional}}

:::caution
If you already have tables created by SuperTokens, and then you rename them, SuperTokens creates new tables. Please be sure to migrate the data from the existing one to the new one.
:::

You can add a prefix to all table names that SuperTokens manages. This way, all will be renamed in a way that has no clashes with your tables. 

For example, two tables created by SuperTokens have the names `emailpassword_users` and `thirdparty_users`. If you add a prefix to them (something like `"my_prefix"`), then the tables become `my_prefix_emailpassword_users` and `my_prefix_thirdparty_users`.

<Tabs>
<Tab value="with-docker">

```bash
docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e POSTGRESQL_TABLE_NAMES_PREFIX="my_prefix" \ 
    -d registry.supertokens.io/supertokens/supertokens-postgresql
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

postgresql_table_names_prefix: "my_prefix"
```
</Tab>
</Tabs>

### 5. Add license keys

To access some features in your self-hosted service you must use **license keys**.
You can sign up on [**SuperTokens**](https://supertokens.com/auth) to receive one. 

Once you have the license key you need to manually add it to your **SuperTokens Core Instance**.
To do this you have to call the Core API with the following request:

```bash title="Add License Key" showAppTypeSelect
curl --location --request PUT <CORE_URI>/ee/license \
     --header 'Content-Type: application/json' \
     --header 'api-key: ^{coreInfo.key}' \
     --data-raw '{ "licenseKey": "<YOUR_LICENSE_KEY>" }'

```

## References

### Docker compose file

```bash
version: '3'

services:
  # Note: If you are assigning a custom name to your db service on the line below, make sure it does not contain underscores
  db:
    image: 'postgres:latest'
    environment:
      POSTGRES_USER: supertokens_user 
      POSTGRES_PASSWORD: somePassword 
      POSTGRES_DB: supertokens
    ports:
      - 5432:5432
    networks:
      - app_network
    restart: unless-stopped
    healthcheck:
      test: ['CMD', 'pg_isready', '-U', 'supertokens_user', '-d', 'supertokens']
      interval: 5s
      timeout: 5s
      retries: 5

  supertokens:
    image: registry.supertokens.io/supertokens/supertokens-postgresql:latest
    depends_on:
      db:
        condition: service_healthy
    ports:
      - 3567:3567
    environment:
      POSTGRESQL_CONNECTION_URI: "postgresql://supertokens_user:somePassword@db:5432/supertokens"
    networks:
      - app_network
    restart: unless-stopped
    healthcheck:
      test: >
        bash -c 'exec 3<>/dev/tcp/127.0.0.1/3567 && echo -e "GET /hello HTTP/1.1\r\nhost: 127.0.0.1:3567\r\nConnection: close\r\n\r\n" >&3 && cat <&3 | grep "Hello"'
      interval: 10s
      timeout: 5s
      retries: 5

networks:
  app_network:
    driver: bridge
```

:::important
If you are running the backend process that integrates with the backend SDK as part of the docker compose file as well, make sure to use `http://supertokens:3567` as the connection URI instead of `http://localhost:3567`.
:::

### Helm charts for Kubernetes

- For [PostgreSQL image](https://github.com/supertokens/supertokens-docker-postgresql/tree/master/helm-chart)

# Deployment -  Rate limit policy
Source: https://supertokens.com/docs/deployment/rate-limits

## Overview

The following page describes how rate limits apply during SuperTokens API calls.

## For managed service

The SuperTokens core of a managed account is rate limited on a per app and per IP address basis.
This means that if you query the core for `app1` using the same IP address, the rate limit kicks in, and you get a `429` status code back from the core.
However, if you query the core using different IP addresses or for a different app, the rate limit of that does not interfere with the previous requests (that had another IP or was for another app).

### Free tier
The free tier of the managed service has a rate limit of 50 requests per second with a burst of 50 requests per second (with no delay).
This should be enough for 5-10 concurrent sign in / up (each sign in API call queries the SuperTokens core multiple times).

:::important
The backend SDK auto retries if it gets a `429` status code from the core (up to 5 times before throwing an error).
:::

### Paying users
If you are a paying user for SuperTokens, the rate limit and the burst limit adjust dynamically based on your usage (with a minimum of a 100rps).
You should not see any `429`s unless there is a **significant** spike in requests.

:::info Paid Feature
If you want higher rate limits, please [email support](mailto:support@supertokens.com), requesting a higher rate limit.
:::

### Special case
The `/hello` API exposed by the core is commonly used for health checks.
This API does not require any API key, and has its own rate limit of 5 requests per second per app (regardless of the IP address querying it).
This is independent to the rate limit described above, and cannot change.

## For self hosted

The SuperTokens core has no rate limit other than for the `/hello` API (which is 5 requests per second per app).
You are free to add rate limits to the core by using [a reverse proxy like Nginx](https://www.nginx.com/blog/rate-limiting-nginx/).

If you want to implement rate limiting policy similar to the managed service described above, add the following to your `http` and `server` block in the `nginx.conf` file:

```text
http {
    # other configs..
    
    map $request_uri $limit_req_zone_key {
        "~^/(appId|appid)-(\w+)/?" $binary_remote_addr:$2;
        default $binary_remote_addr;
    }

    limit_req_zone $limit_req_zone_key zone=mylimit:10m rate50/s;
    limit_req_status 429;

    # other configs..

    upstream supertokens {
        server localhost:3567;
    }

    server {
        limit_req zone=mylimit burst=50 nodelay;

        # other configs..

        listen 0.0.0.0:80;

        location / {
            proxy_pass http://supertokens;
        }
    }
}
```

In the above, the core adds a rate limit per app per IP address.

# Deployment -  Scalability
Source: https://supertokens.com/docs/deployment/scalability

## Overview

The following page addresses how the **SuperTokens** components scale based on different factors.

---

## Users and tenants 

SuperTokens can handle 10s of millions of users and tenants.
In fact, you can even make one tenant per user and it would work well.
For most operations, the database structure and queries allow partitioning based on tenants and users.
As the number of tenants scales, it does not affect performance on most operations per tenant. Similarly, as the number of users scales, it does not affect performance on most operations per user.

---

## SuperTokens core 

:::important
If you are using the managed service, the SuperTokens core is fully managed, and you don't have to worry about scaling it.
This section is for those who are self-hosting the SuperTokens core service.
:::

The SuperTokens core service supports horizontal scalability.
This means that you can add more instances of the core service to handle more requests.
The core service is also stateless, which means that you can add or remove instances without worrying about the state of the system.

The core service can handle a high number of requests per second (`RPS`).
The exact number of requests per second (`RPS`) that the core service can handle depends on the hardware you are using. In general, the core service can manage many requests.

For example, the average latency of requests is ~40 milliseconds at 100-150 requests per second (6,000-10,000 requests per minute).
The compute deployed is 6 instances of the SuperTokens core service, each on a t3.
micro EC2 instance behind a round robin load balancer. The `CPU` usage of each instance is around 10%.

The scale of end users that this can support is in the order of 1-2 million monthly active users, with a total user count of millions more.

### Average latency over 1 day

<img src="/img/avg-latency.png" />

### Number of requests per minute over 1 day

<img src="/img/rpm.png" />

### Performance tuning

If you are facing performance issues, here are some tips to help you tune the performance of your SuperTokens setup:
- If you are self-hosting the SuperTokens core, know that it is stateless and can scale horizontally. You can add more instances of the core service to handle more requests (behind a load balancer).
- Check which part of the request cycle is slow. Is it the SuperTokens core responding, or is it the backend SDK APIs responding? The performance of the backend SDK API depends mainly on how you have set up your API layer (that integrates with the backend SDK) to perform. You can check which is slow by enabling debug logs in the backend SDK, and then inspecting the timestamps around the core requests. If they sum up to be much less than the total time taken for the request (from the `frontend`'s point of view), then the bottleneck is likely in the backend SDK.
- If you are self-hosting the SuperTokens core, check if there are any database queries that are too slow. You can do this using debugging tools provided by the PostgreSQL database. If you find a query that's causing issues, please reach out to support.
- Check that the compute used to run the backend SDK, the SuperTokens core (in case you are self-hosting it), and the database is sufficient. Using a t3.micro EC2 instance for the core should work well for even 100,000 MAUs. You can check the `CPU` and memory usage of the instances to see if they have maxed out, or if you have run out of `CPU` credits. If they are, you can consider upgrading the instances to more powerful ones.
- In case you are self-hosting the SuperTokens core, you can tune its performance by setting different values for the following configurations in the configuration.yaml file, or docker `env`:
    - `max_server_pool_size`: Sets the max thread pool size for incoming `http` server requests. Default value is 10.
    - `postgresql_connection_pool_size` (if using psql): Defines the connection pool size to PostgreSQL. Default value is 10.
    - `postgresql_minimum_idle_connections` (if using psql): Minimum number of idle connections to remain active. If not set, minimum idle connections are the same as the connection pool size. By default, this is not set.
    - `postgresql_idle_connection_timeout`: (if using psql): Timeout in milliseconds for the idle connections to close. Default is 60000 MS.
- Check if you have access token blacklisting enabled in the backend SDK. The default is `false`, but if you have it enabled, then it means that every session verification attempt queries the SuperTokens core to check the database. This adds latency to the session verification process and increases the load on the core. If you want to keep this to `true`, consider making it only for non `GET` APIs for your application.
- You can increase the value of `access_token_validity` in the SuperTokens core. It sets the validity of the access token. Default value is 3,600 seconds (1 hour). The lower this value, the more often the refresh API calls the core, increasing the load on the core.

---

## Database 

SuperTokens works with PostgreSQL databases, and one instance of the database is enough to handle tens of millions of MAUs.
For example, a database with 1 million users would occupy ~ 1.5 GB of disk space (assuming you add minimal custom metadata to the user object).

---

## Backend SDK

The backend SDK does not store any information on its own.
It's a "big middleware" between the frontend requests and the SuperTokens core.
As such, its scalability depends entirely on the scalability of your API layer into which the backend SDK integrates.

---

## Session verification 

The access token is a JWT, and the backend SDK verifies them without any network requests, making them fast and scalable.
The core service verifies the refresh token, and the scalability of session refresh requests depends on the core service's scalability. However, session refreshes are rare compared to access token verification.

# Deployment -  OpenTelemetry Integration
Source: https://supertokens.com/docs/deployment/telemetry

## Overview

This tutorial shows you how to add **OpenTelemetry** logging to all the **SuperTokens** APIs and function calls using the **OpenTelemetry plugin**. The guide makes use of the plugins functionality to automatically instrument your authentication flows with distributed tracing.

## How it works

The plugin manually adds traces to all overridable functions and APIs in SuperTokens. When you initialize the OpenTelemetry SDK alongside this plugin, you automatically get comprehensive tracing at the API level. The plugin provides built-in data protection by automatically removing sensitive fields from traces.

## Before you start

The OpenTelemetry plugin supports only the `NodeJS` SDK. Support for other platforms is under active development.

Make sure you have the OpenTelemetry SDK installed and configured in your application. For detailed instructions, see the [OpenTelemetry Node.js Getting Started Guide](https://opentelemetry.io/docs/languages/js/getting-started/nodejs/#instrumentation).

The implementation is in early stages and APIs might change. For more information on how plugins work, refer to the [references page](/docs/references/plugins/introduction).

## Steps

### 1. Install the plugin

```bash
npm install @supertokens-plugins/opentelemetry-nodejs
```

### 2. Configure the OpenTelemetry SDK

Set up the OpenTelemetry SDK in your application.
Here's a basic configuration:

```typescript
/*instrumentation.ts*/

const sdk = new NodeSDK({
  traceExporter: new ConsoleSpanExporter(),
  metricReader: new PeriodicExportingMetricReader({
    exporter: new ConsoleMetricExporter(),
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});

sdk.start();
```

:::note no-title
For a more thorough explanation on how to setup OpenTelemetry please refer to the [official documentation](https://opentelemetry.io/docs/languages/js/getting-started/nodejs).
:::

### 3. Update your backend SDK configuration

Initialize the **SuperTokens** plugin inside your SDK configuration file.

```typescript

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      OpenTelemetryPlugin.init(),
    ],
  }
});
```

### 4. Test your setup

Inspect your traces and look for **SuperTokens** specific spans.
You should be able to identify them based on the following naming schemes:
- `<recipe-name>.function.<function-name>`
- `<recipe-name>.api.<api-name>`

Examples: `emailpassword.function.signIn`, `thirdparty.api.signInUpPOST`, `multitenancy.function.getTenant`

## Customization

### Data protection

By default, the plugin removes sensitive fields from traces to protect user data. The following fields are automatically filtered out:
`password`, `email(s)`,`phoneNumber(s)`, `accessToken`,`refreshToken`.

#### Adding custom sensitive fields

You can extend the list of sensitive fields by overriding the `getSensitiveFields` function:

```typescript

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  experimental: {
    plugins: [
      OpenTelemetryPlugin.init({
	override: (oI) => ({
	  ...oI,
	  getSensitiveFields: (defaultSensitiveFields: string[]) => [
	    ...defaultSensitiveFields, 
	    "customSecretField",
	    "userSecret",
	  ],
	}),
      }),
    ],
  }
});
```

#### Advanced data transformation

For more granular control over data handling in traces, you can override the transformation functions:

```typescript

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  plugins: [
    OpenTelemetryPlugin.init({
      override: (oI) => ({
	...oI,
        transformInputToAttributes: (input: any) => {
          // Custom logic to transform input data for traces
          return {
            userId: input.userId,
            action: input.action,
            // Exclude other sensitive data
          };
        },
        transformResultToAttributes: (result: any) => {
          // Custom logic to transform result data for traces
          return {
	    userId: result.userId,
            // Only include non-sensitive result data
          };
        },
      }),
    }),
  ],
});
```

#### Using OpenTelemetry data protection

Alternatively, you can disable the built-in data filtering and use OpenTelemetry's own [data protection mechanisms](https://opentelemetry.io/docs/security/handling-sensitive-data/):

```typescript

SuperTokens.init({
  supertokens: {
    connectionURI: "...",
  },
  appInfo: {
    // your app info
  },
  recipeList: [
    // your recipes
  ],
  plugins: [
    OpenTelemetryPlugin.init({
      override: (oI) => ({
	...oI,
        getSensitiveFields: () => [], // Disable built-in filtering
      }),
    }),
  ],
});
```


Besides OpenTelemetry integration, you can also look into other deployment and monitoring features:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/deployment/rate-limits">
    <ReferenceCard.Title>
      Self-Hosting 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Self-host SuperTokens in your own infrastructure.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/deployment/rate-limits">
    <ReferenceCard.Title>
      Rate Limiting
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Configure rate limits to protect your authentication endpoints.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/deployment/scalability">
    <ReferenceCard.Title>
      Scalability
    </ReferenceCard.Title>
    <ReferenceCard.Description>
      Scale SuperTokens for high-traffic applications.
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/plugins/introduction">
    <ReferenceCard.Title>
     Plugins Reference 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
     General information on how plugins work.
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# Migration -  Overview
Source: https://supertokens.com/docs/migration/overview

<DescriptionText>
  The **Migration** section covers instructions on how you can move your authentication data from your current authentication solution to **SuperTokens** 
</DescriptionText>

<Separator />

## Before You Start

The migration steps are intended to be executed after you have configured your [initial **SuperTokens** integration](/docs/quickstart/introduction).
Hence, to complete any of the next instructions you will need the following:
- An existing application that has a working **SuperTokens** integration. You can follow the [quickstart guide](/docs/quickstart/introduction) for instructions on how to achieve this.
- A **SuperTokens** managed service account or a self-hosted **SuperTokens Core** instance.
More specifically, you will have to make HTTP requests to your `CORE_API_ENDPOINT` using an `API_KEY`. 

## Migration Steps

The entire migration process can be broken down into two steps.
Both are required to achieve a seamless transition. 

1. [**Account Migration**](/docs/migration/account-migration/)

This is the main part of the migration flow.
You will be importing your users, together with their account credentials, from the legacy authentication provider into **SuperTokens**.

2. [**Session Migration**](/docs/migration/session-migration)

This step prevents any users with active sessions from experiencing authentication issues.
You will extend the **SuperTokens** functionality to create new sessions for users that have authenticated using your legacy provider.

:::info

You need to keep using your legacy authentication provider until you have implemented all the migration steps.
After that, you can go ahead and switch to **SuperTokens** in your production application.

:::

With that in mind, you can now move to the first step, the [**Account Migration**](/docs/migration/account-migration/) process.

# Migration -  Account migration
Source: https://supertokens.com/docs/migration/account-migration

<DescriptionText>
  The following guide will show you how to move your users from your current authentication solution to **SuperTokens**
</DescriptionText>

<Separator />

## Overview

The process of migrating your accounts breaks down into two parts:

### Creating new users on the fly

To ensure a smooth migration process, with no downtime, you need to be able to directly create new users from the legacy sign up flow.
This is necessary since there is a time gap between when you export all your data for bulk import and when you go live with **SuperTokens**. 

New users might get created in that interval through your legacy authentication provider. 
Hence, you also need to create them in **SuperTokens** to keep the data in sync.  

### Adding most of your users through a bulk import

After you have set in place the lazy migration process you can move on to adding most of your users.
This happens through the bulk import API.
The process is asynchronous and can work with large amounts of data.

## Before you start

This guide assumes that you have already integrated **SuperTokens** with your existing stack.
If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction) and explore all the supported [authentication methods](/docs/authentication/overview).

## Steps

### 1. Update the legacy sign up flow 

Modify the legacy sign up flow logic to also create new users in **SuperTokens**.
You can do this through the `Import User` endpoint that allows you to directly create accounts.
Call the endpoint from the authentication flow used by your legacy provider.

<Accordion px="4">
## Auth0 Instructions

:::warning no-title
Auth0 does not expose password hashes or `TOTP` device information.
You will have to contact their support separately if you need this type of data.
:::

##### 1. Access the Auth0 Dashboard
##### 2. From the navigation menu go to *Actions* > *Library*
##### 3. Click *Create Action* > *Create custom action*
##### 4. Specify a custom name for your action and then select *Login/Post Login* as the trigger
##### 5. After the action has been created, click the *Add Secret* button and save your `SUPERTOKENS_CORE_API_KEY` as a secret
##### 5. Paste the following code in the editor

```typescript
exports.onExecutePostLogin = async (event, api) => {
  const SUPERTOKENS_CORE_URL = "<YOUR_SUPERTOKENS_CORE_URL>";
  const SUPERTOKENS_API_KEY = event.secrets.SUPERTOKENS_API_KEY;
  const auth0User = event.user;
  
  try {
    if (auth0User.app_metadata?.migrated_to_supertokens) {
      console.log(`User ${auth0User.user_id} already migrated`);
      return;
    }
    
    const userPayload = {
      externalUserId: auth0User.user_id,
      userMetadata: {
        auth0_user_id: auth0User.user_id,
        name: auth0User.name,
        nickname: auth0User.nickname,
        picture: auth0User.picture
	auth0_user_metadata: auth0User.user_metadata,
	auth0_app_metadata: auth0User.app_metadata
      },
      roles: auth0User.app_metadata?.roles || [],
      loginMethods: []
    };

    const ThirdPartyProviders = ['google-oauth2', 'facebook', 'github', 'apple'];
    
    auth0User.identities.forEach((identity, index) => {
      if(ThirdPartyProviders.includes(identity.provider)) {
	userPayload.loginMethods.push({
	    recipeId: "thirdparty",
	    thirdPartyId: mapProvider(identity.provider),
	    thirdPartyUserId: identity.user_id,
	    email: identity.profileData?.email ?? auth0User.email,
	    isVerified: identity.profileData?.email_verified ?? auth0User.email_verified ?? false,
	    isPrimary: index === 0,
	    timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
	  });
	}
      } else if (identity.provider === 'auth0' || identity.provider === 'Username-Password-Authentication') {
	// Auth0 does not export passworded hashes by default
	// You will have to contact their support and request them
	userPayload.loginMethods.push({
	  recipeId: "emailpassword",
	  email: identity.profileData?.email ?? auth0User.email,
	  // Request the password hash from Auth0 and then implement the function to retrieve the values 
	  passwordHash: getPasswordHash(identity.profileData?.email),
	  hashingAlgorithm: "bcrypt",
	  isVerified: identity.profileData?.email_verified ?? auth0User.email_verified ?? false,
	  isPrimary: index === 0,
	  timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
	});
      } else if (identity.provider === 'sms') {
	userPayload.loginMethods.push({
	  recipeId: "passwordless",
	  phoneNumber: identity.profileData?.phone_number ?? auth0User.phone_number,
	  isVerified: identity.profileData?.phone_verified ?? auth0User.phone_verified ?? false,
	  isPrimary: index === 0,
	  timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
	});
      } else if (identity.provider === 'email') {
	userPayload.loginMethods.push({
	  recipeId: "passwordless",
	  email: identity.profileData?.email || auth0User.email,
	  isVerified: identity.profileData?.email_verified ?? auth0User.email_verified ?? false,
	  isPrimary: index === 0,
	  timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
	});
      } else {
	throw new Error(`Uknown provider: ${identity.provider}`);
      }
    });
    
    const response = await fetch(`${SUPERTOKENS_CORE_URL}/bulk-import/import`, {
      method: 'POST',
      headers: {
        'api-key': SUPERTOKENS_API_KEY,
        'Content-Type': 'application/json; charset=utf-8'
      },
      body: JSON.stringify(userPayload)
    });
    
    const result = await response.json();
    
    if (response.ok && result.status === 'OK') {
      console.log(`User migrated: ${event.user.email || event.user.user_id}`);
      api.user.setAppMetadata('migrated_to_supertokens', true);
      api.user.setAppMetadata('supertokens_user_id', result.user?.id);
    } else {
      console.error(`Migration failed: ${JSON.stringify(result)}`);
    }
    
  } catch (error) {
    console.error('Migration error:', error.message);
  }
};

function mapProvider(strategy) {
  const mapping = {
    'google-oauth2': 'google',
    'facebook': 'facebook',
    'github': 'github',
    'apple': 'apple',
  };
  return mapping[strategy] || strategy;
}
```

</Accordion>

<br/>

:::info
If your application does not have a sign up process or if new users get created manually you can skip this step
:::

<HTTPRequestCard path="/bulk-import/import" method="post" title="Import User">
  <HTTPRequestCard.ShellExample>

```bash
curl --location --request POST '<CORE_URI>/bulk-import/import' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '
    {
      "externalUserId": "user_12345",
      "userMetadata": {
        "firstName": "Jane",
        "lastName": "Doe",
        "department": "Engineering"
      },
      "userRoles": [{ "role": "admin", "tenantIds": [] }],
      "totpDevices": [
        {
          "secretKey": "JBSWY3DPEHPK3PXP",
          "period": 30,
          "skew": 1,
          "deviceName": "Main Device"
        }
      ],
      "loginMethods": [
        {
          "isVerified": true,
          "isPrimary": true,
          "timeJoinedInMSSinceEpoch": 1672531199000,
          "recipeId": "emailpassword",
          "email": "jane.doe@example.com",
          "passwordHash": "$2b$12$KIXQeFz...",
          "hashingAlgorithm": "bcrypt"
        }
      ]
    }
'
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/bulk-import/import`;
    const options = {
      method: 'POST',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
      body: JSON.stringify({
          externalUserId: "user_12345",
          userRoles: [{ role: "admin", tenantIds: [] }],
          userMetadata: {
            firstName: "Jane",
            lastName: "Doe",
            department: "Engineering"
          },
          totpDevices: [
            {
              secretKey: "JBSWY3DPEHPK3PXP",
              period: 30,
              skew: 1,
              deviceName: "Main Device"
            }
          ],
          loginMethods: [
            {
              isVerified: true,
              isPrimary: true,
              timeJoinedInMSSinceEpoch: 1672531199000,
              recipeId: "emailpassword",
              email: "jane.doe@example.com",
              passwordHash: "$2b$12$KIXQeFz...",
              hashingAlgorithm: "bcrypt"
            }
          ]
      })
    }

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
    ```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

    BASE_URL = "<CORE_URI>"
    API_KEY = "^{coreInfo.key}"

    url = f"{BASE_URL}/bulk-import/import"

    payload: Dict[str, Any] = {
        "externalUserId": "user_12345",
        "userMetadata": {
            "firstName": "Jane",
            "lastName": "Doe",
            "department": "Engineering"
        },
        "userRoles": [{ "role": "admin", "tenantIds": [] }],
        "totpDevices": [
            {
                "secretKey": "JBSWY3DPEHPK3PXP",
                "period": 30,
                "skew": 1,
                "deviceName": "Main Device"
            }
        ],
        "loginMethods": [
            {
                "isVerified": True,
                "isPrimary": True,
                "timeJoinedInMSSinceEpoch": 1672531199000,
                "recipeId": "emailpassword",
                "email": "jane.doe@example.com",
                "passwordHash": "$2b$12$KIXQeFz...",
                "hashingAlgorithm": "bcrypt"
            }
        ]
    }

    headers = {
        "api-key": API_KEY,
        "Content-Type": "application/json",
    }

    response = requests.post(url, json=payload, headers=headers)

    print(response.json())
    ```

  </HTTPRequestCard.PythonExample>
  <HTTPRequestCard.DetailsModal>
<HTTPRequestCard.DetailsModalHeader>
<HTTPRequestCard.DetailsModalDescription>
   Creates one user at a time based on the request body.

</HTTPRequestCard.DetailsModalDescription>

<HTTPRequestCard.DetailsModalDescription>
**Authorization**: Set the `api-key` header to the value of your **SuperTokens** Core API key.
</HTTPRequestCard.DetailsModalDescription>

</HTTPRequestCard.DetailsModalHeader>

<HTTPRequestCard.DetailsModalBody>

 <H2>Request</H2>

 <H3>Body Schema</H3>

| Name           | Type                   | Description                                                                                     | Required |
|----------------|------------------------|-------------------------------------------------------------------------------------------------|----------|
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider                         | No       |
| `userMetadata`   | `object`               | An object with custom user information that can be used later on                               | No       |
| `userRoles`      | `array` of `UserRole`     | The roles that will be used for authorization                                                   | No       |
| `totpDevices`    | `array` of `TotpDevice`  | Time-based One-time Password device (TOTP) used for Multi-Factor Authentication                 | Yes      |
| `loginMethods`   | `array` of `LoginMethod` | The actual authentication methods and credentials                                              | Yes      |

<H4>TotpDevice</H4>

| Name       | Type                | Description                                                                 | Required |
|------------|---------------------|-----------------------------------------------------------------------------|----------|
| `secretKey`  | `string`            | The secret key used to generate the TOTP codes.                             | Yes      |
| period     | `number`            | The time period in seconds for which a TOTP code is valid.                  | Yes      |
| skew       | `number`            | The allowable time skew to account for clock differences between the server and device. | Yes      |
| `deviceName` | `string`            | The name assigned to the TOTP device for identification purposes.           | No       |

<H4>UserRole</H4>

| Name       | Type                | Description                                                                 | Required |
|------------|---------------------|-----------------------------------------------------------------------------|----------|
| role       | `string`            | The actual role name                             | Yes      |
| tenantIds  | Array of `string` | The tenants that use this role. If you are not using the `multi-tenancy` just pass an empty array. | Yes |

<H4>LoginMethod</H4>

`LoginMethod` is a polymorphic type with multiple variants based on the `recipeId`. Each variant includes shared and specific fields.

##### EmailPassword 

###### With Encrypted Password

| Name                    | Type                  | Description                                                                                     | Required |
|-------------------------|-----------------------|-------------------------------------------------------------------------------------------------|----------|
| email                   | `string`              | User's email address                                                                            | Yes      |
| `passwordHash`            | `string`              | Hashed password                                                                                 | Yes      |
| `hashingAlgorithm`        | `enum` (`"bcrypt"`, `"argon2"`, `"firebase_scrypt"`)                | Hashing algorithm used.                     | Yes      |
| `recipeId`                | `string`              | Must be `emailpassword`                                                                          | Yes      |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

###### With Plain Password

| Name                    | Type                  | Description                                                                                     | Required |
|-------------------------|-----------------------|-------------------------------------------------------------------------------------------------|----------|
| email                   | `string`              | User's email address                                                                            | Yes      |
| `plaintextPassword` | `string`              | A plain text password that will be hashed based on the configured hashing algorithm              | Yes      |
| `recipeId`                | `string`              | Must be `emailpassword`                                                                          | Yes      |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

##### ThirdParty 
   | Name             | Type   | Description                   | Required |
   |------------------|--------|-------------------------------|----------|
   | `recipeId`         | `string` | Must be `"thirdparty"`        | Yes      |
   | email            | `string` | User's email address          | Yes      |
   | thirdPartyId     | `string` | Identifier for the third party provider | Yes |
   | thirdPartyUserId | `string` | User identifier from the third party provider | Yes |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

##### Passwordless 

   | Name     | Type   | Description           | Required |
   |----------|--------|-----------------------|----------|
   | `recipeId` | `string` | Must be `"passwordless"` | Yes      |
   | email    | `string` | User's email address  | One of `email` or `phoneNumber` must be provided |
   | `phoneNumber` | `string` | User's phone number | One of `email` or `phoneNumber` must be provided |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

<H3>Example</H3>

```bash
curl --location --request POST '<CORE_URI>/bulk-import/import' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '
    {
      "externalUserId": "user_12345",
      "userMetadata": {
        "firstName": "Jane",
        "lastName": "Doe",
        "department": "Engineering"
      },
      "userRoles": [{ "role": "admin", "tenantIds": [] }],
      "totpDevices": [
        {
          "secretKey": "JBSWY3DPEHPK3PXP",
          "period": 30,
          "skew": 1,
          "deviceName": "Main Device"
        }
      ],
      "loginMethods": [
        {
          "isVerified": true,
          "isPrimary": true,
          "timeJoinedInMSSinceEpoch": 1672531199000,
          "recipeId": "emailpassword",
          "email": "jane.doe@example.com",
          "passwordHash": "$2b$12$KIXQeFz...",
          "hashingAlgorithm": "bcrypt"
        }
      ]
    }
'
```

<H2>Response</H2>

<H3>200</H3>
The user has been successfully created.

<H4>Example</H4>

```json
{ 
  "status": "OK",
  "user": { /* User Object */ }
}
```

<H3>400</H3>

The request body was invalid.

<H4>Example</H4>

```json
{ 
   "errors": ["No two loginMethods can have isPrimary as true.", "email is required for recipeId emailpassword", "hashingAlgorithm must be one of 'bcrypt', 'argon2', or 'firebase_scrypt'."]}
}
```

<H3>500</H3>

An internal server error occurred.

</HTTPRequestCard.DetailsModalBody>
  </HTTPRequestCard.DetailsModal>
</HTTPRequestCard>

### 2. Export the accounts from your legacy provider

Export the users from your legacy authentication provider and adjust the data to match the request body schema used in the [**`Add Users for Bulk Import`**](#add-users-for-bulk-import-http-request) endpoint. 

<Accordion px="4">
## Auth0 Instructions
:::warning no-title
Auth0 does not export password hashes or `TOTP` device information.
You will have to contact their support and request them.
:::

#### 1. Create a management API application in Auth0
##### 1.1 Navigate to Auth0 Dashboard and the select `Applications` > `APIs`
##### 1.2 Select `Auth0 Management API`
##### 1.3 Go to `Machine to Machine Applications` tab
##### 1.4 Authorize your application or create a new one
##### 1.5 Grant the following permissions: `read:users`, `update:users`, `create:users`, `read:user_app_metadata`
##### 1.6 Save your `Domain`, `Client ID`, and `Client Secret`

#### 2. Get the management API access token
You need a valid Management API Access Token to export users.
Use the following `cURL` command to get the token:
```bash
curl --request POST \
  --url 'https://YOUR_DOMAIN.auth0.com/oauth/token' \
  --header 'content-type: application/json' \
  --data '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "audience": "https://YOUR_DOMAIN.auth0.com/api/v2/",
    "grant_type": "client_credentials"
  }'
```

#### 3. Create the export job
Use the `POST /api/v2/jobs/users-exports` endpoint to create a job that exports all users. 

```bash
curl --request POST \
  --url 'https://YOUR_DOMAIN.auth0.com/api/v2/jobs/users-exports' \
  --header 'authorization: Bearer YOUR_MGMT_API_TOKEN' \
  --header 'content-type: application/json' \
  --data '{
    "format": "json",
    "fields": [
      {"name": "user_id"},
      {"name": "email"},
      {"name": "email_verified"},
      {"name": "name"},
      {"name": "nickname"},
      {"name": "picture"},
      {"name": "created_at"},
      {"name": "updated_at"},
      {"name": "identities"},
      {"name": "app_metadata"},
      {"name": "user_metadata"},
      {"name": "phone_number"},
      {"name": "phone_verified"}
    ]
  }'
```

#### 4. Check the export job status

Check if the export job has finalized with this request:

```bash
curl --request GET \
  --url 'https://YOUR_DOMAIN.auth0.com/api/v2/jobs/job_abc123xyz' \
  --header 'authorization: Bearer YOUR_MGMT_API_TOKEN'
```

#### 5. Download the export file

The previous request returns a `location` attribute in the response body if the export job has finalized.
Use it do access your data.

```bash
curl -o auth0_users.json.gz "LOCATION_URL_FROM_RESPONSE"
gunzip auth0_users.json.gz
```

Auth0 exports data in `NDJSON` format.
Convert it to JSON first:

```bash
cat auth0_users.json | jq -s '.' > auth0_users_array.json
```

#### 6. Transform the data to the SuperTokens format

:::warning no-title
Auth0 does not expose password hashes or `TOTP` device information.
You will have to contact their support separately if you need this type of data.
:::

```typescript
const fs = require('fs');

const auth0Users = JSON.parse(fs.readFileSync('auth0_users_array.json', 'utf8'));

const superTokensUsers = auth0Users.map(auth0User => {
  if(auth0User.user_metadata?.migrated_to_supertokens) {
    console.log(`User ${auth0User.user_id} already migrated`);
    return;
  }

  const userPayload = {
    externalUserId: event.user.user_id,
    userMetadata: {
      auth0_user_id: auth0User.user_id,
      name: auth0User.name,
      nickname: auth0User.nickname,
      picture: auth0User.picture,
      auth0_user_metadata: auth0User.user_metadata
      auth0_app_metadata: auth0User.app_metadata
    },
    roles: auth0User.app_metadata?.roles || [],
    loginMethods: [],
  };

  const ThirdPartyProviders = ['google-oauth2', 'facebook', 'github', 'apple'];
  
  auth0User.identities.forEach((identity, index) => {
    if(ThirdPartyProviders.includes(identity.provider)) {
      userPayload.loginMethods.push({
	  recipeId: "thirdparty",
	  thirdPartyId: mapProvider(identity.provider),
	  thirdPartyUserId: identity.user_id,
	  email: identity.profileData?.email ?? auth0User.email,
	  isVerified: identity.profileData?.email_verified ?? auth0User.email_verified ?? false,
	  isPrimary: index === 0,
	  timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
	});
      }
    } else if (identity.provider === 'auth0' || identity.provider === 'Username-Password-Authentication') {
      // Auth0 does not export passworded hashes by default
      // You will have to contact their support and request them
      userPayload.loginMethods.push({
        recipeId: "emailpassword",
        email: identity.profileData?.email ?? auth0User.email,
	// Request the password hash from Auth0 and then implement the function to retrieve the values 
        passwordHash: getPasswordHash(identity.profileData?.email),
        hashingAlgorithm: "bcrypt",
        isVerified: identity.profileData?.email_verified ?? auth0User.email_verified ?? false,
        isPrimary: index === 0,
        timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
      });
    } else if (identity.provider === 'sms') {
      userPayload.loginMethods.push({
	recipeId: "passwordless",
	phoneNumber: identity.profileData?.phone_number || auth0User.phone_number,
	isVerified: identity.profileData?.phone_verified ?? auth0User.phone_verified ?? false,
	isPrimary: index === 0,
	timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
      });
    } else if (identity.provider === 'email') {
      userPayload.loginMethods.push({
	recipeId: "passwordless",
	email: identity.profileData?.email || auth0User.email,
	isVerified: identity.profileData?.email_verified ?? auth0User.email_verified ?? false,
	isPrimary: index === 0,
	timeJoinedInMSSinceEpoch: new Date(auth0User.created_at).getTime()
      });
    } else {
      throw new Error(`Uknown provider: ${identity.provider}`);
    }
  });
  
  return userPayload;
});

fs.writeFileSync('supertokens_users.json', JSON.stringify({ users: superTokensUsers }, null, 2));

function mapProvider(auth0Provider) {
  const mapping = {
    'google-oauth2': 'google',
    'facebook': 'facebook',
    'github': 'github',
    'apple': 'apple'
  };
  return mapping[auth0Provider] || auth0Provider;
}

console.log(`Transformed ${superTokensUsers.length} users`);
```

</Accordion>

### 3. Perform the bulk migration process

:::warning

If your application has a sign up process please make sure that you have completed the [**first step**](#1-update-the-legacy-sign-up-flow).
Otherwise, new accounts that get created after you have exported your users are not available in **SuperTokens**. 

:::

#### 3.1 Add the accounts to import

Using the data that you have generated in the previous step, call the `Add Users for Bulk Import` endpoint.
This step stages the data that the background job imports later.

Keep in mind that the endpoint has a limit of **10000 users** per request.

<HTTPRequestCard path="/bulk-import/users" method="post" title="Add Users for Bulk Import">
  <HTTPRequestCard.ShellExample>

```bash
curl --location --request POST '<CORE_URI>/bulk-import/users' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data-raw '{
    users: [
    {
      "externalUserId": "user_2",
      "userMetadata": {
        "firstName": "John",
        "lastName": "Doe",
        "department": "Marketing"
      },
      "userRoles": [{ "role": "editor", "tenantIds": [] }],
      "loginMethods": [
        {
          "isVerified": true,
          "isPrimary": true,
          "timeJoinedInMSSinceEpoch": 1672617599000,
          "recipeId": "thirdparty",
          "email": "john.doe@gmail.com",
          "thirdPartyId": "google",
          "thirdPartyUserId": "google_987654321"
        }
      ]
  }
    ]
}
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/bulk-import/users`;
    const options = {
      method: 'POST',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
      body: JSON.stringify({
        users: [
          {
            externalUserId: "user_2",
            userMetadata: {
              firstName: "John",
              lastName: "Doe",
              department: "Marketing"
            },
            userRoles: [{ role: "editor", tenantIds: [] }],
            loginMethods: [
              {
                isVerified: true,
                isPrimary: true,
                timeJoinedInMSSinceEpoch: 1672617599000,
                recipeId: "thirdparty",
                email: "john.doe@gmail.com",
                thirdPartyId: "google",
                thirdPartyUserId: "google_987654321"
              }
            ]
          }
        ]
      })
    }

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
    ```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

    BASE_URL = "<CORE_URI>"
    API_KEY = "^{coreInfo.key}"

    url = f"{BASE_URL}/bulk-import/users"

    payload: Dict[str, Any] = {
        "users": [
            {
                "externalUserId": "user_2",
                "userMetadata": {
                    "firstName": "John",
                    "lastName": "Doe",
                    "department": "Marketing"
                },
                "userRoles": [{ "role": "editor", "tenantIds": [] }],
                "loginMethods": [
                    {
                        "isVerified": True,
                        "isPrimary": True,
                        "timeJoinedInMSSinceEpoch": 1672617599000,
                        "recipeId": "thirdparty",
                        "email": "john.doe@gmail.com",
                        "thirdPartyId": "google",
                        "thirdPartyUserId": "google_987654321"
                    }
                ]
            }
        ]
    }

    headers = {
        "api-key": API_KEY,
        "Content-Type": "application/json",
    }

    response = requests.post(url, json=payload, headers=headers)

    print(response.json())
    ```

  </HTTPRequestCard.PythonExample>
  <HTTPRequestCard.DetailsModal>
    <HTTPRequestCard.DetailsModalHeader>
  <HTTPRequestCard.DetailsModalDescription>
    Stages users to be imported by a background cron job.
  </HTTPRequestCard.DetailsModalDescription>
  <HTTPRequestCard.DetailsModalDescription>
    **Authorization**: Set the `api-key` header to the value of your **SuperTokens** Core API key.
  </HTTPRequestCard.DetailsModalDescription>
</HTTPRequestCard.DetailsModalHeader>

<HTTPRequestCard.DetailsModalBody>

 <H2>Request</H2>

 <H3>Body Schema</H3>

| Name           | Type                | Description                       | Required |
|----------------|---------------------|-----------------------------------|----------|
| users | `Array` of `User` objects |  The users that you want to import. The array has a limit of 10000 items. | Yes |

<H4>User</H4>

| Name           | Type                   | Description                                                                                     | Required |
|----------------|------------------------|-------------------------------------------------------------------------------------------------|----------|
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider                         | No       |
| `userMetadata`   | `object`               | An object with custom user information that can be used later on                               | No       |
| `userRoles`      | `array` of `UserRole`     | The roles that will be used for authorization                                                   | No       |
| `totpDevices`    | `array` of `TotpDevice`  | Time-based One-time Password device (TOTP) used for Multi-Factor Authentication                 | Yes      |
| `loginMethods`   | `array` of `LoginMethod` | The actual authentication methods and credentials                                              | Yes      |

##### TotpDevice

| Name       | Type                | Description                                                                 | Required |
|------------|---------------------|-----------------------------------------------------------------------------|----------|
| `secretKey`  | `string`            | The secret key used to generate the TOTP codes.                             | Yes      |
| period     | `number`            | The time period in seconds for which a TOTP code is valid.                  | Yes      |
| skew       | `number`            | The allowable time skew to account for clock differences between the server and device. | Yes      |
| `deviceName` | `string`            | The name assigned to the TOTP device for identification purposes.           | No       |

<H4>UserRole</H4>

| Name       | Type                | Description                                                                 | Required |
|------------|---------------------|-----------------------------------------------------------------------------|----------|
| role       | `string`            | The actual role name                             | Yes      |
| tenantIds  | Array of `string` | The tenants that use this role. If you are not using the `multi-tenancy` just pass an empty array. | Yes |

##### LoginMethod

`LoginMethod` is a polymorphic type with multiple variants based on the `recipeId`. Each variant includes shared and specific fields.

###### EmailPassword 

###### With Encrypted Password

| Name                    | Type                  | Description                                                                                     | Required |
|-------------------------|-----------------------|-------------------------------------------------------------------------------------------------|----------|
| email                   | `string`              | User's email address                                                                            | Yes      |
| `passwordHash`            | `string`              | Hashed password                                                                                 | Yes      |
| `hashingAlgorithm`        | `enum` (`"bcrypt"`, `"argon2"`, `"firebase_scrypt"`)                | Hashing algorithm used.                     | Yes      |
| `recipeId`                | `string`              | Must be `emailpassword`                                                                          | Yes      |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

###### With Plain Password

| Name                    | Type                  | Description                                                                                     | Required |
|-------------------------|-----------------------|-------------------------------------------------------------------------------------------------|----------|
| email                   | `string`              | User's email address                                                                            | Yes      |
| `plaintextPassword` | `string`              | A plain text password that will be hashed based on the configured hashing algorithm              | Yes      |
| `recipeId`                | `string`              | Must be `emailpassword`                                                                          | Yes      |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

##### ThirdParty 
   | Name             | Type   | Description                   | Required |
   |------------------|--------|-------------------------------|----------|
   | `recipeId`         | `string` | Must be `"thirdparty"`        | Yes      |
   | email            | `string` | User's email address          | Yes      |
   | thirdPartyId     | `string` | Identifier for the third party provider | Yes |
   | thirdPartyUserId | `string` | User identifier from the third party provider | Yes |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

##### Passwordless 

   | Name     | Type   | Description           | Required |
   |----------|--------|-----------------------|----------|
   | `recipeId` | `string` | Must be `"passwordless"` | Yes      |
   | email    | `string` | User's email address  | One of `email` or `phoneNumber` must be provided |
   | `phoneNumber` | `string` | User's phone number | One of `email` or `phoneNumber` must be provided |
| tenantIds | Array of `string`             | The tenant IDs that the user belongs to (if you are using the `multi-tenancy` feature)                                                                       | No       |
| externalUserId | `string`               | ID that can be used to reference the users from your previous provider only for this authentication method                         | No       |
| `isVerified`              | `boolean`             | Indicates whether the user's email has been verified                                             | No       |
| `isPrimary`               | `boolean`             | Indicates whether this is the user's primary authentication method                               | No       |
| timeJoinedInMSSinceEpoch| `number`              | Timestamp representing when the user joined, in milliseconds since the Unix epoch                 | No       |

<H3>Example</H3>

```bash
curl --location --request POST '<CORE_URI>/bulk-import/users' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data-raw '{
    users: [
    {
      "externalUserId": "user_2",
      "userMetadata": {
        "firstName": "John",
        "lastName": "Doe",
        "department": "Marketing"
      },
      "userRoles": [{ "role": "editor", "tenantIds": [] }],
      "loginMethods": [
        {
          "isVerified": true,
          "isPrimary": true,
          "timeJoinedInMSSinceEpoch": 1672617599000,
          "recipeId": "thirdparty",
          "email": "john.doe@gmail.com",
          "thirdPartyId": "google",
          "thirdPartyUserId": "google_987654321"
        }
      ]
  }
    ]
}
```

<H2>Response</H2>

<H3>200</H3>
All the users have been added to the `bulk_import_users` table.

<H4>Example</H4>

```json
{ 
  "status": "OK",
}
```

<H3>400</H3>

The request body was invalid.

<H4>Example</H4>

```json
```json
{
  error: "Failed to add users for the bulk import. Please fix the error in the following users",
  users: [
    {
      index: 11,
      errors: ["No two loginMethods can have isPrimary as true."]
    },
    {
      index: 15,
      errors: ["email is required for recipeId emailpassword", "hashingAlgorithm must be one of 'bcrypt', 'argon2', or 'firebase_scrypt'."]
    }
  ]
}
```

##### Errors

- Account linking must be enabled if more than one login method is provided for a user.
- Multitenancy must be enabled if a `tenantId` is other than `public.`
- No two `loginMethods` can have `isPrimary` as `true`.
- Invalid `appId` or `tenantId`.
- A valid `email` is required.
- A valid `passwordHash` is required.
- `hashingAlgorithm` must be one of 'bcrypt', 'argon2', or `firebase_scrypt`.
- A valid `email` is required.
- `thirdPartyUserId` is required.
- A valid `email` or `phoneNumber` is required.

<H3>500</H3>

An internal server error occurred.

</HTTPRequestCard.DetailsModalBody>
  </HTTPRequestCard.DetailsModal>
</HTTPRequestCard>

:::info The Bulk Import Cron Job

Every 5 minutes the **SuperTokens** core service runs a cron job that goes through the staged users and tries to import them.
If a user gets imported successfully it gets removed from the staged list.

:::

#### 3.2 Monitor the progress of the job

To determine if the import flow has processed all the users call the [`Count Staged Users`](#count-staged-users-http-request) API.

Before doing that, first understand the different states in which a staged user can be.
During the import process, the user can have one of the following statuses:
- **NEW (not yet started)**: The import process has not yet picked up the user.
- **PROCESSING**: The import process has selected the user for import.
- **FAILED**: The import process has failed for that user.

If a user gets imported successfully it then gets removed from the staged list. Hence, no status exists for that state.

With this new information, get back to the `count users` endpoint.
The request counts the users that await import.
Pass a status filter as a query parameter (for example, `status=NEW`) to count only the users with that status.

Given that information, to check if your import is complete do the following:
1. Call the `count users` API once without any filters. If the count is 0, then the import process is complete.
2. If the count is not 0, then check if you still have rows that are getting processed (`status=PROCESSING`) or if there are rows that the import job has not yet picked up (`status=NEW`)
3. If the only rows that remain are the ones with the `FAILED` status, then proceed to step `3.3`. There you can see how to debug those issues.

<HTTPRequestCard path="/bulk-import/users/count" method="get" title="Count Staged Users">
  <HTTPRequestCard.ShellExample>

```bash
  curl --location --request GET '<CORE_URI>/bulk-import/users/count?status=PROCESSING' \
     --header 'api-key: ^{coreInfo.key}' \
     --header 'Content-Type: application/json; charset=utf-8' \
```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

  ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/bulk-import/users/count?status=PROCESSING`;
    const options = {
      method: 'GET',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
    }

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
  ```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go
    ```

  </HTTPRequestCard.ShellExample>
  <HTTPRequestCard.NodeJSExample>

    ```tsx
    const BASE_URL = '<CORE_URI>';
    const API_KEY = '^{coreInfo.key}';

    const url = `${BASE_URL}/bulk-import/users?status=FAILED`;
    const options = {
      method: 'GET',
      headers: {
        'api-key': API_KEY,
        'Content-Type': 'application/json; charset=utf-8',
      },
    }

    fetch(url, options)
      .then(response => response.json())
      .then(json => console.log(json))
      .catch(err => console.error(err));
    ```

  </HTTPRequestCard.NodeJSExample>
  <HTTPRequestCard.GoExample>

    ```go

:::success You have successfully migrated your accounts

If all your data has imported then you can consider the account migration process complete.
Go on to the [session migration](/docs/migration/session-migration) step to complete the entire migration flow.

:::


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/migration/session-migration" label="Session migration" />
  <ReferenceCard href="/docs/migration/legacy/about" label="Legacy migration" />
  <ReferenceCard href="/docs/post-authentication/user-management/introduction" label="User management" />
  <ReferenceCard href="/docs/post-authentication/account-linking/introduction" label="Account linking" />
</ReferenceCard.Grid>

# Migration -  Session Migration
Source: https://supertokens.com/docs/migration/session-migration

<DescriptionText>
  This guide will show you how to migrate your user sessions from you previous authentication provider to **SuperTokens**.
</DescriptionText>

<Separator />

## Overview

To achieve a seamless transition process, you will also have to migrate the active sessions that use your previous authentication provider to **SuperTokens**.
To do this you should create a new flow that will determine if an existing user session needs to be migrated, and call the migration API if necessary.

You can see a detailed illustration of the process below.

<img src="/img/migration/session-migration-diagram.png" alt="Session migration flow chart" />

## Steps

### 1. Add the session migration endpoint

Create a new endpoint on your backend that will generate a new **SuperTokens Session** based on the current authentication token.
This will be called by the frontend if a user is still logged in through your previous authentication provider.

```tsx title="Backend changes"

let app = express();

app.post("/migrate-session", async (req, res) => {

    // extract the access token from the request object
    if(req.headers.authorization !== undefined){
        let access_token = req.headers.authorization.split("Bearer ")[1];

        // verify the access token and retrieve the old userId
        let customUserId = await verifyAccessTokenAndRetriveUserId(access_token);

        // create a new SuperTokens session using the customUserId
        // the createNewSession function will attach the SuperTokens session tokens to the response object.
        // @ts-ignore
        await Session.createNewSession(req, res, customUserId)
        res.send({
            status: "OK"
        })
    }

    // handle access_token not present in request
    
})

async function verifyAccessTokenAndRetriveUserId(access_token: string): Promise<string> {
    // verify the access_token and return the decoded userId
    return "...";
}

```

:::info Important

Verifying the access token will require you to access your previous providers JWKS endpoint.
This means that you will have to continue to use your previous auth provider even after switching to SuperTokens.

If you want to immediately stop querying your previous authentication provider you can use the JWKS public keys and provide them as a secret to the JWT verification function.
You can follow our [guide](/docs/additional-verification/session-verification/protect-api-routes#with-the-public-key-string) on how to do this.
:::

### 2. Call the migration endpoint from your frontend app

On your frontend, on page load, check if a session with your previous authentication provider exists.
- If a session exists, send a request to the `/migrate-session` API with the access token to create a new SuperTokens session.
- Revoke the old session.

```tsx title="Frontend changes"

// Call this function on page load
async function migrateUserSessions() {
    let apiDomain = "...";
    // On page load retrieve the users access token if a session exists
    let accessToken = await getAccessTokenFromOldProvider()

    if (accessToken !== undefined) {

        // send a request to your migrate session endpoint with the bearer token
        await axios.post(`${apiDomain}/migrate-session`, {
            headers: {
                "Authorization": `Bearer ${accessToken}`
            }
        })
        await revokeSessionFromOldProvider()
    }
}

async function getAccessTokenFromOldProvider(): Promise<string | undefined> {
    // Check if a session with your your previous provider exists and return the access_token. Return undefined otherwise
    return "..."
}

async function revokeSessionFromOldProvider() {
    // Revoke the session associated with the previous provider
}

```
---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/migration/account-migration" label="Account migration" />
  <ReferenceCard href="/docs/migration/legacy/about" label="Legacy migration" />
  <ReferenceCard href="/docs/post-authentication/session-management/introduction" label="Session management" />
</ReferenceCard.Grid>

# Migration - Legacy Method -  About
Source: https://supertokens.com/docs/migration/legacy/about

In this guide we will be going through the process of migrating users from an external Authentication provider to SuperTokens.

User migration involves 3 steps:

- Account Migration
  - User Creation
  - UserId Mapping
  - Mark email as verified
- User Data Migration
- Session Migration

## Step 1. Account Migration:

### User Creation
- Our first step involves creating a SuperTokens user by importing their account credentials from the previous authentication provider.
- You can learn more about how to implement these changes in the [User Creation](./account-creation/user-creation) section. 

### User ID Mapping
- If you have stored information against existing userIds in your application table, you can use UserId Mapping to map the existing userId to the user's SuperTokens userId.
- Once the userIds are mapped you can use the existing userId to interact with all of SuperTokens APIs.
- You can learn more about how to implement these changes in the [User Id Mapping](./account-creation/user-id-mapping) section.

### Mark email as verified
- Once a SuperTokens user has been created and their userId has been mapped, you need to mark their email as verified (if applicable) so that they do not have to go through the email verification process again.
- You can learn more about how to implement these changes in [this section](./account-creation/email-verification).

## Step 2. User Data Migration
- Now that your user's account has been migrated over to SuperTokens we can associate additional information like roles and metadata with your user.
- You can learn more about how to implement these changes in the [User Data Migration](./data-migration) section.

## Step 3. Session Migration

- If you have users with an existing session, you can use [this guide](./session-migration) to migrate their external provider sessions to a SuperTokens session.
- This will prevent users from having to re-authenticate.

You can learn more about how to implement these changes in the [Session Migration](./session-migration) section.

## Step 4. MFA migration
If you are using MFA in your app, checkout the MFA migration section [here](/docs/additional-verification/mfa/migration/legacy-to-new) after you have gone through the above migration steps.

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/migration/overview" label="Migration overview" />
  <ReferenceCard href="/docs/migration/account-migration" label="Account migration" />
  <ReferenceCard href="/docs/migration/session-migration" label="Session migration" />
  <ReferenceCard href="/docs/additional-verification/mfa/migration/legacy-to-new" label="MFA migration" />
  <ReferenceCard href="/docs/migration/legacy/data-migration" label="User data migration" />
</ReferenceCard.Grid>

# Migration - Legacy Method - Step 1: Account Creation -  User Creation
Source: https://supertokens.com/docs/migration/legacy/account-creation/user-creation

## Email Password Migration

:::important
If you do not have access to your user's password hashes, you can use our [guide for migrating them dynamically during login](./ep-migration-without-password-hash).
:::

SuperTokens allows you to import users with password hashes generated with `BCrypt`, `Argon2` and `Firebase SCrypt` with our import user API.
You can find the API spec [here](https://app.swaggerhub.com/apis/supertokens/CDI/2.16.0#/EmailPassword%20Recipe/userImport).

### Migrating users With Argon2 or `BCrypt` Password hashes

For users with `BCrypt` or `Argon2` password hashes you can use the following curl command to import your user.

```bash
curl --location --request POST '<CORE_URI>/recipe/user/passwordhash/import' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "email": "johndoe@example.com",
    "passwordHash": "$argon2d$v=19$m=12,t=3,p=1$NWd0eGp4ZW91b3IwMDAwMA$57jcfXF19MyiUXSjkVBpEQ"
}'
```

:::important
SuperTokens accepts `BCrypt` and `Argon2` hashes in standard format. When exporting password hashes from authentication providers the structure might be changed. For example, Auth0 adds an identifier to the exported password hashes which needs to be removed before importing into SuperTokens.

Sample password hashes for `BCrypt` and Argon2 in standard format:

- `BCrypt`: `$2a$10$GzEm3vKoAqnJCTWesRARCe/ovjt/07qjvcH9jbLUg44Fn77gMZkmm`
- Argon2: `$argon2id$v=19$m=16,t=2,p=1$VG1Oa1lMbzZLbzk5azQ2Qg$kjcNNtZ/b0t/8HgXUiQ76A`
:::

### Migrating users with Firebase `SCrypt` Password hashes

Importing users from Firebases requires an update to your SuperTokens core config and formatting the input password hash.

#### Step 1: Retrieve your Firebase password hashing parameters from your dashboard.

<img src="/img/migration/firebase_password_hashing_params.png" alt="Firebase password hashing details modal" />

#### Step 2: Update the SuperTokens core to use the `base64_signer_key`

- ** For Managed Service **

- Edit the core configuration in the SuperTokens Managed Service Dashboard.
- Set the `firebase_password_hashing_signer_key` field in the config to the `base64_signer_key` retrieved from your firebase hashing parameters.

<Tabs>

<Tab value="with-docker">

```bash
 docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e FIREBASE_PASSWORD_HASHING_SIGNER_KEY="gRhC3eDeQOdyEn4bMd9c6kxguWVmcIVq/HbJKnCXdWscZx0l2WbCJ1wbg==" \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```

</Tab>
<Tab value="without-docker">

```yaml
# Add your base64_signer_key to the following in the config.yaml file.
# The file path can be found by running the "supertokens --help" command

firebase_password_hashing_signer_key: "gRhC3eDeQOdyEn4bMd9c6kxguWVmcIVq/HbJKnCXdWscZx0l2WbCJ1wbg=="
```

</Tab>
</Tabs>

####  Step 3: SuperTokens requires firebase password hashes to be in a specific format to be parsed.

  For example:

  Your exported firebase user has the following credentials:
  ```json
  {
    "users": [
      {
        "localId": "userId",
        "email": "johnDoe@example.com"
        "passwordHash": "9Y8ICWcqbzmI42DxV1jpyEjbrJPG8EQ6nI6oC32JYz+/dd7aEjI/R7jG9P5kYh8v9gyqFKaXMDzMg7eLCypbOA==",
        "salt": "/cj0jC1br5o4+w==",
      }
    ]
  }
  ```

  The memory cost, rounds and salt separator retrieved from the password hashing config are:
  ```json
  {
    mem_cost: 14,
    rounds: 8,
    base64_salt_separator: "Bw=="
  }
  ```
  
  The password hash would be the following: `$f_scrypt$9Y8ICWcqbzmI42DxV1jpyEjbrJPG8EQ6nI6oC32JYz+/dd7aEjI/R7jG9P5kYh8v9gyqFKaXMDzMg7eLCypbOA==$/cj0jC1br5o4+w==$m=14$r=8$s=Bw==`

  The example password hash is in the following format `$f_scrypt$<passwordHash>$<salt>$m=<mem_cost>$r=<rounds>$s=<base64_salt_separator>`

#### Step 4: Run the following `curl` command to import the user

```bash
curl --location --request POST '<CORE_URI>/recipe/user/passwordhash/import' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'api-key: ^{coreInfo.key}' \
--data-raw '{
  "email": "test@example.com",
  "passwordHash": "$f_scrypt$9Y8ICWcqbzmI42DxV1jpyEjbrJPG8EQ6nI6oC32JYz+/dd7aEjI/R7jG9P5kYh8v9gyqFKaXMDzMg7eLCypbOA==$/cj0jC1br5o4+w==$m=14$r=8$s=Bw==",
  "hashingAlgorithm": "firebase_scrypt"
}'
```

## Passwordless Migration

To migrate a Passwordless user from your previous authentication provider to SuperTokens, you will first need to generate a code for the user and then call the consume code API.

### Generate passwordless code

**With Email**

```bash
curl --location --request POST '<CORE_URI>/recipe/signinup/code' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "email": "johndoe@example.com"
}'
```

**With Phone Number**

```bash
curl --location --request POST '<CORE_URI>/recipe/signinup/code' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "phoneNumber": "+14155552671"
}'
```

On successfully generating the passwordless code you should see the following response

```json
{
    "status": "OK",
    "preAuthSessionId": "d3Zpa9eoyV2Wr7uN5DLr6H1clzbwwGTc_0wIIXJT55M=",
    "codeId": "4fe93f8e-a5da-4588-82e2-314c6993b345",
    "deviceId": "+cWm1Y2EFxEPyHM7CAwYyAdkakBeoEDm6IOGT3xfa1U=",
    "userInputCode": "463152",
    "linkCode": "UlEb3-gbIYow61ce6RNzghkGN8qcHkpRwbhHbvMEjxY=",
    "timeCreated": 1664283193059,
    "codeLifetime": 900000
}
```

### Consume the passwordless code to create the passwordless user

Retrieve the `preAuthSessionId` and `linkCode` from the previous response and set them as request body parameters for the consume code request.

```bash
curl --location --request POST '<CORE_URI>/recipe/signinup/code/consume' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "preAuthSessionId": "d3Zpa9eoyV2Wr7uN5DLr6H1clzbwwGTc_0wIIXJT55M=",
    "linkCode": "UlEb3-gbIYow61ce6RNzghkGN8qcHkpRwbhHbvMEjxY="
}'
```

If the user has both email and password associated with them, then you can call the update user API to associate the missing information

```bash
curl --location --request PUT '<CORE_URI>/recipe/user' \
--header 'api-key: ^{coreInfo.key}' \
--header 'rid: passwordless' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "email": "johndoe@gmail.com",
  "phoneNumber": "+14155552671"
}'
```

## ThirdParty Migration

To migrate users with social accounts we can simply call the SuperTokens Core's `signInUp` API with the provider Id and the user's third party userId.

For example:

If we were importing a user with Google as their provider with their third party userId being `106347997792363870000`, we can run the following curl command to import the user.  

```bash
curl --location --request POST '<CORE_URI>/recipe/signinup' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "thirdPartyId": "google",
  "thirdPartyUserId": "106347997792363870000",
  "email": {
    "id": "johndoe@gmail.com",
    "isVerified": true
  }
}'
```

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/migration/legacy/account-creation/ep-migration-without-password-hash" label="EP migration without password hash" />
  <ReferenceCard href="/docs/migration/legacy/account-creation/user-id-mapping" label="User ID mapping" />
  <ReferenceCard href="/docs/migration/legacy/account-creation/email-verification" label="Email verification" />
  <ReferenceCard href="/docs/migration/account-migration" label="Account migration" />
  <ReferenceCard href="/docs/migration/legacy/session-migration" label="Session migration" />
</ReferenceCard.Grid>

# Migration - Legacy Method - Step 1: Account Creation -  UserId Mapping
Source: https://supertokens.com/docs/migration/legacy/account-creation/user-id-mapping

UserId Mapping allows you to map existing userIds (from your old auth provider) to the SuperTokens userIds. This prevents you from having to update the existing `userIDs` in your application's table.

As an example, if after creating the user in SuperTokens, their userId is `fa7a0841-b533-4478-95533-0fde890c3483` and the existing userId for that user is `customUserId`, then you can map these user IDs by calling the following API:

```bash
curl --location --request POST '<CORE_URI>/recipe/userid/map' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "superTokensUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "externalUserId": "customUserId"
}'
```

Now whenever this user signs in, or if you fetch information about this user from SuperTokens, their userID will be `customUserId`.

:::info Note
The maximum allowed size of the `externalUserId` is 128 characters.
:::

# Migration - Legacy Method - Step 1: Account Creation -  Mark email as verified
Source: https://supertokens.com/docs/migration/legacy/account-creation/email-verification

Once a SuperTokens user has been created and their userId has been mapped, you need to mark their email as verified, if their email was verified in the old auth provider.

## Step 1. Generating the email verification token:

For example with the email as `johnDoe@gmail.com` and userId as `056f4b02-c992-42ed-a8af-cb709669bbd`

```bash
curl --location --request POST '<CORE_URI>/recipe/user/email/verify/token' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "email": "johnDoe@gmail.com",
  "userId": "056f4b02-c992-42ed-a8af-cb709669bbd"
}'
```

Successfully generating an email verification token will result in the following response 

```bash
{
    "status":"OK",
    "token":"OWU2OGQyZWQ5MGFkMzM1M2Y4ZDMzNjE1NzA4ZGI0YWYyODEwMzg0NjJhNTcxNDZjYmY0NzJiOTZmYWE5OTJkMzRmOWVkYzBiODZkMWNmYTJkY2I5YWJkZDU2Yjg0NTU0"    
} 
```

## Step 2. Verifying the users email with the verification token 

Retrieve the token from the response of the previous request and set it in the body of the email verification request.

```bash
curl --location --request POST '<CORE_URI>/recipe/user/email/verify' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "method": "token",
  "token": "OWU2OGQyZWQ5MGFkMzM1M2Y4ZDMzNjE1NzA4ZGI0YWYyODEwMzg0NjJhNTcxNDZjYmY0NzJiOTZmYWE5OTJkMzRmOWVkYzBiODZkMWNmYTJkY2I5YWJkZDU2Yjg0NTU0"
}'
```

# Migration - Legacy Method - Step 1: Account Creation -  User Creation without password hashes
Source: https://supertokens.com/docs/migration/legacy/account-creation/ep-migration-without-password-hash

:::caution
The recommended method for migrating users to SuperTokens is by [importing users with their password hashes](./user-creation).
You should only use the following method if you do not have access to your user's password hashes and still have access to your previous identity provider.
:::

SuperTokens also supports the "**in time**" user migration strategy for when password hashes cannot be exported from your legacy provider.

We need to make the following customizations to SuperTokens authentication flows to support this strategy:

- **Step 1) Prevent sign ups from users who exist in the external provider.**
  - To prevent duplicate accounts from being created, we block sign ups from users who have existing accounts with the external provider.
- **Step 2) Create a SuperTokens account for users trying to sign in if they have an account with the external provider.**
  -  We modify the sign in flow to check if the user signing in has an existing account with the external provider and not with SuperTokens. If their input credentials are valid, we create a SuperTokens user and import their user data.
- **Step 3) Create a SuperTokens account for users who have an account with the external provider but have forgotten their password.**
  - Some users who have an account with the external provider and not with SuperTokens may have forgotten their passwords and trigger the password reset flow. Since SuperTokens requires an existing account to send the reset password email to, we need to modify the password reset flow to check that if the user needs to be migrated. If they do, we create a SuperTokens account with a temporary password, import their user data and continue the password reset flow.
   - To ensure that users can only sign in once they successfully reset their passwords we add the `isUsingTemporaryPassword` flag to the account's metadata. We also modify the sign in flow to block sign ins from accounts with this metadata.
- **Step 4) Remove the `isUsingTemporaryPassword` flag on successful password reset**
  - Once the password has been successfully reset we check if the user has the `isUsingTemporaryPassword` flag set in the metadata. If they do we clear the flag from the user's metadata.
- **Step 5) Update the login flow to account for the `isUsingTemporaryPassword` flag**
  - We also update the login flow to prevent sign ins from accounts who have the `isUsingTemporaryPassword` flag and if their input password does not match the one in the legacy auth provider. This ensures that users who started the password reset flow are forced to finish it.

## Step 1) Prevent sign ups from users who exist in the external provider

To implement this change we override the API that handles email-password login when initializing the recipe on the backend.

<Tabs>
<Tab value="nodejs">

```tsx

EmailPassword.init({
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                signUpPOST: async function (input) {
                    let email = input.formFields.find((field) => field.id === "email")!.value as string;
                    // Check if the user signing in exists in the external provider
                    if (await doesUserExistInExternalProvider(email)) {
                        // Return status "EMAIL_ALREADY_EXISTS_ERROR" since the user already exists in the external provider
                        return {
                            status: "EMAIL_ALREADY_EXISTS_ERROR"
                        }
                    }
                    return originalImplementation.signUpPOST!(input);
                },
            }
        },
    }
})

async function doesUserExistInExternalProvider(email: string): Promise<boolean> {
    // TODO: check if user with the input email exists in the external provider
    return false;
}
```

</Tab>

<Tab value="python">

```python
from typing import Any, Dict, List, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    EmailAlreadyExistsError,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.session.interfaces import SessionContainer

def override_email_password_apis(original_implementation: APIInterface):
    original_sign_up = original_implementation.sign_up_post

    async def sign_up(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        email = ""
        for field in form_fields:
            if field.id == "email":
                email = field.value
        # check if the user signing in exists in the external provider
        if await does_user_exist_in_external_provider(email):
            # Return SignUpEmailAlreadyExistsError since the user exists in the external provider
            return EmailAlreadyExistsError()

        return await original_sign_up(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

    original_implementation.sign_up_post = sign_up
    return original_implementation

async def does_user_exist_in_external_provider(email: str):
    # TODO: Check if a user with the input email exists in the external provider
    return False

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            override=emailpassword.InputOverrideConfig(
                apis=override_email_password_apis,
            )
        )
    ],
)
```

</Tab>   

<Tab value="go">

```go

EmailPassword.init({
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                signInPOST: async function (input) {
                    // Check if an email-password user with the input email exists in SuperTokens
                    let email = input.formFields.find((field) => field.id === "email")!.value as string;
                    let password = input.formFields.find((field) => field.id === "password")!.value as string;
                    let supertokensUsersWithSameEmail = await SuperTokens.listUsersByAccountInfo(input.tenantId, {
                        email: email
                    }, undefined, input.userContext);
                    let emailPasswordUser = supertokensUsersWithSameEmail.find(u => {
                        return u.loginMethods.find(lM => lM.hasSameEmailAs(email) && lM.recipeId === "emailpassword") !== undefined;
                    })

                    if (emailPasswordUser === undefined) {
                        // EmailPassword user with the input email does not exist in SuperTokens
                        // Check if the input credentials are valid in the external provider
                        let legacyUserInfo = await validateAndGetUserInfoFromExternalProvider(email, password)
                        if (legacyUserInfo === undefined) {
                            // credentials are incorrect
                            return {
                                status: "WRONG_CREDENTIALS_ERROR"
                            }
                        }

                        // Call the signup function to create a new SuperTokens user.
                        let signUpResponse = await EmailPassword.signUp(input.tenantId, email, password, undefined, input.userContext);
                        if (signUpResponse.status !== "OK") {
                            throw new Error("Should never come here")
                        }

                        // Map the external provider's userId to the SuperTokens userId
                        await SuperTokens.createUserIdMapping({ superTokensUserId: signUpResponse.user.id, externalUserId: legacyUserInfo.user_id })

                        // Set the userId in the response to use the provider's userId
                        signUpResponse.user.id = legacyUserInfo.user_id
                        signUpResponse.user.loginMethods[0].recipeUserId = new RecipeUserId(legacyUserInfo.user_id);
                        signUpResponse.recipeUserId = new RecipeUserId(legacyUserInfo.user_id);

                        // We also need to set the email verification status of the user
                        if (legacyUserInfo.isEmailVerified) {
                            // Generate an email verification token for the user
                            let generateEmailVerificationTokenResponse = await EmailVerification.createEmailVerificationToken(input.tenantId, signUpResponse.recipeUserId, email, input.userContext);

                            if (generateEmailVerificationTokenResponse.status === "OK") {
                                // Verify the user's email
                                await EmailVerification.verifyEmailUsingToken("public", generateEmailVerificationTokenResponse.token, undefined, input.userContext);
                            }
                        }
                    }

                    return originalImplementation.signInPOST!(input)
                },
            }
        },
    }
})

async function validateAndGetUserInfoFromExternalProvider(email: string, password: string): Promise<{
    user_id: string,
    isEmailVerified: boolean
} | undefined> {
    // TODO: Validate the input credentials against the external authentication provider. If the credentials are valid return the user info.
    return undefined
}
```

</Tab>

<Tab value="python">

```python
from typing import Any, Dict, List, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import (
    create_user_id_mapping,
    list_users_by_account_info,
)
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.asyncio import sign_up
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    SignUpOkResult,
    WrongCredentialsError,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.emailverification.asyncio import (
    create_email_verification_token,
    verify_email_using_token,
)
from supertokens_python.recipe.emailverification.interfaces import (
    CreateEmailVerificationTokenOkResult,
)
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.types import RecipeUserId
from supertokens_python.types.base import AccountInfoInput

def override_emailpassword_apis(original_implementation: APIInterface):
    original_emailpassword_sign_in = original_implementation.sign_in_post

    async def sign_in(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        email = ""
        password = ""
        for field in form_fields:
            if field.id == "email":
                email = field.value
            if field.id == "password":
                password = field.value
        #  Check if an email-password user with the input email exists in SuperTokens
        supertokens_user_with_same_email = await list_users_by_account_info(
            tenant_id, AccountInfoInput(email=email), False, user_context
        )
        emailpassword_user = next(
            (
                user
                for user in supertokens_user_with_same_email
                if any(
                    lm.recipe_id == "emailpassword" and lm.has_same_email_as(email)
                    for lm in user.login_methods
                )
            ),
            None,
        )

        if emailpassword_user is None:
            # EmailPassword user with the input email does not exist in SuperTokens
            # Check if the input credentials valid in the external provider
            legacy_user_info = await validate_and_get_user_info_from_external_provider(
                email, password
            )
            if legacy_user_info is None:
                # Credentials are incorrect
                return WrongCredentialsError()

            # Call the sign_up function to create a new SuperTokens user.
            response = await sign_up(tenant_id, email, password, None, user_context)
            if not isinstance(response, SignUpOkResult):
                raise Exception("Should never come here")

            # Map the external provider's userId to the SuperTokens userId
            await create_user_id_mapping(response.user.id, legacy_user_info.user_id)
            # Set the userId in the response to use the provider's userId
            response.user.id = legacy_user_info.user_id
            response.user.login_methods[0].recipe_user_id = RecipeUserId(
                legacy_user_info.user_id
            )
            response.recipe_user_id = RecipeUserId(legacy_user_info.user_id)

            # We also need to set the email verification status of the user
            if legacy_user_info.isEmailVerified:
                # Generate an email verification token for the user
                generate_email_verification_response = (
                    await create_email_verification_token(
                        tenant_id,
                        response.recipe_user_id,
                        email,
                        user_context,
                    )
                )
                if isinstance(
                    generate_email_verification_response,
                    CreateEmailVerificationTokenOkResult,
                ):
                    await verify_email_using_token(
                        tenant_id,
                        generate_email_verification_response.token,
                        True,
                        user_context,
                    )

        return await original_emailpassword_sign_in(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

    original_implementation.sign_in_post = sign_in
    return original_implementation

class ExternalUserInfo:
    def __init__(self, user_id: str, isEmailVerified: bool):
        self.user_id: str = user_id
        self.isEmailVerified: bool = isEmailVerified

async def validate_and_get_user_info_from_external_provider(
    email: str, password: str
) -> Union[None, ExternalUserInfo]:
    return None

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            override=emailpassword.InputOverrideConfig(apis=override_emailpassword_apis)
        )
    ],
)
```

</Tab>   

<Tab value="go">

```go

EmailPassword.init({
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                // Add overrides from the previous step
                generatePasswordResetTokenPOST: async (input) => {
                    // Retrieve the email from the input
                    let email = input.formFields.find(i => i.id === "email")!.value as string;

                    // check if user exists in SuperTokens
                    let supertokensUsersWithSameEmail = await SuperTokens.listUsersByAccountInfo(input.tenantId, {
                        email
                    }, undefined, input.userContext);
                    let emailPasswordUser = supertokensUsersWithSameEmail.find(u => {
                        return u.loginMethods.find(lM => lM.hasSameEmailAs(email) && lM.recipeId === "emailpassword") !== undefined;
                    })

                    if (emailPasswordUser === undefined) {
                        // User does not exist in SuperTokens
                        // Check if the user exists in the legacy provider and retrieve their data
                        let legacyUserData = await retrieveUserDataFromExternalProvider(email);
                        if (legacyUserData) {
                            // create a SuperTokens account for the user with a temporary password
                            let tempPassword = await generatePassword();
                            let signupResponse = await EmailPassword.signUp(input.tenantId, email, tempPassword, undefined, input.userContext);

                            if (signupResponse.status === "OK") {

                                // If user is succesfully created  we map the legacy id to their SuperTokens Id. 
                                await SuperTokens.createUserIdMapping({
                                    superTokensUserId: signupResponse.user.id,
                                    externalUserId: legacyUserData.user_id
                                })
                                signupResponse.user.id = legacyUserData.user_id
                                signupResponse.user.loginMethods[0].recipeUserId = new RecipeUserId(legacyUserData.user_id);
                                signupResponse.recipeUserId = new RecipeUserId(legacyUserData.user_id);

                                // We also need to set the email verification status of the user
                                if (legacyUserData.isEmailVerified) {
                                    // Generate an email verification token for the user
                                    let generateEmailVerificationTokenResponse = await EmailVerification.createEmailVerificationToken(input.tenantId, signupResponse.recipeUserId, email, input.userContext);

                                    if (generateEmailVerificationTokenResponse.status === "OK") {
                                        // Verify the user's email
                                        await EmailVerification.verifyEmailUsingToken("public", generateEmailVerificationTokenResponse.token, undefined, input.userContext);
                                    }
                                }

                                // We also need to identify that the user is using a temporary password. We do through the userMetadata recipe
                                UserMetadata.updateUserMetadata(legacyUserData.user_id, { isUsingTemporaryPassword: true })
                            } else {
                                throw new Error("Should never come here")
                            }
                        }
                    }
                    return await originalImplementation.generatePasswordResetTokenPOST!(input);
                },
            }
        }
    }
})

async function generatePassword(): Promise<string> {
    // TODO: generate a random password 
    return ""
}

async function retrieveUserDataFromExternalProvider(email: string): Promise<{
    user_id: string,
    isEmailVerified: boolean
} | undefined> {
    // TODO: retrieve user data if a user with the input email exists in the external provider.
    return undefined;
}
```
</Tab>

<Tab value="python">

```python
from typing import Any, Dict, List, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import (
    create_user_id_mapping,
    list_users_by_account_info,
)
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.asyncio import sign_up
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    SignUpOkResult,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.emailverification.asyncio import (
    create_email_verification_token,
    verify_email_using_token,
)
from supertokens_python.recipe.emailverification.interfaces import (
    CreateEmailVerificationTokenOkResult,
)
from supertokens_python.recipe.usermetadata.asyncio import update_user_metadata
from supertokens_python.types import RecipeUserId
from supertokens_python.types.base import AccountInfoInput

def override_emailpassword_apis(original_implementation: APIInterface):
    original_generate_password_reset_token_post = (
        original_implementation.generate_password_reset_token_post
    )

    async def generate_password_reset_token_post(
        form_fields: List[FormField],
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        # retrieve the email from the form fields
        email = None
        for field in form_fields:
            if field.id is "email":
                email = field.value
        if email is None:
            raise Exception("Should never come here")

        #  Check if an email-password user with the input email exists in SuperTokens
        supertokens_user_with_same_email = await list_users_by_account_info(
            tenant_id, AccountInfoInput(email=email), False, user_context
        )
        emailpassword_user = next(
            (
                user
                for user in supertokens_user_with_same_email
                if any(
                    lm.recipe_id == "emailpassword" and lm.has_same_email_as(email)
                    for lm in user.login_methods
                )
            ),
            None,
        )

        if emailpassword_user is None:
            # EmailPassword user with the input email does not exist in SuperTokens
            # Check if the user exists in the legacy provider and retrieve their data
            legacy_user_data = await retrieve_user_data_from_external_provider(email)
            if legacy_user_data is not None:
                # Create a SuperTokens account for the user with a temporary password
                tempPassword = await generate_password()
                response = await sign_up(
                    tenant_id, email, tempPassword, None, user_context
                )
                if not isinstance(response, SignUpOkResult):
                    raise Exception("Should never come here")

                # Map the SuperTokens userId to the legacy userId
                await create_user_id_mapping(response.user.id, legacy_user_data.user_id)
                response.user.id = legacy_user_data.user_id
                response.user.login_methods[0].recipe_user_id = RecipeUserId(
                    legacy_user_data.user_id
                )
                response.recipe_user_id = RecipeUserId(legacy_user_data.user_id)

                # We also need to set the email verification status
                if legacy_user_data.isEmailVerified:
                    # Generate an email verification token for the user
                    generate_email_verification_token_response = (
                        await create_email_verification_token(
                            tenant_id, response.recipe_user_id, email, user_context
                        )
                    )
                    if isinstance(
                        generate_email_verification_token_response,
                        CreateEmailVerificationTokenOkResult,
                    ):
                        # Verify the user's email
                        await verify_email_using_token(
                            tenant_id,
                            generate_email_verification_token_response.token,
                            True,
                            user_context,
                        )

                # We also need to identify that the user is using a temporary password. We do through the userMetadata recipe
                await update_user_metadata(
                    legacy_user_data.user_id, {"isUsingTemporaryPassword": True}
                )

        return await original_generate_password_reset_token_post(
            form_fields, tenant_id, api_options, user_context
        )

    original_implementation.generate_password_reset_token_post = (
        generate_password_reset_token_post
    )
    return original_implementation

class ExternalUserInfo:
    def __init__(self, user_id: str, isEmailVerified: bool):
        self.user_id: str = user_id
        self.isEmailVerified: bool = isEmailVerified

async def retrieve_user_data_from_external_provider(
    email: str,
) -> Union[None, ExternalUserInfo]:
    # TODO: Retrieve user data if a user with the input email exists in the external provider.
    return None

async def generate_password():
    # TODO: generate a random password
    return ""

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            override=emailpassword.InputOverrideConfig(apis=override_emailpassword_apis)
        )
    ],
)
```

</Tab>   

<Tab value="go">

```go
							var email *string = nil
							for _, field := range formFields {
								if field.ID == "email" {
									valueAsString, asStrOk := field.Value.(string)
									if !asStrOk {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("Should never come here as we check the type during validation")
									}
									email = &valueAsString
								}
							}

							if email == nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("Should never come here")
							}

							// Check if an email-password user with the input email exists in SuperTokens
							emailPasswordUser, err := emailpassword.GetUserByEmail(tenantId, *email)

							if err != nil {
								return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
							}

							if emailPasswordUser == nil {
								// User does not exist in SuperTokens
								// Check if the user exists in the legacy provider and retrieve their data
								legacyUserInfo := retrieveUserDataFromExternalProvider(*email)

								if legacyUserInfo != nil {
									// Create a SuperTokens account for the user with a temporary password
									tempPassword := generatePassword()
									response, err := emailpassword.SignUp(tenantId, *email, tempPassword)
									if err != nil {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
									}
									if response.OK == nil {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, errors.New("should never come here")
									}

									// Map the external provider's userId to the SuperTokens userId
									_, err = supertokens.CreateUserIdMapping(response.OK.User.ID, legacyUserInfo.userId, nil, nil)
									if err != nil {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
									}
									// Set the userId in the response to use the provider's userId
									response.OK.User.ID = legacyUserInfo.userId

									// We also need to set the email verification status of the user
									if legacyUserInfo.isEmailVerified {
										generateEmailVerificationTokenResponse, err := emailverification.CreateEmailVerificationToken(tenantId, response.OK.User.ID, &response.OK.User.Email)

										if err != nil {
											return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
										}

										if generateEmailVerificationTokenResponse.OK != nil {
											// Verify the user's email
											_, err := emailverification.VerifyEmailUsingToken(tenantId, generateEmailVerificationTokenResponse.OK.Token)
											if err != nil {
												return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
											}
										}
									}

									// We also need to identify that the user is using a temporary password. We do through the UserMetadata recipe
									_, err = usermetadata.UpdateUserMetadata(legacyUserInfo.userId, map[string]interface{}{
										"isUsingTemporaryPassword": true,
									})
									if err != nil {
										return epmodels.GeneratePasswordResetTokenPOSTResponse{}, err
									}
								}

							}

							return originalGeneratePasswordResetTokenPOST(formFields, tenantId, options, userContext)

						}

						return originalImplementation
					},
				},
			}),
			usermetadata.Init(nil),
		},
	})
}

type ExternalUserInfo struct {
	userId          string
	isEmailVerified bool
}

func retrieveUserDataFromExternalProvider(email string) *ExternalUserInfo {
	// TODO: Retrieve user info from external provider if account with input email exists.
	return nil
}

func generatePassword() string {
	// TODO: generate a random password
	return ""
}
```

</Tab>

</Tabs>

The code above overrides the `generatePasswordResetTokenPOST` API. This is the first step in the password reset flow and is responsible for generating the password reset token to be sent with the reset password email.
- Similar to the previous step, we need to determine whether to migrate the user or not.
- The next step is to create a SuperTokens account with a temporary password, the password can be a random string since it is reset by the user when they complete the reset password flow.
- We now map the external `userId`(the userId from the external provider) to the SuperTokens `userId`. This allows SuperTokens functions to reference the user with the external `userId`.
- Depending on the email verification status of the user in the external provider we also verify the user's email in SuperTokens.
- We assign the `isUsingTemporaryPassword` flag to user's metadata since the account was generated with a temporary password. This is done to prevent sign ins until the password is successfully reset.

## Step 4) Remove the `isUsingTemporaryPassword` flag on successful password reset

If the password reset flow is successfully completed we need to check if the user has `isUsingTemporaryPassword` set in their metadata and remove it if it exists.

<Tabs>
<Tab value="nodejs">

```tsx

EmailPassword.init({
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                // TODO: implementation details in previous step
                passwordResetPOST: async function (input) {
                    let response = await originalImplementation.passwordResetPOST!(input);
                    if (response.status === "OK") {
                        let usermetadata = await UserMetadata.getUserMetadata(response.user.id, input.userContext)
                        if (usermetadata.status === "OK" && usermetadata.metadata.isUsingTemporaryPassword) {
                            // Since the password reset we can remove the isUsingTemporaryPassword flag
                            await UserMetadata.updateUserMetadata(response.user.id, { isUsingTemporaryPassword: null })
                        }
                    }
                    return response
                }
            }
        }
    }
})
```
</Tab>

<Tab value="python">

```python
from typing import Any, Dict, List

from supertokens_python import InputAppInfo, init
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    PasswordResetPostOkResult,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.usermetadata.asyncio import (
    get_user_metadata,
    update_user_metadata,
)

def override_emailpassword_apis(original_implementation: APIInterface):
    original_password_reset_post = original_implementation.password_reset_post

    async def password_reset_post(
        form_fields: List[FormField],
        token: str,
        tenant_id: str,
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):

        response = await original_password_reset_post(
            form_fields, token, tenant_id, api_options, user_context
        )
        if (
            isinstance(response, PasswordResetPostOkResult)
        ):
            # Check that the user has the isUsingTemporaryPassword flag set in their metadata
            metadata_result = await get_user_metadata(response.user.id, user_context)
            if (
                "isUsingTemporaryPassword" in metadata_result.metadata
                and metadata_result.metadata["isUsingTemporaryPassword"] is True
            ):
                # Since the password has been successfully reset, we can remove the isUsingTemporaryPassword flag
                await update_user_metadata(
                    response.user.id, {"isUsingTemporaryPassword": None}
                )

        return response

    original_implementation.password_reset_post = password_reset_post
    return original_implementation

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            override=emailpassword.InputOverrideConfig(apis=override_emailpassword_apis)
        )
    ],
)
```

</Tab>   

<Tab value="go">

```go
- Prevent sign in from accounts that have temporary passwords.
  - If, for any reason, the user tries to sign into their account with the temporary password, then the login method should be blocked.
- If a user initiates a password reset but remembers their password, they should be able to sign in. 
  - In this case the user should be able to login and the database should be updated to reflect the new password.

<Tabs>
<Tab value="nodejs">

```tsx

EmailPassword.init({
    override: {
        apis: (originalImplementation) => {
            return {
                ...originalImplementation,
                signInPOST: async function (input) {
                    // Check if an email-password user with the input email exists in SuperTokens
                    let email = input.formFields.find((field) => field.id === "email")!.value as string;
                    let password = input.formFields.find((field) => field.id === "password")!.value as string;
                    let supertokensUsersWithSameEmail = await SuperTokens.listUsersByAccountInfo(input.tenantId, {
                        email: email
                    }, undefined, input.userContext);
                    let emailPasswordUser = supertokensUsersWithSameEmail.find(u => {
                        return u.loginMethods.find(lM => lM.hasSameEmailAs(email) && lM.recipeId === "emailpassword") !== undefined;
                    })

                    if (emailPasswordUser === undefined) {
                        // EmailPassword user with the input email does not exist in SuperTokens
                        // Check if the input credentials are valid in the external provider
                        let legacyUserInfo = await validateAndGetUserInfoFromExternalProvider(email, password)
                        if (legacyUserInfo === undefined) {
                            // credentials are incorrect
                            return {
                                status: "WRONG_CREDENTIALS_ERROR"
                            }
                        }

                        // Call the signup function to create a new SuperTokens user.
                        let signUpResponse = await EmailPassword.signUp(input.tenantId, email, password, undefined, input.userContext);
                        if (signUpResponse.status !== "OK") {
                            throw new Error("Should never come here")
                        }

                        // Map the external provider's userId to the SuperTokens userId
                        await SuperTokens.createUserIdMapping({ superTokensUserId: signUpResponse.user.id, externalUserId: legacyUserInfo.user_id })
                        // Set the userId in the response to use the provider's userId
                        signUpResponse.user.id = legacyUserInfo.user_id
                        signUpResponse.user.loginMethods[0].recipeUserId = new RecipeUserId(legacyUserInfo.user_id);

                        // We also need to set the email verification status of the user
                        if (legacyUserInfo.isEmailVerified) {
                            // Generate an email verification token for the user
                            let generateEmailVerificationTokenResponse = await EmailVerification.createEmailVerificationToken(input.tenantId, signUpResponse.recipeUserId, email, input.userContext);

                            if (generateEmailVerificationTokenResponse.status === "OK") {
                                // Verify the user's email
                                await EmailVerification.verifyEmailUsingToken("public", generateEmailVerificationTokenResponse.token, undefined, input.userContext);
                            }
                        }
                        emailPasswordUser = signUpResponse.user;
                    }
                    // highlight-start
                    // Check if the user signing in has a temporary password
                    let userMetadata = await UserMetadata.getUserMetadata(emailPasswordUser.id, input.userContext)
                    if (userMetadata.status === "OK" && userMetadata.metadata.isUsingTemporaryPassword) {
                        // Check if the input credentials are valid in the external provider
                        let legacyUserInfo = await validateAndGetUserInfoFromExternalProvider(email, password);
                        if (legacyUserInfo) {
                            let loginMethod = emailPasswordUser.loginMethods.find(lM => lM.recipeId === "emailpassword" && lM.hasSameEmailAs(email));
                            // Update the user's password with the correct password
                            EmailPassword.updateEmailOrPassword({
                                recipeUserId: loginMethod!.recipeUserId,
                                password: password,
                                applyPasswordPolicy: false
                            })

                            // Update the user's metadata to remove the isUsingTemporaryPassword flag
                            UserMetadata.updateUserMetadata(emailPasswordUser.id, { isUsingTemporaryPassword: null })
                        } else {
                            return {
                                status: "WRONG_CREDENTIALS_ERROR"
                            }
                        }
                    }
                    // highlight-end

                    return originalImplementation.signInPOST!(input)
                },
            }
        },
    }
})

async function validateAndGetUserInfoFromExternalProvider(email: string, password: string): Promise<{
    user_id: string,
    isEmailVerified: boolean
} | undefined> {
    // TODO: Validate the input credentials against the external authentication provider. If the credentials are valid return the user info.
    return undefined
}
```
</Tab>

<Tab value="python">

```python
from typing import Any, Dict, List, Union

from supertokens_python import InputAppInfo, init
from supertokens_python.asyncio import (
    create_user_id_mapping,
    list_users_by_account_info,
)
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe.emailpassword.asyncio import (
    sign_up,
    update_email_or_password,
)
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface,
    APIOptions,
    SignUpOkResult,
    WrongCredentialsError,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.emailverification.asyncio import (
    create_email_verification_token,
    verify_email_using_token,
)
from supertokens_python.recipe.emailverification.interfaces import (
    CreateEmailVerificationTokenOkResult,
)
from supertokens_python.recipe.session.interfaces import SessionContainer
from supertokens_python.recipe.usermetadata.asyncio import (
    get_user_metadata,
    update_user_metadata,
)
from supertokens_python.types import RecipeUserId
from supertokens_python.types.base import AccountInfoInput

def override_emailpassword_apis(original_implementation: APIInterface):
    original_emailpassword_sign_in = original_implementation.sign_in_post

    async def sign_in(
        form_fields: List[FormField],
        tenant_id: str,
        session: Union[SessionContainer, None],
        should_try_linking_with_session_user: Union[bool, None],
        api_options: APIOptions,
        user_context: Dict[str, Any],
    ):
        email = ""
        password = ""
        for field in form_fields:
            if field.id == "email":
                email = field.value
            if field.id == "password":
                password = field.value
        #  Check if an email-password user with the input email exists in SuperTokens
        supertokens_user_with_same_email = await list_users_by_account_info(
            tenant_id, AccountInfoInput(email=email), False, user_context
        )
        emailpassword_user = next(
            (
                user
                for user in supertokens_user_with_same_email
                if any(
                    lm.recipe_id == "emailpassword" and lm.has_same_email_as(email)
                    for lm in user.login_methods
                )
            ),
            None,
        )

        if emailpassword_user is None:
            # EmailPassword user with the input email does not exist in SuperTokens
            # Check if the input credentials valid in the external provider
            legacy_user_info = await validate_and_get_user_info_from_external_provider(
                email, password
            )
            if legacy_user_info is None:
                # Credentials are incorrect
                return WrongCredentialsError()

            # Call the sign_up function to create a new SuperTokens user.
            response = await sign_up(tenant_id, email, password, None, user_context)
            if not isinstance(response, SignUpOkResult):
                raise Exception("Should never come here")

            # Map the external provider's userId to the SuperTokens userId
            await create_user_id_mapping(response.user.id, legacy_user_info.user_id)
            # Set the userId in the response to use the provider's userId
            response.user.id = legacy_user_info.user_id
            response.user.login_methods[0].recipe_user_id = RecipeUserId(
                legacy_user_info.user_id
            )
            response.recipe_user_id = RecipeUserId(legacy_user_info.user_id)

            # We also need to set the email verification status of the user
            if legacy_user_info.isEmailVerified:
                # Generate an email verification token for the user
                generate_email_verification_response = (
                    await create_email_verification_token(
                        tenant_id,
                        response.recipe_user_id,
                        email,
                        user_context,
                    )
                )
                if isinstance(
                    generate_email_verification_response,
                    CreateEmailVerificationTokenOkResult,
                ):
                    await verify_email_using_token(
                        tenant_id,
                        generate_email_verification_response.token,
                        True,
                        user_context,
                    )

            emailpassword_user = response.user
        # highlight-start
        # Check if the user signing in has a temporary password
        metadata_result = await get_user_metadata(emailpassword_user.id)
        if (
            "isUsingTemporaryPassword" in metadata_result.metadata
            and metadata_result.metadata["isUsingTemporaryPassword"] is True
        ):
            # Check if the input credentials are valid in the external provider
            legacy_user_info = await validate_and_get_user_info_from_external_provider(
                email, password
            )
            if legacy_user_info is not None:
                # Find the emailpassword login method for the user
                login_method = next(
                    (
                        lm
                        for lm in emailpassword_user.login_methods
                        if lm.recipe_id == "emailpassword" and lm.email == email
                    ),
                    None,
                )
                assert login_method is not None
                # Update the user's password with the correct password
                await update_email_or_password(
                    login_method.recipe_user_id,
                    None,
                    password,
                    False,
                    tenant_id,
                    user_context,
                )
                # Update the user's metadata to remove the isUsingTemporaryPassword flag
                await update_user_metadata(
                    emailpassword_user.id, {"isUsingTemporaryPassword": None}
                )
            else:
                return WrongCredentialsError()
        # highlight-end

        return await original_emailpassword_sign_in(
            form_fields,
            tenant_id,
            session,
            should_try_linking_with_session_user,
            api_options,
            user_context,
        )

    original_implementation.sign_in_post = sign_in
    return original_implementation

class ExternalUserInfo:
    def __init__(self, user_id: str, isEmailVerified: bool):
        self.user_id: str = user_id
        self.isEmailVerified: bool = isEmailVerified

async def validate_and_get_user_info_from_external_provider(
    email: str, password: str
) -> Union[None, ExternalUserInfo]:
    return None

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        emailpassword.init(
            override=emailpassword.InputOverrideConfig(apis=override_emailpassword_apis)
        )
    ],
)
```

</Tab>   

<Tab value="go">

```go

# Migration - Legacy Method -  User Data Migration
Source: https://supertokens.com/docs/migration/legacy/data-migration

Once your user accounts have been migrated over to SuperTokens, additional information like metadata, roles and permissions can be associated with the user.

## User Metadata Migration

SuperTokens allows you to store arbitrary data that is JSON serializable against a userId.

In this example we want to store the following metadata against our user:

```json
{
    "someKey": "someValue" 
}
```

```bash
curl --location --request PUT '<CORE_URI>/recipe/user/metadata' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "userId": "5acb2dbc-04f0-4c80-822a-7f06cd658f6f",
  "metadataUpdate": {
    "someKey": "someValue"
  }
}'
```

## User Roles Migration

SuperTokens allows you to assign roles and permissions to a userId.

In this example we will be assigning the `admin` role to a user:

```bash
curl --location --request PUT '<CORE_URI>/recipe/user/role' \
--header 'api-key: ^{coreInfo.key}' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
  "role": "admin",
  "userId": "5acb2dbc-04f0-4c80-822a-7f06cd658f6f"

}'
```

:::info Important
Roles and permissions must be created before they can be assigned to a user. You can follow this [guide](/docs/additional-verification/user-roles/initial-setup) on creating roles and permissions in SuperTokens.
:::

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/migration/legacy/account-creation/user-creation" label="Account Creation" />
  <ReferenceCard href="/docs/migration/legacy/session-migration" label="Session Migration" />
  <ReferenceCard href="/docs/migration/legacy/mfa-migration" label="MFA Migration" />
  <ReferenceCard href="/docs/migration/legacy/account-creation/email-verification" label="Email Verification" />
  <ReferenceCard href="/docs/post-authentication/user-management/user-metadata" label="User Metadata" />
</ReferenceCard.Grid>

# Migration - Legacy Method -  Session Migration
Source: https://supertokens.com/docs/migration/legacy/session-migration

In this section we will go over how to migrate your user sessions from you previous authentication provider to SuperTokens.

This process involves two steps.
 - Adding a new `/migrate-session` API to your backend which will create a new SuperTokens session
 - Calling the `/migrate-session` API on your frontend to create a new SuperTokens session and revoke your old session.

## Flow

<img src="/img/migration/session-migration-diagram.png" alt="Session migration flow chart" />

### Backend Changes:

- Create an API on your backend, this will be called by the frontend to migrate a user's existing session to a SuperTokens session:

```tsx title="Backend changes"

let app = express();

app.post("/migrate-session", async (req, res) => {

    // extract the access token from the request object
    if(req.headers.authorization !== undefined){
        let access_token = req.headers.authorization.split("Bearer ")[1];

        // verify the access token and retrieve the old userId
        let customUserId = await verifyAccessTokenAndRetriveUserId(access_token);

        // create a new SuperTokens session using the customUserId
        // the createNewSession function will attach the SuperTokens session tokens to the response object.
        // @ts-ignore
        await Session.createNewSession(req, res, customUserId)
        res.send({
            status: "OK"
        })
    }

    // handle access_token not present in request
    
})

async function verifyAccessTokenAndRetriveUserId(access_token: string): Promise<string> {
    // verify the access_token and return the decoded userId
    return "...";
}

```

:::info Important

Verifying the access token will require you to access your previous providers JWKS endpoint, which means that you will have to continue to use your previous auth provider even after switching to SuperTokens.

If you want to immediately stop querying your previous authentication provider you can use the JWKS public keys and provide them as a secret to the JWT verification function.
You can follow our [guide](/docs/additional-verification/session-verification/protect-api-routes) on how to do this.
:::

### Frontend Changes:

- On your frontend, on page load, check if a session with your previous authentication provider exists.
- If a session exists send a request to the `/migrate-session` API with the access token to create a new SuperTokens session.
- Revoke the old session.

```tsx title="Frontend changes"

// Call this function on page load
async function migrateUserSessions() {
    let apiDomain = "...";
    // On page load retrieve the users access token if a session exists
    let accessToken = await getAccessTokenFromOldProvider()

    if (accessToken !== undefined) {

        // send a request to your migrate session endpoint with the bearer token
        await axios.post(`${apiDomain}/migrate-session`, {
            headers: {
                "Authorization": `Bearer ${accessToken}`
            }
        })
        await revokeSessionFromOldProvider()
    }
}

async function getAccessTokenFromOldProvider(): Promise<string | undefined> {
    // Check if a session with your your previous provider exists and return the access_token. Return undefined otherwise
    return "..."
}

async function revokeSessionFromOldProvider() {
    // Revoke the session associated with the previous provider
}

```

---


<ReferenceCard.Grid>
  <ReferenceCard href="/docs/migration/session-migration" label="Session migration" />
  <ReferenceCard href="/docs/migration/legacy/account-creation/user-creation" label="User creation" />
  <ReferenceCard href="/docs/migration/legacy/data-migration" label="Data migration" />
  <ReferenceCard href="/docs/post-authentication/session-management/introduction" label="Session management" />
  <ReferenceCard href="/docs/post-authentication/session-management/session-invalidation" label="Session invalidation" />
</ReferenceCard.Grid>

# Migration - Legacy Method -  MFA migration
Source: https://supertokens.com/docs/migration/legacy/mfa-migration

If you are using MFA in your app, checkout the MFA migration section [here](/docs/additional-verification/mfa/migration/legacy-to-new) after you have gone through the previous steps in migration.

# Platform Configuration - SuperTokens Core -  Add API keys
Source: https://supertokens.com/docs/platform-configuration/supertokens-core/api-keys

## Overview

The backend SDK uses API keys to authenticate requests to the SuperTokens core.

By default, there is no API key required. If you add an API key to the core's configuration or use the managed service, you need to add it to your backend SDK code. Otherwise, the core throws a `401` error.

## Before you start

:::caution no-title
This page is only relevant if you are self hosting SuperTokens. 
:::

## Steps

### 1. Add the key to the core instance

You can set the API by updating the instance parameters.

<Tabs>
<Tab value="with-docker">

```bash
 docker run \
    -p 3567:3567 \
    -e API_KEYS=<TO_DO> \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

api_keys:
```
</Tab>
</Tabs>

- The format of the value is `key1,key2,key3`.
- Keys can only contain `=`, `-` and alpha-numeric (including capital) chars.
- Each key must have a minimum length of 20 chars
- An example value is `"Akjnv3iunvsoi8=-sackjij3ncisds,asnj9=asdcda-OI982JIUN=-a"`. Notice the `,` in the string which separates the two keys `"Akjnv3iunvsoi8=-sackjij3ncisds"` and `"asnj9=asdcda-OI982JIUN=-a"`. In the backend SDK, you should only provide one of these keys.

:::info
The reason for having multiple API keys is that it allows for key rotation to occur gradually if you have multiple backend systems querying the core.
:::

### 2. Add the key to your backend code

Update the backend SDK initialization code to include the API key.

<Tabs>
<Tab value="nodejs">

```tsx

supertokens.init({
    supertokens: {
        connectionURI: "<CONNECTION_URI>",
        // highlight-next-line
        apiKey: "<API_KEY>"
   },
   appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
   recipeList: []
});
```
</Tab>
<Tab value="go">

```go

# Platform Configuration - SuperTokens Core -  Filter requests based on IP address
Source: https://supertokens.com/docs/platform-configuration/supertokens-core/ip-allow-deny

## Overview

You can set the SuperTokens core's configuration such that it accepts / denies requests that originate from certain IPs.
This ensures that only your backend can query the SuperTokens core - increasing the security.

## Before you start

:::caution no-title
This page is only relevant if you are self hosting SuperTokens. 

The option is not available if you are using the managed version of SuperTokens due to security reasons.
In this case, you have to configure the filtering mechanism in your backend server.
:::

---

## Allow requests 

<Tabs>
<Tab value="with-docker">

```bash
 docker run \
    -p 3567:3567 \
    -e IP_ALLOW_REGEX="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1" \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

ip_allow_regex: 127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1
```
</Tab>
</Tabs>

The above only allows requests that originate from an IP that matches `127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1` regular expression. A breakdown of this regex is:
- `127\.\d+\.\d+\.\d+`: IPs that start with `127.`; OR
- `::1`: IPv6 from localhost; OR
- `0:0:0:0:0:0:0:1`: IPv6 from localhost

In this way, only requests from localhost are allowed, and for other requests, the core returns a `403` status code. If instead you want to allow a list of IP addresses that correspond to your backend server's IP address, you can set this value to `IP1|IP2|IP3...` - for example: `100.12.12.3|192.167.4.3|50.32.5.1`.

If this value is not set, then the core allows requests from any IP address.

---

## Deny requests 

This is the opposite of the above configuration. If you only set this, the core allows requests from any IP other than the one that matches the regular expression corresponding to this setting.

<Tabs>
<Tab value="with-docker">

```bash
 docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e IP_DENY_REGEX="100.1.1.3" \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

ip_deny_regex: 100.1.1.3
```
</Tab>
</Tabs>

The above setting makes the core accept requests from any IP other than `100.1.1.3`. For `100.1.1.3`, it returns a `403`.

:::info What if you set both the configurations?

In this case, the core allows requests only based on the value of `ip_allow_regex`, as long that request's IP doesn't match the regex of `ip_deny_regex`. For example, if you set `ip_allow_regex: IP1|IP2` and `ip_deny_regex: IP1`, then the core accepts requests only from `IP2`.

:::

# Platform Configuration - SuperTokens Core -  Add SSL via nginx
Source: https://supertokens.com/docs/platform-configuration/supertokens-core/add-ssl-via-nginx

## Overview

This section guides you through setting up SSL via Nginx to query the SuperTokens Core with a secure connection.

## Before you start

:::caution no-title
This page is only relevant if you are self hosting SuperTokens. 
:::

This guide assumes you have already installed Nginx on your server.

## Steps

The following example guide runs SuperTokens `localhost:3567`

### 1. Reverse proxy the SuperTokens core with nginx

The SuperTokens core does not support SSL, and Nginx is needed as a reverse proxy to set up a secure connection.

Start by opening the default Nginx site configuration file in a code editor. This file resides at:
  - Linux: `/etc/nginx/sites-available/default`.
  - Mac: `/usr/local/etc/nginx/sites-available/default`.
  - Windows: `C:\nginx\conf\nginx.conf`. 

In the configuration, scroll down to the `server` directive.

- By default it should look like this:

  ```text title="/etc/nginx/sites-available/default"
  server {
    listen       80;
    server_name  localhost;
    ...
  }
  ```

- Configure the `server` directive by adding the `location` directive with the following values:

  ```text title="/etc/nginx/sites-available/default"
  server {
    listen       80;
    server_name  localhost;
    // highlight-start
    location / {
      proxy_pass http://localhost:3567;
      proxy_http_version 1.1;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection 'upgrade';
      proxy_set_header Host $host;
      proxy_cache_bypass $http_upgrade;
    }
    // highlight-end
  }
  ```

The `location` directive tells Nginx what to do with the incoming request, `proxy_pass` points the redirect to `localhost:3567`.

- Test and apply the changes to Nginx by running the following command:

  ```bash
  nginx -t && service nginx restart
  ```

We can use the `/hello` API of the SuperTokens core to test the connection.

Navigate to `http://localhost/hello` and check if it gives a valid response from the core.

### 2. Set up SSL

Obtain a digital certificate to enable a secure connection with a user's browser.

Self-signed certificates will be used since development is local. However, certificate authorities like [Let's Encrypt](https://letsencrypt.org/) can also generate valid certificates.

- Run the following command to generate a self signed certificate using OpenSSL:

  ```bash
  openssl req -x509 -nodes -newkey rsa:2048 -keyout /etc/nginx/ssl/server.key -out /etc/nginx/ssl/server.crt
  ```

- Set the values `ssl_certificate` and `ssl_certificate_key` in the Nginx configuration to specify the locations of the newly generated certificates.

  ```text title="/etc/nginx/sites-available/default"
  server {
    listen       80;
    listen       443 ssl;
    server_name  localhost;
    // highlight-start
    ssl_certificate  /etc/nginx/ssl/server.crt;
    ssl_certificate_key /etc/nginx/ssl/server.key;
    // highlight-end
    location / {
      proxy_pass http://localhost:3000;
      proxy_http_version 1.1;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection 'upgrade';
      proxy_set_header Host $host;
      proxy_cache_bypass $http_upgrade;
    }
  }
  ```

- Run the test and restart commands to test and apply your changes:

```bash
nginx -t && service nginx restart
```

# Platform Configuration - SuperTokens Core -  Adding a base path
Source: https://supertokens.com/docs/platform-configuration/supertokens-core/base-path

## Overview

If you cannot add a dedicated (sub) domain for the core and want to expose it to an external network, you may need to add a base path to all the core APIs.
To do this, you have to make changes to the core's configuration as well as to the backend SDK's `init` function call.

Consider an example where the core resides on `http://localhost:3567/some-prefix`. This implies that all APIs exposed by the core are on `http://localhost:3567/some-prefix/*`.

## Before you start

:::caution no-title
This page is only relevant if you are self hosting SuperTokens. 
:::

The feature is only available for core versions `>= 3.9`

## Steps

### 1. Change the core configuration 

<Tabs>
<Tab value="with-docker">

```bash
 docker run \
    -p 3567:3567 \
    // highlight-next-line
    -e BASE_PATH="/some-prefix" \ 
    -d registry.supertokens.io/supertokens/supertokens-<db_name>
```
</Tab>

<Tab value="without-docker">

```yaml
# You need to add the following to the config.yaml file.
# The file path can be found by running the "supertokens --help" command

base_path: "/some-prefix"
```
</Tab>
</Tabs>

### 2. Change the backend SDK initialization

<Tabs >
<Tab value="nodejs">

```tsx

supertokens.init({
    supertokens: {
        // highlight-next-line
        connectionURI: "http://localhost:3567/some-prefix",
        // ...
   },
   appInfo: {
       apiDomain: "...",
       appName: "...",
       websiteDomain: "...",
   },
   recipeList: [/* ... */ ]
});
```
</Tab>
<Tab value="go">

```go

:::

# Platform Configuration - SuperTokens Core -  SuperTokens CLI
Source: https://supertokens.com/docs/platform-configuration/supertokens-core/cli

## Overview

The SuperTokens CLI has the allows you to manage your core instance from the command line.

```bash
supertokens [command] [--help] [--version]
```

:::important
If you are using Windows, you can only use the SuperTokens CLI using a terminal with Administrator privilege. 
:::

## Commands

### Start 

Start an instance of SuperTokens. By default, the process starts as a daemon.

```bash
supertokens start [options]
```

#### Options

| Option | Description | Example |
|--------|-------------|---------|
| `--with-space` | Sets the amount of space, in MB, to allocate to the `JVM`. | `supertokens start --with-space=200` allocates 200MB for the `JVM` |
| `--with-config` | Specify the location of the configuration file to load. Can be either relative or absolute. | `supertokens start --with-config=/usr/config.yaml` |
| `--port` | Sets the port on which this instance of SuperTokens should run. | `supertokens start --port=8080` |
| `--host` | Sets the host on which this instance of SuperTokens should run. | `supertokens start --host=192.168.0.1` |
| `--foreground` | Runs this instance of SuperTokens in the foreground (not as a daemon). | `supertokens start --foreground` |
| `--help` | Help for this command. | `supertokens start --help` |

### List 

List information about all running SuperTokens instances.

```bash
supertokens list [options]
```

### Stop

```bash
supertokens stop [options]
```
If you do not provide options, the command stops all instances, or it stops one specific instance of SuperTokens.

#### Options

| Option | Description | Example |
|--------|-------------|---------|
| `--id` | Stop an instance of SuperTokens that has a specific `PID`. You can obtain an instance's `PID` via the `supertokens list` command. | `supertokens stop --id=7634` |
| `--help` | Help for this command. | `supertokens stop --help` |

### Uninstall

Uninstalls SuperTokens

```bash
supertokens uninstall [options]
```

#### Manual uninstall

##### 1. Stop or kill all SuperTokens processes
```bash
supertokens stop
```
##### 2. Delete the installation directory

You can find out the installation directory by running ```supertokens --help```.

##### 3. Delete the SuperTokens script
- Linux: ```/usr/bin/supertokens```
- Mac: ```/usr/local/bin/supertokens```
- Windows: ```C:\Windows\System32\supertokens.bat```

# Platform Configuration -  Email delivery
Source: https://supertokens.com/docs/platform-configuration/email-delivery

## Overview

SuperTokens sends emails in different authentication scenarios.
The method applies in the `EmailPassword`, `Passwordless`, and `AccountLinking` recipes.

The following page shows you how to configure the email delivery method and adjust the content that gets sent to your users.

## Delivery methods

### Default service

If you provide no configuration for email delivery, the backend SDK sends emails by talking to the servers on `https://api.supertokens.com`
This applies to both self hosted and managed services.

:::important
- No info sent to the API that sends out emails on behalf of your app is logged or stored.
- The system sends emails using `noreply@supertokens.io` email ID. If you want to use your own domain, please see one of the other methods in this section.
- You cannot customize the email template when using this method. If you want to customize the emails, please see one of the other methods in this section.
- Emails sent via the service are free and may land up in user's spam due to the high number of apps that use the service. If you want to avoid this, we recommend using one of the other methods mentioned in this section.
:::

---

### SMTP service

Using this method, you can provide your own SMTP server's configuration and the system sends the emails using those.
Use this method if you want to:
- Send emails using your own domain.
- Optionally customize the default email template and subject.

<Tabs>
<Tab value="nodejs">

```tsx

// highlight-start
let smtpSettings = {
    host: "...",
    authUsername: "...", // this is optional. In case not given, from.email will be used
    password: "...",
    port: 465,
    from: {
        name: "...",
        email: "...",
    },
    secure: true
}
// highlight-end

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            emailDelivery: {
                service: new SMTPService({smtpSettings})
            },
            // highlight-end
        }),

        // if email verification is enabled..
        EmailVerification.init({
            mode: "OPTIONAL",
            // highlight-start
            emailDelivery: {
                service: new EmailVerificationSMTPService({smtpSettings})
            }
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail: async function (input) {
                            // TODO: create and send password reset email

                            // Or use the original implementation which calls the default service,
                            // or a service that you may have specified in the emailDelivery object.
                            return originalImplementation.sendEmail(input);
                        }
                    }
                }
            },
            // highlight-end
        }),

        // if email verification is enabled
        EmailVerification.init({
            mode: "OPTIONAL",
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail: async function (input) {
                            // TODO: create and send email verification email

                            // Or use the original implementation which calls the default service,
                            // or a service that you may have specified in the emailDelivery object.
                            return originalImplementation.sendEmail(input);
                        }
                    }
                }
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

<Tabs>
<Tab value="nodejs">

```tsx

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            emailDelivery: {
                service: new SMTPService({
                    // @ts-ignore
                    smtpSettings: { /*...*/ },
                    // highlight-start
                    override: (originalImplementation) => {
                        return {
                            ...originalImplementation,
                            getContent: async function (input) {
                                // password reset content
                                let { passwordResetLink, user } = input;

                                // you can even call the original implementation and modify that
                                let originalContent = await originalImplementation.getContent(input)
                                originalContent.subject = "My custom subject";
                                return originalContent;
                            }
                        }
                    }
                    // highlight-end
                })
            }
        }),

        // if email verification is enabled
        EmailVerification.init({
            mode: "OPTIONAL",
            emailDelivery: {
                service: new EmailVerificationSMTPService({
                    // @ts-ignore
                    smtpSettings: { /*...*/ },
                    // highlight-start
                    override: (originalImplementation) => {
                        return {
                            ...originalImplementation,
                            getContent: async function (input) {
                                // email verification content
                                let { emailVerifyLink, user } = input;

                                // you can even call the original implementation and modify that
                                let originalContent = await originalImplementation.getContent(input)
                                originalContent.subject = "My custom subject";
                                return originalContent;
                            }
                        }
                    }
                    // highlight-end
                })
            }
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail: async function (input) {
                            // TODO: run some logic before sending the email
                            
                            await originalImplementation.sendEmail(input);

                            // TODO: run some logic post sending the email
                        }
                    }
                }
            },
            // highlight-end
        }),

        // if email verification is enabled
        EmailVerification.init({
            mode: "OPTIONAL",
            // highlight-start
            emailDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendEmail: async function (input) {
                            // TODO: run some logic before sending the email
                            
                            await originalImplementation.sendEmail(input);

                            // TODO: run some logic post sending the email
                        }
                    }
                }
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

# Platform Configuration -  SMS Delivery
Source: https://supertokens.com/docs/platform-configuration/sms-delivery

## Overview

SuperTokens sends SMS in different authentication scenarios.
The method applies to the `Passwordless` and `MFA` recipes.

The following page shows you how to configure the SMS delivery method and adjust the content that gets sent to your users.

## Delivery methods

### Default method

If you provide no configuration for SMS delivery, the backend SDK sends SMSs by talking to SuperTokens servers on `https://api.supertokens.com`.
This applies to both self hosted and managed services.

:::info Important
- This is a free service and is globally rate limited. This is not suitable for production use. If you do not receive an SMS using this method, then the SDK prints the SMS content on the terminal.
- We do not log / store any of the info sent to the API that sends out emails on behalf of your app.
- You cannot customize the SMS content when using this method. If you want to customize the content, please see one of the other methods in this section.
:::

### Twilio 

Using this method, you can provide your own Twilio account details to the backend SDK, and the SMS is sent using those.

<Tabs>
<Tab value="nodejs">

```tsx

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE",
            // highlight-start
            smsDelivery: {
                service: new TwilioService({
                    twilioSettings: {
                        accountSid: "...",
                        authToken: "...",
                        opts: {
                            // optionally extra config to pass to Twilio client
                        },

                        // give either from or messagingServiceSid
                        from: "...",
                        messagingServiceSid: "...",
                    },
                })
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE",
            // highlight-start
            smsDelivery: {
                service: new SupertokensService("<SMS API KEY GOES HERE>")
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE",
            // highlight-start
            smsDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendSms: async function ({
                            codeLifetime, // amount of time the code is alive for (in MS)
                            phoneNumber,
                            urlWithLinkCode, // magic link
                            userInputCode, // OTP
                        }) {
                            // TODO: create and send SMS
                        }
                    }
                }
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE",
            smsDelivery: {
                service: new TwilioService({
                    // @ts-ignore
                    twilioSettings: { /*...*/ },
                    // highlight-start
                    override: (originalImplementation) => {
                        return {
                            ...originalImplementation,
                            getContent: async function ({
                                isFirstFactor,
                                codeLifetime, // amount of time the code is alive for (in MS)
                                phoneNumber,
                                urlWithLinkCode, // magic link
                                userInputCode, // OTP
                            }) {
                                if (isFirstFactor) {
                                    // send some custom SMS content
                                    return {
                                        toPhoneNumber: phoneNumber,
                                        body: "SMS BODY"
                                    }
                                } else {
                                    // for second factor, urlWithLinkCode will always be
                                    // undefined since we only support OTP based for second factor
                                    return {
                                        toPhoneNumber: phoneNumber,
                                        body: "SMS BODY"
                                    }
                                }

                                // You can even call the original implementation and
                                // modify its content:

                                /*let originalContent = await originalImplementation.getContent(input)
                                originalContent.body = "My custom body";
                                return originalContent;*/

                            }
                        }
                    }
                    // highlight-end
                })
            }
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

supertokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Passwordless.init({
            flowType: "USER_INPUT_CODE",
            contactMethod: "PHONE",
            // highlight-start
            smsDelivery: {
                override: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        sendSms: async function (input) {
                            // TODO: before sending SMS

                            await originalImplementation.sendSms(input)

                            // TODO: after sending SMS
                        }
                    }
                }
            },
            // highlight-end
        }),
        Session.init()
    ]
});
```
</Tab>
<Tab value="go">

```go

# References -  Overview
Source: https://supertokens.com/docs/references/index

Discover the underlying concepts and the APIs exposed by **SuperTokens**.

## References

Read through detailed information on entities that you encounter while using **SuperTokens**.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/references/frontend-sdks/reference">
    <ReferenceCard.Title>
        Frontend SDK Reference
    </ReferenceCard.Title>
    <ReferenceCard.Description>
       Information on how the frontend SDKs have a structure and how to use them.
    </ReferenceCard.Description>
			</ReferenceCard>
  <ReferenceCard href="/docs/references/backend-sdks/reference">
    <ReferenceCard.Title>
        Backend SDK Reference
    </ReferenceCard.Title>
    <ReferenceCard.Description>
       Information on the structure of the backend SDKs and how to use them.
    </ReferenceCard.Description>
			</ReferenceCard>
<ReferenceCard.GridHelper />
    <ReferenceCard href="/docs/references/fdi/introduction">
    <ReferenceCard.Title>
          FDI Reference
    </ReferenceCard.Title>
    <ReferenceCard.Description>
       Details about the endpoints exposed by the **Frontend Driver Interface**.
       This is the API enabled by the backend SDKs.
    </ReferenceCard.Description>
			</ReferenceCard>

    <ReferenceCard href="/docs/references/cdi/introduction">
    <ReferenceCard.Title>
          CDI Reference
    </ReferenceCard.Title>
    <ReferenceCard.Description>
       Details about the endpoints exposed by the **Core Driver Interface**.
       This is the API enabled by the SuperTokens Core Service.
    </ReferenceCard.Description>
			</ReferenceCard>
		
</ReferenceCard.Grid>

## Advanced customisation

See how you can fine-tune your authentication flow by using specific SDK features.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/references/frontend-sdks/hooks">
    <ReferenceCard.Title>
      Frontend Hooks 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
    
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/frontend-sdks/function-overrides">
    <ReferenceCard.Title>
      Frontend Function Overrides
    </ReferenceCard.Title>
    <ReferenceCard.Description>
    </ReferenceCard.Description>
  </ReferenceCard>
<ReferenceCard.GridHelper />

  <ReferenceCard href="/docs/references/backend-sdks/function-overrides">
    <ReferenceCard.Title>
      Backend Function Overrides
    </ReferenceCard.Title>
    <ReferenceCard.Description>
    </ReferenceCard.Description>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/backend-sdks/api-overrides">
    <ReferenceCard.Title>
      Backend API Overrides
    </ReferenceCard.Title>
    <ReferenceCard.Description>
    </ReferenceCard.Description>
  </ReferenceCard>
<ReferenceCard.GridHelper />
  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/override-react-components">
    <ReferenceCard.Title>
      React Components Override
    </ReferenceCard.Title>
    <ReferenceCard.Description>
    </ReferenceCard.Description>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/changing-colours">
    <ReferenceCard.Title>
      Pre-Built UI Theming 
    </ReferenceCard.Title>
    <ReferenceCard.Description>
    </ReferenceCard.Description>
  </ReferenceCard>
</ReferenceCard.Grid>

# References -  How SuperTokens works
Source: https://supertokens.com/docs/references/how-supertokens-works

## Overview

A SuperTokens deployment consists of three components:
- **Frontend SDK**: Responsible for rendering the login UI widgets and managing authentication sessions automatically.
- **Backend SDK**: Provides authentication APIs for the frontend and communicates with the SuperTokens core
These APIs appear on the same domain as your application's APIs.
- **SuperTokens Core**: A HTTP service that contains the core business logic for authentication.
It interfaces with the database and gets queried by the backend SDK for operations that require the database.
This component can be self hosted by you, inside your own infrastructure.

<Tabs
defaultValue="ms"
values={[
{label: 'Managed service', value: 'ms'},
{label: 'Self hosted', value: 'ss'},
]}>
<Tab value="ms">
<img src="/img/architecture/managed_service_generic.png" alt="Flowchart of architecture when using SuperTokens managed service" />
</Tab>
<Tab value="ss">
<img src="/img/architecture/self_hosted_generic.png" alt="Flowchart of architecture when self-hosting SuperTokens" />
</Tab>
</Tabs>

Your app's frontend doesn't talk to the SuperTokens core directly.
Instead, it talks to the authentication APIs exposed by the backend SDK in your API layer.
The SDK then talks to the SuperTokens core.

:::caution Important
If you need to call the APIs directly keep in mind the following aspects:
- You should never call the SuperTokens core API from your frontend. 
  The frontend should only communicate using the routes exposed by the backend SDK.
:::

You can follow the next video for a more detailed explanation on how each component works.

<Box witdh="100" align="center">
<iframe width="560" height="315" src="https://www.youtube.com/embed/lUjAx75hF8I" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="true"></iframe>
</Box>

## Examples

### Sign in flow 

:::info Important
Whilst this section explains the flow for email / password login, other login methods are similar on a conceptual level - it's with a different set of APIs
:::

<Box witdh="100" align="center">
<iframe width="560" height="315" src="https://www.youtube.com/embed/dCM8s25eaQA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</Box>

<Steps>
  ## The frontend calls the backend SDK sign in API with the user credentials.
  ## The backend SDK validates the input and calls the SuperTokens core service with the credentials.
  ## The core replies with either an `OK` (along with the `userId`) or a `WRONG_CREDENTIALS_ERROR` status string.
  ## In case of error the backend SDK sends the message to the frontend. The UI then displays an appropriate message to the user.
  ## In case of success, the backend queries the core with the `userId` to create new session tokens.
  ## After the core replies with new session tokens, the backend SDK attaches them to the response as cookies or headers and sends them to the frontend.
  By default, web clients use cookies and all other clients use headers.
  ## The user logs in.
</Steps>

The next high level diagram shows the entire communication flow between the components.

<Tabs
defaultValue="ms"
values={[
{label: 'Managed service', value: 'ms'},
{label: 'Self hosted', value: 'ss'},
]}>
<Tab value="ms">
<img src="/img/architecture/managed_service.png" alt="Flowchart of sign in flow when using SuperTokens managed service" />
</Tab>
<Tab value="ss">
<img src="/img/architecture/self_hosted.png" alt="Flowchart of sign in flow when self-hosting SuperTokens" />
</Tab>
</Tabs>

### Session verification flow

<Box witdh="100" align="center">
<iframe width="560" height="315" src="https://www.youtube.com/embed/Ld3CYsXb6Fk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</Box>

After sign in, the frontend receives the access and refresh tokens.
For web-based clients, the system uses [`HttpOnly` cookies](https://owasp.org/www-community/HttpOnly) by default.
The access token is short lived, whilst the refresh token is long lived. 

#### Refresh flow

<Steps>
## When you make API calls, the access token is automatically attached to the request by the frontend SDK.
## The backend can use the `Verify Session` SDK function to check the validity of the session.
## If the session exists, you get a `session` object in your API. You can use it to remove user information and manipulate the session.
## If the call results in an error, the `Verify Session` function sends a `401` status code to the frontend.
## Upon receiving a `401`, the frontend calls the backend SDK refresh endpoint. 
## The backend SDK then calls the SuperTokens core service to generate a new access and refresh tokens.
## The backend SDK sends the new tokens to the frontend.
## The frontend then retries the original request, with the new access token.
</Steps>

## FAQs

### What about OAuth 2.0 flows?

If you are familiar with OAuth 2.0 and its flows, you may have noticed that we didn't mention any of them above.
That is because, if your application doesn't have multiple websites, all logging in via a common login portal, you don't need OAuth 2.0.
In fact, you don't even need OAuth 2.0 if you have multiple sub domains for your application - it can all work using session cookies.

However, in case you have applications that are on different domains and need to login via a common site (for example, `foo.com` and `bar.com` both login via `auth.com`), then you require OAuth.
For that you can use the `OAuth2` recipe which allows you to implement a common authentication service for [web applications](/docs/authentication/unified-login/introduction) or [microservices](/docs/authentication/m2m/introduction). 

### What is a recipe?

Each login method is a separate recipe. If you want email password login, you should see the [email password recipe docs](/docs/authentication/email-password/introduction), for passwordless, you should see the [passwordless recipe docs](/docs/authentication/passwordless/introduction).
You can use multiple recipes at once too. Most of these guides use the [Session recipe](/docs/post-authentication/session-management/introduction) along with one of the login recipes. 
SuperTokens divides its structure into recipes because when using a recipe, all the configurations and types are specific to that recipe's feature set. This, in turn, makes it easier for you to customize the auth logic.

# References - Plugins -  `@supertokens-plugins/captcha-nodejs`
Source: https://supertokens.com/docs/references/plugins/captcha-nodejs

## Classes

### CaptchaPluginError

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/errors.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/errors.ts#L3)

#### Extends

- [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)

#### Constructors

##### Constructor

```ts
new CaptchaPluginError(type: CaptchaPluginErrorType, message: string): CaptchaPluginError;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/errors.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/errors.ts#L4)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `CaptchaPluginErrorType` |
| `message` | `string` |

###### Returns

[`CaptchaPluginError`](#captchapluginerror)

###### Overrides

```ts
Error.constructor
```

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="type"></a> `type` | `public` | `CaptchaPluginErrorType` | [supertokens-plugins/packages/captcha-nodejs/src/errors.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/errors.ts#L4) |

## Interfaces

### ShouldValidate()

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L4)

#### Call Signature

```ts
ShouldValidate(api: "signInPOST", input: {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L5)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"signInPOST"` |
| `input` | \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

#### Call Signature

```ts
ShouldValidate(api: "signUpPOST", input: {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L9)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"signUpPOST"` |
| `input` | \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

#### Call Signature

```ts
ShouldValidate(api: "passwordResetPOST", input: {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L13)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"passwordResetPOST"` |
| `input` | \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

#### Call Signature

```ts
ShouldValidate(api: "generatePasswordResetTokenPOST", input: {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L17)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"generatePasswordResetTokenPOST"` |
| `input` | \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

#### Call Signature

```ts
ShouldValidate(api: "consumeCodePOST", input: 
  | {
}
  | {
} & {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L21)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"consumeCodePOST"` |
| `input` | \| \{ \} \| \{ \} & \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

#### Call Signature

```ts
ShouldValidate(api: "createCodePOST", input: 
  | {
}
  | {
} & {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L25)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"createCodePOST"` |
| `input` | \| \{ \} \| \{ \} & \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

#### Call Signature

```ts
ShouldValidate(api: "consumeCodePOST", input: 
  | {
}
  | {
} & {
}): 
  | boolean
| Promise<boolean>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:29](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L29)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `api` | `"consumeCodePOST"` |
| `input` | \| \{ \} \| \{ \} & \{ \} |

##### Returns

  \| `boolean`
  \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>

## Type Aliases

### ReCaptchaV2Response

```ts
type ReCaptchaV2Response = {
  action: string;
  challenge_ts: string;
  error-codes: string[];
  success: boolean;
};
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:54](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L54)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:56](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L56) |
| <a id="challenge_ts"></a> `challenge_ts` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:58](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L58) |
| <a id="error-codes"></a> `error-codes` | `string`[] | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:57](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L57) |
| <a id="success"></a> `success` | `boolean` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:55](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L55) |

***

### ReCaptchaV3Response

```ts
type ReCaptchaV3Response = {
  action: string;
  challenge_ts: string;
  error-codes: string[];
  hostname: string;
  score: number;
  success: boolean;
};
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:45](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L45)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-1"></a> `action` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:49](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L49) |
| <a id="challenge_ts-1"></a> `challenge_ts` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:51](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L51) |
| <a id="error-codes-1"></a> `error-codes` | `string`[] | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:47](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L47) |
| <a id="hostname"></a> `hostname` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:48](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L48) |
| <a id="score"></a> `score` | `number` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:50](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L50) |
| <a id="success-1"></a> `success` | `boolean` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:46](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L46) |

***

### SuperTokensPluginCaptchaConfig

```ts
type SuperTokensPluginCaptchaConfig = {
  captcha: {
     secretKey: string;
  };
  shouldValidate?: ShouldValidate;
  type: "reCAPTCHAv3" | "reCAPTCHAv2" | "turnstile";
};
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L35)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="captcha"></a> `captcha` | \{ `secretKey`: `string`; \} | - | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L37) |
| `captcha.secretKey` | `string` | - | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L38) |
| <a id="shouldvalidate-8"></a> `shouldValidate?` | [`ShouldValidate`](#shouldvalidate) | By default the captcha validation is performed on all the form submit actions Use this property to specify when to perform the validation | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:42](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L42) |
| <a id="type-1"></a> `type` | `"reCAPTCHAv3"` \| `"reCAPTCHAv2"` \| `"turnstile"` | - | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:36](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L36) |

***

### TurnstileResponse

```ts
type TurnstileResponse = {
  challenge_ts: string;
  error-codes: string[];
  hostname: string;
  success: boolean;
};
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/types.ts:61](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L61)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="challenge_ts-2"></a> `challenge_ts` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:65](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L65) |
| <a id="error-codes-2"></a> `error-codes` | `string`[] | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:63](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L63) |
| <a id="hostname-1"></a> `hostname` | `string` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:64](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L64) |
| <a id="success-2"></a> `success` | `boolean` | [supertokens-plugins/packages/captcha-nodejs/src/types.ts:62](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/types.ts#L62) |

## Variables

### default

```ts
default: {
  init: (config: SuperTokensPluginCaptchaConfig) => SuperTokensPlugin;
};
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/index.ts#L5)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init()` | (`config`: [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig)) => `SuperTokensPlugin` | [supertokens-plugins/packages/captcha-nodejs/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/index.ts#L5) |

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-captcha" = "supertokens-plugin-captcha";
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/config.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/config.ts#L3)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: ">=23.0.0" = ">=23.0.0";
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/config.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/config.ts#L4)

***

### SupportedCaptchaTypes

```ts
const SupportedCaptchaTypes: string[];
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/captcha.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/captcha.ts#L4)

## Functions

### init()

```ts
function init(config: SuperTokensPluginCaptchaConfig): SuperTokensPlugin;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/plugin.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/plugin.ts#L6)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig) |

#### Returns

`SuperTokensPlugin`

***

### validateCaptcha()

```ts
function validateCaptcha(body: Record<string, unknown>, config: SuperTokensPluginCaptchaConfig): Promise<void>;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/captcha.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/captcha.ts#L15)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `body` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\> |
| `config` | [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig) |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### validatePluginConfig()

```ts
function validatePluginConfig(config: SuperTokensPluginCaptchaConfig): void;
```

Defined in: [supertokens-plugins/packages/captcha-nodejs/src/config.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-nodejs/src/config.ts#L6)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig) |

#### Returns

`void`

# References - Plugins -  `@supertokens-plugins/captcha-react`
Source: https://supertokens.com/docs/references/plugins/captcha-react

## Classes

### Captcha

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L32)

#### Constructors

##### Constructor

```ts
new Captcha(): Captcha;
```

###### Returns

[`Captcha`](#captcha)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="state"></a> `state` | `public` | `"uninitialised"` \| `"initialised"` \| `"loaded"` \| `"rendered"` | `"uninitialised"` | [supertokens-plugins/packages/captcha-react/src/captcha.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L34) |

#### Methods

##### addEventListener()

```ts
addEventListener<T>(event: T, listener: CaptchaEventListener<T>): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:188](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L188)

###### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"token-submitted"` \| `"render-failed"` \| `"get-token-failed"` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | `T` |
| `listener` | `CaptchaEventListener`\<`T`\> |

###### Returns

`void`

##### getInputContainer()

```ts
getInputContainer(): Promise<HTMLDivElement>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:66](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L66)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>

##### getToken()

```ts
getToken(): Promise<string>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:151](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L151)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>

##### init()

```ts
init(config: SuperTokensPluginCaptchaConfig): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:44](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L44)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig) |

###### Returns

`void`

##### load()

```ts
load(): Promise<void>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:85](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L85)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

##### removeEventListener()

```ts
removeEventListener<T>(event: T, listener: CaptchaEventListener<T>): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:192](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L192)

###### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `"token-submitted"` \| `"render-failed"` \| `"get-token-failed"` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | `T` |
| `listener` | `CaptchaEventListener`\<`T`\> |

###### Returns

`void`

##### render()

```ts
render(onSubmit?: (token: string) => void, onError?: (error: Error) => void): Promise<void>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:120](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L120)

Renders the captcha provider.
The function accepts two callbacks that enable the following behaviors:
- Pass callbacks that update some UI state and move ahead with the rendering process.
  Used when you render the captcha from the start.
- Wrap the call in a promise and pass resolve/reject as callbacks.
  This way you can block your function and wait for the token value.
  This is used when the captcha is rendered after the user has submitted the authentication form.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `onSubmit?` | (`token`: `string`) => `void` | Called when the captcha token has been generated by the provider. |
| `onError?` | (`error`: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)) => `void` | Called when an error occurs during the captcha rendering process. |

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### ReCAPTCHAv2Provider

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:213](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L213)

#### Implements

- [`CaptchaProvider`](#captchaprovider)

#### Constructors

##### Constructor

```ts
new ReCAPTCHAv2Provider(config: Parameters): ReCAPTCHAv2Provider;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:216](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L216)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `Parameters` |

###### Returns

[`ReCAPTCHAv2Provider`](#recaptchav2provider)

#### Methods

##### getToken()

```ts
getToken(): Promise<string>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:275](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L275)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`getToken`](#gettoken-8)

##### load()

```ts
load(): Promise<void>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:222](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L222)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`load`](#load-8)

##### render()

```ts
render(
   containerElement: HTMLDivElement, 
   onSubmit: (token: string) => void, 
   onError: (error: Error) => void): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:239](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L239)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `containerElement` | [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement) |
| `onSubmit` | (`token`: `string`) => `void` |
| `onError` | (`error`: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)) => `void` |

###### Returns

`void`

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`render`](#render-6)

##### setToken()

```ts
setToken(token: string): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:218](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L218)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |

###### Returns

`void`

***

### ReCAPTCHAv3Provider

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:283](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L283)

#### Implements

- [`CaptchaProvider`](#captchaprovider)

#### Constructors

##### Constructor

```ts
new ReCAPTCHAv3Provider(config: ReCAPTCHAv3Config): ReCAPTCHAv3Provider;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:284](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L284)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`ReCAPTCHAv3Config`](#recaptchav3config) |

###### Returns

[`ReCAPTCHAv3Provider`](#recaptchav3provider)

#### Methods

##### getToken()

```ts
getToken(): Promise<string>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:294](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L294)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`getToken`](#gettoken-8)

##### load()

```ts
load(): Promise<void>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:286](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L286)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`load`](#load-8)

***

### TurnstileProvider

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:312](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L312)

#### Implements

- [`CaptchaProvider`](#captchaprovider)

#### Constructors

##### Constructor

```ts
new TurnstileProvider(config: RenderParameters): TurnstileProvider;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:315](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L315)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `RenderParameters` |

###### Returns

[`TurnstileProvider`](#turnstileprovider)

#### Methods

##### getToken()

```ts
getToken(): Promise<string>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:395](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L395)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`getToken`](#gettoken-8)

##### load()

```ts
load(): Promise<void>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:321](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L321)

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`load`](#load-8)

##### render()

```ts
render(
   container: HTMLDivElement, 
   onSubmit: (token: string) => void, 
   onError: (error: Error) => void): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:338](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L338)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `container` | [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement) |
| `onSubmit` | (`token`: `string`) => `void` |
| `onError` | (`error`: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)) => `void` |

###### Returns

`void`

###### Implementation of

[`CaptchaProvider`](#captchaprovider).[`render`](#render-6)

##### setToken()

```ts
setToken(token: string): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:317](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L317)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |

###### Returns

`void`

## Interfaces

### CaptchaProvider

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L17)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="gettoken-8"></a> `getToken` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | [supertokens-plugins/packages/captcha-react/src/types.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L20) |
| <a id="load-8"></a> `load` | (`onLoad?`: () => `void`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/captcha-react/src/types.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L18) |
| <a id="render-6"></a> `render?` | (`container`: [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement), `onSubmit`: (`token`: `string`) => `void`, `onError`: (`error`: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)) => `void`) => `void` | [supertokens-plugins/packages/captcha-react/src/types.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L19) |

## Type Aliases

### CaptchInputContainerProps

```ts
type CaptchInputContainerProps = {
  form:   | "EmailPasswordSignInForm"
     | "EmailPasswordSignUpForm"
     | "EmailPasswordResetPasswordEmail"
     | "EmailPasswordSubmitNewPassword"
     | "PasswordlessEmailForm"
     | "PasswordlessPhoneForm"
     | "PasswordlessEmailOrPhoneForm"
     | "PasswordlessEPComboEmailForm"
     | "PasswordlessEPComboEmailOrPhoneForm"
     | "PasswordlessUserInputForm";
} & React.HTMLAttributes<HTMLDivElement>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:82](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L82)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `form` | \| `"EmailPasswordSignInForm"` \| `"EmailPasswordSignUpForm"` \| `"EmailPasswordResetPasswordEmail"` \| `"EmailPasswordSubmitNewPassword"` \| `"PasswordlessEmailForm"` \| `"PasswordlessPhoneForm"` \| `"PasswordlessEmailOrPhoneForm"` \| `"PasswordlessEPComboEmailForm"` \| `"PasswordlessEPComboEmailOrPhoneForm"` \| `"PasswordlessUserInputForm"` | [supertokens-plugins/packages/captcha-react/src/types.ts:83](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L83) |

***

### EmailPasswordCaptchaPreAndPostAPIHookActions

```ts
type EmailPasswordCaptchaPreAndPostAPIHookActions = Extract<BaseFormSection, 
  | "EMAIL_PASSWORD_SIGN_UP"
  | "EMAIL_PASSWORD_SIGN_IN"
  | "SUBMIT_NEW_PASSWORD"
| "SEND_RESET_PASSWORD_EMAIL">;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:50](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L50)

***

### PasswordlessCaptchaPreAndPostAPIHookActions

```ts
type PasswordlessCaptchaPreAndPostAPIHookActions = Extract<BaseFormSection, "PASSWORDLESS_CONSUME_CODE" | "PASSWORDLESS_CREATE_CODE">;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:66](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L66)

***

### ReCAPTCHAv2Config

```ts
type ReCAPTCHAv2Config = ReCaptchaV2.Parameters;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L23)

***

### ReCAPTCHAv3Config

```ts
type ReCAPTCHAv3Config = {
  action?: string;
  sitekey: string;
};
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L24)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="action"></a> `action?` | `string` | The name of the action. Actions may only contain alphanumeric characters and slashes, and must not be user-specific. | [supertokens-plugins/packages/captcha-react/src/types.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L32) |
| <a id="sitekey"></a> `sitekey` | `string` | Your sitekey. | [supertokens-plugins/packages/captcha-react/src/types.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L28) |

***

### SuperTokensPluginCaptchaConfig

```ts
type SuperTokensPluginCaptchaConfig = CaptchaConfig & {
  InputContainer?: React.ForwardRefExoticComponent<CaptchInputContainerProps & React.RefAttributes<HTMLDivElement>>;
  inputContainerId?:   | string
     | () => Promise<string>;
};
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:77](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L77)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `InputContainer?` | `React.ForwardRefExoticComponent`\<[`CaptchInputContainerProps`](#captchinputcontainerprops) & `React.RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>\> | [supertokens-plugins/packages/captcha-react/src/types.ts:78](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L78) |
| `inputContainerId?` | \| `string` \| () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | [supertokens-plugins/packages/captcha-react/src/types.ts:79](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L79) |

***

### TurnstileConfig

```ts
type TurnstileConfig = Turnstile.RenderParameters;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L34)

## Variables

### captcha

```ts
const captcha: Captcha;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/captcha.ts:440](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/captcha.ts#L440)

***

### CAPTCHA\_INPUT\_CONTAINER\_ID

```ts
const CAPTCHA_INPUT_CONTAINER_ID: "supertokens-captcha-container" = "supertokens-captcha-container";
```

Defined in: [supertokens-plugins/packages/captcha-react/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/constants.ts#L2)

***

### CAPTCHA\_MODAL\_INPUT\_CONTAINER\_ID

```ts
const CAPTCHA_MODAL_INPUT_CONTAINER_ID: "supertokens-captcha-modal-container" = "supertokens-captcha-modal-container";
```

Defined in: [supertokens-plugins/packages/captcha-react/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/constants.ts#L3)

***

### CaptchaInputContainer

```ts
const CaptchaInputContainer: ForwardRefExoticComponent<{
  form:   | "EmailPasswordSignInForm"
     | "EmailPasswordSignUpForm"
     | "EmailPasswordResetPasswordEmail"
     | "EmailPasswordSubmitNewPassword"
     | "PasswordlessEmailForm"
     | "PasswordlessPhoneForm"
     | "PasswordlessEmailOrPhoneForm"
     | "PasswordlessEPComboEmailForm"
     | "PasswordlessEPComboEmailOrPhoneForm"
     | "PasswordlessUserInputForm";
} & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/CaptchaInputContainer.tsx:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/CaptchaInputContainer.tsx#L10)

***

### default

```ts
default: {
  init: (config: SuperTokensPluginCaptchaConfig) => SuperTokensPlugin;
};
```

Defined in: [supertokens-plugins/packages/captcha-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/index.ts#L6)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init-2"></a> `init()` | (`config`: [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig)) => `SuperTokensPlugin` | [supertokens-plugins/packages/captcha-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/index.ts#L6) |

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-captcha" = "supertokens-plugin-captcha";
```

Defined in: [supertokens-plugins/packages/captcha-react/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/constants.ts#L1)

## Functions

### EmailPasswordResetPasswordEmail()

```ts
function EmailPasswordResetPasswordEmail(): EmailPasswordComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L31)

#### Returns

`EmailPasswordComponentOverrideMap`

***

### EmailPasswordSignInForm()

```ts
function EmailPasswordSignInForm(): EmailPasswordComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L6)

#### Returns

`EmailPasswordComponentOverrideMap`

***

### EmailPasswordSignUpForm()

```ts
function EmailPasswordSignUpForm(): EmailPasswordComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L18)

#### Returns

`EmailPasswordComponentOverrideMap`

***

### EmailPasswordSubmitNewPassword()

```ts
function EmailPasswordSubmitNewPassword(): EmailPasswordComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:48](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L48)

#### Returns

`EmailPasswordComponentOverrideMap`

***

### getPluginConfig()

```ts
function getPluginConfig(): SuperTokensPluginCaptchaConfig;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/config.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/config.ts#L34)

#### Returns

[`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig)

***

### init()

```ts
function init(config: SuperTokensPluginCaptchaConfig): SuperTokensPlugin;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/plugin.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/plugin.ts#L16)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig) |

#### Returns

`SuperTokensPlugin`

***

### isEmailPasswordCaptchaPreAndPostAPIHookAction()

```ts
function isEmailPasswordCaptchaPreAndPostAPIHookAction(action: string): action is any;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:55](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L55)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | `string` |

#### Returns

`action is any`

***

### isPasswordlessCaptchaPreAndPostAPIHookAction()

```ts
function isPasswordlessCaptchaPreAndPostAPIHookAction(action: string): action is any;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/types.ts:71](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/types.ts#L71)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `action` | `string` |

#### Returns

`action is any`

***

### PasswordlessEmailForm()

```ts
function PasswordlessEmailForm(): PasswordlessComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:64](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L64)

#### Returns

`PasswordlessComponentOverrideMap`

***

### PasswordlessEmailOrPhoneForm()

```ts
function PasswordlessEmailOrPhoneForm(): PasswordlessComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:89](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L89)

#### Returns

`PasswordlessComponentOverrideMap`

***

### PasswordlessEPComboEmailForm()

```ts
function PasswordlessEPComboEmailForm(): PasswordlessComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:106](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L106)

#### Returns

`PasswordlessComponentOverrideMap`

***

### PasswordlessEPComboEmailOrPhoneForm()

```ts
function PasswordlessEPComboEmailOrPhoneForm(): PasswordlessComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:123](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L123)

#### Returns

`PasswordlessComponentOverrideMap`

***

### PasswordlessPhoneForm()

```ts
function PasswordlessPhoneForm(): PasswordlessComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:76](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L76)

#### Returns

`PasswordlessComponentOverrideMap`

***

### PasswordlessUserInputCodeForm()

```ts
function PasswordlessUserInputCodeForm(): PasswordlessComponentOverrideMap;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/components/ComponentOverrides.tsx:140](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/components/ComponentOverrides.tsx#L140)

#### Returns

`PasswordlessComponentOverrideMap`

***

### setPluginConfig()

```ts
function setPluginConfig(config: SuperTokensPluginCaptchaConfig): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/config.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/config.ts#L8)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig) |

#### Returns

`void`

***

### useCaptcha()

```ts
function useCaptcha(onError?: (error: string) => void): {
  containerId:   | string
     | () => Promise<string>;
  load: (configOverride: Partial<SuperTokensPluginCaptchaConfig>) => Promise<boolean>;
  render: () => Promise<void>;
  state: CaptchaState;
};
```

Defined in: [supertokens-plugins/packages/captcha-react/src/hooks/useCaptcha.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/hooks/useCaptcha.ts#L8)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `onError?` | (`error`: `string`) => `void` |

#### Returns

```ts
{
  containerId:   | string
     | () => Promise<string>;
  load: (configOverride: Partial<SuperTokensPluginCaptchaConfig>) => Promise<boolean>;
  render: () => Promise<void>;
  state: CaptchaState;
}
```

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| `containerId` | \| `string` \| () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | `captchaInputContainerId` | [supertokens-plugins/packages/captcha-react/src/hooks/useCaptcha.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/hooks/useCaptcha.ts#L31) |
| `load()` | (`configOverride`: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`SuperTokensPluginCaptchaConfig`](#supertokensplugincaptchaconfig)\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | `captchaStore.load` | [supertokens-plugins/packages/captcha-react/src/hooks/useCaptcha.ts:29](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/hooks/useCaptcha.ts#L29) |
| `render()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `captchaStore.render` | [supertokens-plugins/packages/captcha-react/src/hooks/useCaptcha.ts:30](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/hooks/useCaptcha.ts#L30) |
| `state` | `CaptchaState` | `captchaState` | [supertokens-plugins/packages/captcha-react/src/hooks/useCaptcha.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/hooks/useCaptcha.ts#L28) |

***

### useCaptchaInputContainer()

```ts
function useCaptchaInputContainer(): ForwardRefExoticComponent<{
  form:   | "EmailPasswordSignInForm"
     | "EmailPasswordSignUpForm"
     | "EmailPasswordResetPasswordEmail"
     | "EmailPasswordSubmitNewPassword"
     | "PasswordlessEmailForm"
     | "PasswordlessPhoneForm"
     | "PasswordlessEmailOrPhoneForm"
     | "PasswordlessEPComboEmailForm"
     | "PasswordlessEPComboEmailOrPhoneForm"
     | "PasswordlessUserInputForm";
} & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>>;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/hooks/useCaptchaInputContainer.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/hooks/useCaptchaInputContainer.ts#L6)

#### Returns

`ForwardRefExoticComponent`\<\{
  `form`:   \| `"EmailPasswordSignInForm"`
     \| `"EmailPasswordSignUpForm"`
     \| `"EmailPasswordResetPasswordEmail"`
     \| `"EmailPasswordSubmitNewPassword"`
     \| `"PasswordlessEmailForm"`
     \| `"PasswordlessPhoneForm"`
     \| `"PasswordlessEmailOrPhoneForm"`
     \| `"PasswordlessEPComboEmailForm"`
     \| `"PasswordlessEPComboEmailOrPhoneForm"`
     \| `"PasswordlessUserInputForm"`;
\} & `HTMLAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>\>

***

### validatePublicConfig()

```ts
function validatePublicConfig(config: SuperTokensPublicConfig): void;
```

Defined in: [supertokens-plugins/packages/captcha-react/src/config.ts:41](https://github.com/supertokens/supertokens-plugins/blob/main/packages/captcha-react/src/config.ts#L41)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `SuperTokensPublicConfig` |

#### Returns

`void`

# References - Plugins -  Plugins
Source: https://supertokens.com/docs/references/plugins/introduction

## Overview

Plugins are an extension system that allows you to include additional functionality to your **SuperTokens** authentication flows without modifying the core recipes.
They work on top of the existing authentication methods and provide seamless integration for common requirements.

## Before you begin

Plugins are supported only by the `React` and `Node.js` SDKs. 
Support for other platforms is under active development.

## References 

The official plugins repository is available [on GitHub](https://github.com/supertokens/supertokens-plugins).
You can check the documentation reference pages for a high level overview of the components of each plugin.

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/references/plugins/captcha-react">
    <ReferenceCard.Title>
      captcha-react
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/captcha-nodejs">
    <ReferenceCard.Title>
      captcha-nodejs
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/user-banning-react">
    <ReferenceCard.Title>
      user-banning-react
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/user-banning-nodejs">
    <ReferenceCard.Title>
      user-banning-nodejs
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/tenant-discovery-react">
    <ReferenceCard.Title>
      tenant-discovery-react
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/tenant-discovery-nodejs">
    <ReferenceCard.Title>
      tenant-discovery-nodejs
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/opentelemetry-nodejs">
    <ReferenceCard.Title>
      opentelemetry-nodejs
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/profile-base-react">
    <ReferenceCard.Title>
      profile-base-react
    </ReferenceCard.Title>
  </ReferenceCard>	
  <ReferenceCard href="/docs/references/plugins/profile-details-nodejs">
    <ReferenceCard.Title>
      profile-details-nodejs
    </ReferenceCard.Title>
  </ReferenceCard>	
  <ReferenceCard href="/docs/references/plugins/profile-details-react">
    <ReferenceCard.Title>
      profile-details-react
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/plugins/progressive-profiling-nodejs">
    <ReferenceCard.Title>
      progressive-profiling-nodejs
    </ReferenceCard.Title>
  </ReferenceCard>	
  <ReferenceCard href="/docs/references/plugins/progressive-profiling-react">
    <ReferenceCard.Title>
      progressive-profiling-react
    </ReferenceCard.Title>
  </ReferenceCard>
</ReferenceCard.Grid>

## How it works

Each plugin relies on the override mechanism exposed by the SDKs.
Custom features get injected by overriding existing functions and components.

If you want to read more on the customization points, check out the following sections:

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/references/frontend-sdks/function-overrides">
    <ReferenceCard.Title>
      Frontend Function Overrides
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/override-react-components">
    <ReferenceCard.Title>
      React Component Overrides
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard.GridHelper />
  <ReferenceCard href="/docs/references/backend-sdks/function-overrides">
    <ReferenceCard.Title>
      Backend Function Overrides
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="/docs/references/backend-sdks/api-overrides">
    <ReferenceCard.Title>
      Backend API Overrides
    </ReferenceCard.Title>
  </ReferenceCard>
</ReferenceCard.Grid>

# References - Plugins -  `@supertokens-plugins/opentelemetry-nodejs`
Source: https://supertokens.com/docs/references/plugins/opentelemetry-nodejs

## Classes

### PluginImpl

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L7)

#### Constructors

##### Constructor

```ts
new PluginImpl(config: {
}): PluginImpl;
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L8)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | \{ \} |

###### Returns

[`PluginImpl`](#pluginimpl)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getsensitivefields"></a> `getSensitiveFields` | (`this`: [`PluginImpl`](#pluginimpl), `defaultSensitiveFields`: `string`[]) => `string`[] | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:58](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L58) |
| <a id="gettracer"></a> `getTracer` | (`this`: [`PluginImpl`](#pluginimpl)) => `Tracer` | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L34) |
| <a id="gettracingheadersforcorecall"></a> `getTracingHeadersForCoreCall` | (`this`: [`PluginImpl`](#pluginimpl), `req`: `HttpRequest`, `userContext`: `UserContext`) => [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:62](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L62) |
| <a id="startactivespan"></a> `startActiveSpan` | \<`T`\>(`this`: [`PluginImpl`](#pluginimpl), `tracer`: `Tracer`, `spanName`: `string`, `attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>, `fn`: (`span`: `Span`) => `T`) => `T` | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L24) |
| <a id="startspan"></a> `startSpan` | (`this`: [`PluginImpl`](#pluginimpl), `tracer`: `Tracer`, `spanName`: `string`, `attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => \{ `addEvent`: (`eventName`: `string`, `attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\>) => `void`; `end`: () => `void`; `setAttributes`: (`attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\>) => `void`; `setStatus`: (`status`: `SpanStatus`) => `void`; \} | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L10) |
| <a id="transformerrortoattributes"></a> `transformErrorToAttributes` | (`this`: [`PluginImpl`](#pluginimpl), `error`: `unknown`) => [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\> | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:50](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L50) |
| <a id="transforminputtoattributes"></a> `transformInputToAttributes` | (`this`: [`PluginImpl`](#pluginimpl), `input`: `unknown`) => [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\> | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L38) |
| <a id="transformresulttoattributes"></a> `transformResultToAttributes` | (`this`: [`PluginImpl`](#pluginimpl), `input`: `unknown`) => [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\> | [supertokens-plugins/packages/opentelemetry-nodejs/src/pluginImpl.ts:44](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/pluginImpl.ts#L44) |

## Type Aliases

### OpenTelemetryLoggerPluginConfig

```ts
type OpenTelemetryLoggerPluginConfig = 
  | {
}
  | undefined;
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L3)

***

### OTSpan

```ts
type OTSpan = {
  addEvent: (eventName: string, attributes: Record<string, any>) => void;
  end: () => void;
  setAttributes: (attributes: Record<string, any>) => void;
  setStatus: (status: BaseFormSection) => void;
};
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L5)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="addevent"></a> `addEvent` | (`eventName`: `string`, `attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `void` | [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L7) |
| <a id="end"></a> `end` | () => `void` | [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L6) |
| <a id="setattributes"></a> `setAttributes` | (`attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `void` | [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L8) |
| <a id="setstatus"></a> `setStatus` | (`status`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)) => `void` | [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L9) |

***

### OTTracer

```ts
type OTTracer = {
  startActiveSpan: (spanName: string, attributes: Record<string, any>, fn: (span: OTSpan) => void) => void;
  startSpan: (spanName: string, attributes: Record<string, any>) => OTSpan;
};
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L12)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="startactivespan-1"></a> `startActiveSpan` | (`spanName`: `string`, `attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>, `fn`: (`span`: [`OTSpan`](#otspan)) => `void`) => `void` | [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L14) |
| <a id="startspan-1"></a> `startSpan` | (`spanName`: `string`, `attributes`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`OTSpan`](#otspan) | [supertokens-plugins/packages/opentelemetry-nodejs/src/types.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/types.ts#L13) |

## Variables

### default

```ts
default: {
  init: any;
};
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/index.ts#L5)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/opentelemetry-nodejs/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/index.ts#L5) |

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/plugin.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/plugin.ts#L8)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-opentelemetry" = "supertokens-plugin-opentelemetry";
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/config.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/config.ts#L3)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: ">=23.0.0" = ">=23.0.0";
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/config.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/config.ts#L4)

## Functions

### validatePluginConfig()

```ts
function validatePluginConfig(config: {
}): void;
```

Defined in: [supertokens-plugins/packages/opentelemetry-nodejs/src/config.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/opentelemetry-nodejs/src/config.ts#L7)

eslint-disable-next-line @typescript-eslint/no-unused-vars

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | \{ \} |

#### Returns

`void`

# References - Plugins -  `@supertokens-plugins/profile-base-react`
Source: https://supertokens.com/docs/references/plugins/profile-base-react

## Type Aliases

### RegisterSection()

```ts
type RegisterSection = (sectionBuilder: () => Promise<Section | Section[]>) => void;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/types.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L24)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sectionBuilder` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Section`](#section) \| [`Section`](#section)[]\> |

#### Returns

`void`

***

### Section

```ts
type Section = Omit<SuperTokensPluginProfileSection, "order"> & {
  order?: number;
};
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L21)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `order?` | `number` | [supertokens-plugins/packages/profile-base-react/src/types.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L22) |

***

### SuperTokensPluginProfileConfig

```ts
type SuperTokensPluginProfileConfig = {
  profilePagePath?: string;
  sections?: SuperTokensPluginProfileSection[];
};
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L5)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="profilepagepath"></a> `profilePagePath?` | `string` | [supertokens-plugins/packages/profile-base-react/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L6) |
| <a id="sections"></a> `sections?` | [`SuperTokensPluginProfileSection`](#supertokenspluginprofilesection)[] | [supertokens-plugins/packages/profile-base-react/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L7) |

***

### SuperTokensPluginProfileNormalisedConfig

```ts
type SuperTokensPluginProfileNormalisedConfig = Required<SuperTokensPluginProfileConfig>;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L10)

***

### SuperTokensPluginProfileSection

```ts
type SuperTokensPluginProfileSection = {
  component: () => React.JSX.Element;
  icon?: () => React.JSX.Element;
  id: string;
  order: number;
  title: string;
};
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/types.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L12)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="component"></a> `component` | () => `React.JSX.Element` | - | [supertokens-plugins/packages/profile-base-react/src/types.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L18) |
| <a id="icon"></a> `icon?` | () => `React.JSX.Element` | - | [supertokens-plugins/packages/profile-base-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L17) |
| <a id="id"></a> `id` | `string` | - | [supertokens-plugins/packages/profile-base-react/src/types.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L13) |
| <a id="order"></a> `order` | `number` | this is needed to allow controlling the order of the sections, because in some cases the registration order is not the same as the order of the sections because of async initializations | [supertokens-plugins/packages/profile-base-react/src/types.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L16) |
| <a id="title"></a> `title` | `string` | - | [supertokens-plugins/packages/profile-base-react/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L14) |

***

### TranslationKeys

```ts
type TranslationKeys = keyof typeof defaultTranslations["en"];
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/types.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/types.ts#L26)

## Variables

### default

```ts
default: {
  init: any;
  PLUGIN_ID: string;
  usePluginContext: any;
  UserProfileWrapper: () => Element;
};
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/index.ts#L6)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/profile-base-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/index.ts#L6) |
| <a id="plugin_id"></a> `PLUGIN_ID` | `string` | [supertokens-plugins/packages/profile-base-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/index.ts#L6) |
| <a id="useplugincontext"></a> `usePluginContext` | `any` | [supertokens-plugins/packages/profile-base-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/index.ts#L6) |
| <a id="userprofilewrapper"></a> `UserProfileWrapper()` | () => `Element` | [supertokens-plugins/packages/profile-base-react/src/index.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/index.ts#L6) |

***

### default

```ts
const default: Meta<(__namedParameters: {
  sections: {
     component: () => Element;
     id: string;
     title: string | Element;
  }[];
}) => Element>;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections-in-card.stories.tsx:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections-in-card.stories.tsx#L9)

More on how to set up stories at: https://storybook.js.org/docs/writing-stories#default-export

***

### default

```ts
const default: Meta<(__namedParameters: {
  sections: {
     component: () => Element;
     id: string;
     title: string | Element;
  }[];
}) => Element>;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections.stories.tsx:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections.stories.tsx#L7)

More on how to set up stories at: https://storybook.js.org/docs/writing-stories#default-export

***

### DEFAULT\_PROFILE\_PAGE\_PATH

```ts
const DEFAULT_PROFILE_PAGE_PATH: "/user/profile" = "/user/profile";
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/constants.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/constants.ts#L6)

***

### defaultTranslations

```ts
const defaultTranslations: {
  en: {
     PL_PB_USER_PROFILE: "User Profile";
  };
};
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/translations.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/translations.ts#L1)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="en"></a> `en` | \{ `PL_PB_USER_PROFILE`: `"User Profile"`; \} | - | [supertokens-plugins/packages/profile-base-react/src/translations.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/translations.ts#L2) |
| `en.PL_PB_USER_PROFILE` | `"User Profile"` | `"User Profile"` | [supertokens-plugins/packages/profile-base-react/src/translations.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/translations.ts#L3) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/logger.ts#L5)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/plugin.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/plugin.ts#L27)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/logger.ts#L5)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-profile-base" = "supertokens-plugin-profile-base";
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/constants.ts#L1)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/constants.ts#L2)

***

### SECTION\_ORDER\_INCREMENT

```ts
const SECTION_ORDER_INCREMENT: 1000 = 1000;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/constants.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/constants.ts#L4)

***

### usePluginContext

```ts
usePluginContext: any;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/plugin.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/plugin.ts#L18)

***

### WithoutSections

```ts
const WithoutSections: Story;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections-in-card.stories.tsx:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections-in-card.stories.tsx#L28)

More on writing stories with args: https://storybook.js.org/docs/writing-stories/args

***

### WithoutSections

```ts
const WithoutSections: Story;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections.stories.tsx:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections.stories.tsx#L22)

More on writing stories with args: https://storybook.js.org/docs/writing-stories/args

***

### WithSections

```ts
const WithSections: Story;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections-in-card.stories.tsx:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections-in-card.stories.tsx#L34)

***

### WithSections

```ts
const WithSections: Story;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections.stories.tsx:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections.stories.tsx#L28)

## Functions

### ProfilePageWrapper()

```ts
function ProfilePageWrapper(__namedParameters: {
  children: ReactNode;
  style?: CSSProperties;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/page-wrapper/page-wrapper.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/page-wrapper/page-wrapper.tsx#L8)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `children`: `ReactNode`; `style?`: `CSSProperties`; \} |
| `__namedParameters.children` | `ReactNode` |
| `__namedParameters.style?` | `CSSProperties` |

#### Returns

`Element`

***

### ProfileSections()

```ts
function ProfileSections(__namedParameters: {
  sections: {
     component: () => Element;
     id: string;
     title: string | Element;
  }[];
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/components/profile-sections/profile-sections.tsx:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/components/profile-sections/profile-sections.tsx#L9)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `sections`: \{ `component`: () => `Element`; `id`: `string`; `title`: `string` \| `Element`; \}[]; \} |
| `__namedParameters.sections` | \{ `component`: () => `Element`; `id`: `string`; `title`: `string` \| `Element`; \}[] |

#### Returns

`Element`

***

### UserProfilePage()

```ts
function UserProfilePage(): Element;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/user-profile-page.tsx:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/user-profile-page.tsx#L9)

#### Returns

`Element`

***

### UserProfileWrapper()

```ts
function UserProfileWrapper(): Element;
```

Defined in: [supertokens-plugins/packages/profile-base-react/src/user-profile-wrapper.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-base-react/src/user-profile-wrapper.tsx#L8)

#### Returns

`Element`

# References - Plugins -  `@supertokens-plugins/profile-details-nodejs`
Source: https://supertokens.com/docs/references/plugins/profile-details-nodejs

## Classes

### Implementation

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L13)

#### Constructors

##### Constructor

```ts
new Implementation(pluginConfig: SuperTokensPluginProfileDetailsNormalisedConfig): Implementation;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:39](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L39)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `pluginConfig` | [`SuperTokensPluginProfileDetailsNormalisedConfig`](#supertokenspluginprofiledetailsnormalisedconfig) |

###### Returns

[`Implementation`](#implementation)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="buildformdata"></a> `buildFormData` | `public` | (`this`: [`Implementation`](#implementation), `profile`: `BaseProfile`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `BaseFormFieldPayload`[] | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:172](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L172) |
| <a id="buildprofile"></a> `buildProfile` | `public` | (`this`: [`Implementation`](#implementation), `formData`: `BaseFormFieldPayload`[], `existingProfile`: `BaseProfile`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `BaseProfile` | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:153](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L153) |
| <a id="defaultstoragehandlerget"></a> `defaultStorageHandlerGet` | `public` | (`this`: [`Implementation`](#implementation), `userId`: `string`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `profile`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](#baseformsection)\>; \}\> | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:43](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L43) |
| <a id="defaultstoragehandlerset"></a> `defaultStorageHandlerSet` | `public` | (`this`: [`Implementation`](#implementation), `userId`: `string`, `payload`: \{ `profile`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`BaseFormSection`](#baseformsection)\>; \}, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:57](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L57) |
| <a id="getfieldvaluefromthirdpartyuserinfo"></a> `getFieldValueFromThirdPartyUserInfo` | `public` | (`this`: [`Implementation`](#implementation), `providerId`: `string`, `field`: `any`, `rawUserInfoFromProvider`: `any`, `profile`: `BaseProfile`) => `BaseProfile` | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:84](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L84) |
| <a id="getpluginformfields"></a> `getPluginFormFields` | `public` | (`this`: [`Implementation`](#implementation), `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `any`[] | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:72](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L72) |
| <a id="getprofile"></a> `getProfile` | `public` | (`this`: [`Implementation`](#implementation), `userId`: `string`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`BaseProfile`\> | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:114](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L114) |
| <a id="getsections"></a> `getSections` | `public` | (`this`: [`Implementation`](#implementation), `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `BaseFormSection`[] | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:185](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L185) |
| <a id="sections"></a> `sections` | `protected` | `BaseFormSection`[] | `[]` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L16) |
| <a id="updateprofile"></a> `updateProfile` | `public` | (`this`: [`Implementation`](#implementation), `userId`: `string`, `payload`: `BaseFormFieldPayload`[], `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:130](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L130) |
| <a id="instance"></a> `instance` | `static` | [`Implementation`](#implementation) | `undefined` | [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L14) |

#### Methods

##### getInstanceOrThrow()

```ts
static getInstanceOrThrow(): Implementation;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L27)

###### Returns

[`Implementation`](#implementation)

##### init()

```ts
static init(pluginConfig: SuperTokensPluginProfileDetailsNormalisedConfig): Implementation;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L18)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `pluginConfig` | [`SuperTokensPluginProfileDetailsNormalisedConfig`](#supertokenspluginprofiledetailsnormalisedconfig) |

###### Returns

[`Implementation`](#implementation)

##### reset()

```ts
static reset(): void;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/implementation.ts#L35)

###### Returns

`void`

## Type Aliases

### BaseFormSection

```ts
type BaseFormSection = any;
```

***

### SuperTokensPluginProfileDetailsConfig

```ts
type SuperTokensPluginProfileDetailsConfig = 
  | {
  registerSectionsForProgressiveProfiling?: boolean;
  sections?: BaseFormSection[];
}
  | undefined;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L3)

***

### SuperTokensPluginProfileDetailsImplementation

```ts
type SuperTokensPluginProfileDetailsImplementation = {
  thirdPartyFieldMap: (originalImplementation: ThirdPartyFieldMap) => ThirdPartyFieldMap;
};
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L10)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="thirdpartyfieldmap"></a> `thirdPartyFieldMap` | (`originalImplementation`: [`ThirdPartyFieldMap`](#thirdpartyfieldmap-1)) => [`ThirdPartyFieldMap`](#thirdpartyfieldmap-1) | [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L11) |

***

### SuperTokensPluginProfileDetailsNormalisedConfig

```ts
type SuperTokensPluginProfileDetailsNormalisedConfig = {
  registerSectionsForProgressiveProfiling: boolean;
  sections: BaseFormSection[];
};
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L14)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="registersectionsforprogressiveprofiling"></a> `registerSectionsForProgressiveProfiling` | `boolean` | [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L16) |
| <a id="sections-1"></a> `sections` | [`BaseFormSection`](#baseformsection)[] | [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L15) |

***

### ThirdPartyFieldMap()

```ts
type ThirdPartyFieldMap = (providerId: string, field: BaseFormSection & {
  sectionId: string;
}, rawUserInfoFromProvider: any, profile: BaseFormSection) => BaseFormSection[string];
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/types.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/types.ts#L19)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `providerId` | `string` |
| `field` | [`BaseFormSection`](#baseformsection) & \{ `sectionId`: `string`; \} |
| `rawUserInfoFromProvider` | `any` |
| `profile` | [`BaseFormSection`](#baseformsection) |

#### Returns

[`BaseFormSection`](#baseformsection)\[`string`\]

## Variables

### default

```ts
default: {
  getProfile: (userId: string, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<BaseProfile>;
  getSections: (session: SessionContainerInterface, userContext?: Record<string, any>) => BaseFormSection[];
  init: any;
  PLUGIN_ID: string;
  PLUGIN_VERSION: string;
  updateProfile: (userId: string, profile: BaseFormFieldPayload[], session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>;
};
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getprofile-1"></a> `getProfile()` | (`userId`: `string`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`BaseProfile`\> | [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27) |
| <a id="getsections-1"></a> `getSections()` | (`session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => `BaseFormSection`[] | [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27) |
| <a id="init-2"></a> `init` | `any` | [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27) |
| <a id="plugin_id"></a> `PLUGIN_ID` | `string` | [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27) |
| <a id="plugin_version"></a> `PLUGIN_VERSION` | `string` | [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27) |
| <a id="updateprofile-1"></a> `updateProfile()` | (`userId`: `string`, `profile`: `BaseFormFieldPayload`[], `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L27) |

***

### DEFAULT\_REGISTER\_SECTIONS\_FOR\_PROGRESSIVE\_PROFILING

```ts
const DEFAULT_REGISTER_SECTIONS_FOR_PROGRESSIVE_PROFILING: true = true;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L12)

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/logger.ts#L4)

***

### HANDLE\_BASE\_PATH

```ts
const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-profile-details";
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L5)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/plugin.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/plugin.ts#L20)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/logger.ts#L4)

***

### METADATA\_KEY

```ts
const METADATA_KEY: "supertokens-plugin-profile-details";
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L7)

***

### METADATA\_PROFILE\_KEY

```ts
const METADATA_PROFILE_KEY: "st-profile" = "st-profile";
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L8)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-profile-details" = "supertokens-plugin-profile-details";
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L1)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: string[];
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L3)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L2)

***

### SUPERTOKENS\_PLUGIN\_PROGRESSIVE\_PROFILING\_ID

```ts
const SUPERTOKENS_PLUGIN_PROGRESSIVE_PROFILING_ID: "supertokens-plugin-progressive-profiling" = "supertokens-plugin-progressive-profiling";
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/constants.ts#L10)

## Functions

### getProfile()

```ts
function getProfile(
   userId: string, 
   session: SessionContainerInterface, 
userContext?: Record<string, any>): Promise<BaseProfile>;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L10)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `session` | `SessionContainerInterface` |
| `userContext?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`BaseProfile`\>

***

### getSections()

```ts
function getSections(session: SessionContainerInterface, userContext?: Record<string, any>): BaseFormSection[];
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L23)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `userContext?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> |

#### Returns

`BaseFormSection`[]

***

### updateProfile()

```ts
function updateProfile(
   userId: string, 
   profile: BaseFormFieldPayload[], 
   session: SessionContainerInterface, 
userContext?: Record<string, any>): Promise<void>;
```

Defined in: [supertokens-plugins/packages/profile-details-nodejs/src/index.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-nodejs/src/index.ts#L14)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `profile` | `BaseFormFieldPayload`[] |
| `session` | `SessionContainerInterface` |
| `userContext?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

# References - Plugins -  `@supertokens-plugins/profile-details-react`
Source: https://supertokens.com/docs/references/plugins/profile-details-react

## Type Aliases

### AccountDetails

```ts
type AccountDetails = {
  connectedAccounts: ConnectedAccount[];
  emails: string[];
  phoneNumbers: string[];
  timeJoined: number;
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L24)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="connectedaccounts"></a> `connectedAccounts` | [`ConnectedAccount`](#connectedaccount)[] | [supertokens-plugins/packages/profile-details-react/src/types.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L27) |
| <a id="emails"></a> `emails` | `string`[] | [supertokens-plugins/packages/profile-details-react/src/types.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L25) |
| <a id="phonenumbers"></a> `phoneNumbers` | `string`[] | [supertokens-plugins/packages/profile-details-react/src/types.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L26) |
| <a id="timejoined"></a> `timeJoined` | `number` | [supertokens-plugins/packages/profile-details-react/src/types.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L28) |

***

### ConnectedAccount

```ts
type ConnectedAccount = {
  email: string;
  provider: string;
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L31)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email"></a> `email` | `string` | [supertokens-plugins/packages/profile-details-react/src/types.ts:33](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L33) |
| <a id="provider"></a> `provider` | `string` | [supertokens-plugins/packages/profile-details-react/src/types.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L32) |

***

### FieldViewComponentProps\<T\>

```ts
type FieldViewComponentProps<T> = {
  className?: string;
  options?: BaseFormSection["options"];
  value: T;
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L15)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection) | [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection) |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="classname"></a> `className?` | `string` | [supertokens-plugins/packages/profile-details-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L17) |
| <a id="options"></a> `options?` | [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\[`"options"`\] | [supertokens-plugins/packages/profile-details-react/src/types.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L18) |
| <a id="value"></a> `value` | `T` | [supertokens-plugins/packages/profile-details-react/src/types.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L16) |

***

### FormInputComponentMap

```ts
type FormInputComponentMap = Record<BaseFormSection, React.FC<BaseFormSection<any>>>;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L20)

***

### FormViewComponentMap

```ts
type FormViewComponentMap = Omit<Record<BaseFormSection, React.FC<FieldViewComponentProps<any>>>, "password">;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L21)

***

### ProfileDetails

```ts
type ProfileDetails = Record<string, string | number | boolean | null | undefined>;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L23)

***

### SuperTokensPluginProfileDetailsConfig

```ts
type SuperTokensPluginProfileDetailsConfig = undefined;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L6)

***

### SuperTokensPluginProfileDetailsImplementation

```ts
type SuperTokensPluginProfileDetailsImplementation = {
  fieldInputComponentMap: (componentMap: FormInputComponentMap) => FormInputComponentMap;
  fieldViewComponentMap: (componentMap: FormViewComponentMap) => FormViewComponentMap;
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L9)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="fieldinputcomponentmap"></a> `fieldInputComponentMap` | (`componentMap`: [`FormInputComponentMap`](#forminputcomponentmap)) => [`FormInputComponentMap`](#forminputcomponentmap) | [supertokens-plugins/packages/profile-details-react/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L10) |
| <a id="fieldviewcomponentmap"></a> `fieldViewComponentMap` | (`componentMap`: [`FormViewComponentMap`](#formviewcomponentmap)) => [`FormViewComponentMap`](#formviewcomponentmap) | [supertokens-plugins/packages/profile-details-react/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L11) |

***

### SuperTokensPluginProfileDetailsNormalisedConfig

```ts
type SuperTokensPluginProfileDetailsNormalisedConfig = undefined;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L7)

***

### TranslationKeys

```ts
type TranslationKeys = keyof typeof defaultTranslationsCommonDetails["en"];
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/types.ts#L14)

## Variables

### API\_PATH

```ts
const API_PATH: "plugin/supertokens-plugin-profile-details";
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/constants.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/constants.ts#L34)

***

### default

```ts
default: {
  init: any;
  PLUGIN_ID: string;
  PLUGIN_VERSION: string;
  usePluginContext: any;
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/index.ts#L5)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/profile-details-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/index.ts#L5) |
| <a id="plugin_id"></a> `PLUGIN_ID` | `string` | [supertokens-plugins/packages/profile-details-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/index.ts#L5) |
| <a id="plugin_version"></a> `PLUGIN_VERSION` | `string` | [supertokens-plugins/packages/profile-details-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/index.ts#L5) |
| <a id="useplugincontext"></a> `usePluginContext` | `any` | [supertokens-plugins/packages/profile-details-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/index.ts#L5) |

***

### defaultTranslationsCommonDetails

```ts
const defaultTranslationsCommonDetails: {
  en: {
     PL_CD_DISABLED: "Disabled";
     PL_CD_ENABLED: "Enabled";
     PL_CD_IMAGE_ALT: "Preview";
     PL_CD_LOADING: "Loading...";
     PL_CD_NO: "No";
     PL_CD_NO_EMAIL: "No email";
     PL_CD_NO_IMAGE: "No image";
     PL_CD_NO_PHONE: "No phone";
     PL_CD_NO_URL: "No URL";
     PL_CD_NONE_SELECTED: "None selected";
     PL_CD_NOT_PROVIDED: "Not provided";
     PL_CD_SECTION_ACCOUNT_DESCRIPTION: "Here you can find all your account details that can be used for login.";
     PL_CD_SECTION_ACCOUNT_EMAIL_NO_EMAILS: "No email addresse";
     PL_CD_SECTION_ACCOUNT_EMAILS: "Email addresses";
     PL_CD_SECTION_ACCOUNT_ERROR_FETCHING_DETAILS: "Error getting the profile";
     PL_CD_SECTION_ACCOUNT_LABEL: "Account";
     PL_CD_SECTION_ACCOUNT_PHONE_NUMBERS: "Phone numbers";
     PL_CD_SECTION_ACCOUNT_PHONE_NUMBERS_NO_PHONE_NUMBERS: "No phone number";
     PL_CD_SECTION_ACCOUNT_TIME_JOINED: "Join date";
     PL_CD_SECTION_ACCOUNT_TIME_JOINED_NO_TIME_JOINED: "No join date";
     PL_CD_SECTION_DETAILS_CANCEL_BUTTON: "Cancel";
     PL_CD_SECTION_DETAILS_EDIT_BUTTON: "Edit";
     PL_CD_SECTION_DETAILS_ERROR_FETCHING_DETAILS: "Error getting the profile";
     PL_CD_SECTION_DETAILS_SAVE_BUTTON: "Save";
     PL_CD_YES: "Yes";
  };
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/translations.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L1)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="en"></a> `en` | \{ `PL_CD_DISABLED`: `"Disabled"`; `PL_CD_ENABLED`: `"Enabled"`; `PL_CD_IMAGE_ALT`: `"Preview"`; `PL_CD_LOADING`: `"Loading..."`; `PL_CD_NO`: `"No"`; `PL_CD_NO_EMAIL`: `"No email"`; `PL_CD_NO_IMAGE`: `"No image"`; `PL_CD_NO_PHONE`: `"No phone"`; `PL_CD_NO_URL`: `"No URL"`; `PL_CD_NONE_SELECTED`: `"None selected"`; `PL_CD_NOT_PROVIDED`: `"Not provided"`; `PL_CD_SECTION_ACCOUNT_DESCRIPTION`: `"Here you can find all your account details that can be used for login."`; `PL_CD_SECTION_ACCOUNT_EMAIL_NO_EMAILS`: `"No email addresse"`; `PL_CD_SECTION_ACCOUNT_EMAILS`: `"Email addresses"`; `PL_CD_SECTION_ACCOUNT_ERROR_FETCHING_DETAILS`: `"Error getting the profile"`; `PL_CD_SECTION_ACCOUNT_LABEL`: `"Account"`; `PL_CD_SECTION_ACCOUNT_PHONE_NUMBERS`: `"Phone numbers"`; `PL_CD_SECTION_ACCOUNT_PHONE_NUMBERS_NO_PHONE_NUMBERS`: `"No phone number"`; `PL_CD_SECTION_ACCOUNT_TIME_JOINED`: `"Join date"`; `PL_CD_SECTION_ACCOUNT_TIME_JOINED_NO_TIME_JOINED`: `"No join date"`; `PL_CD_SECTION_DETAILS_CANCEL_BUTTON`: `"Cancel"`; `PL_CD_SECTION_DETAILS_EDIT_BUTTON`: `"Edit"`; `PL_CD_SECTION_DETAILS_ERROR_FETCHING_DETAILS`: `"Error getting the profile"`; `PL_CD_SECTION_DETAILS_SAVE_BUTTON`: `"Save"`; `PL_CD_YES`: `"Yes"`; \} | - | [supertokens-plugins/packages/profile-details-react/src/translations.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L2) |
| `en.PL_CD_DISABLED` | `"Disabled"` | `"Disabled"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L9) |
| `en.PL_CD_ENABLED` | `"Enabled"` | `"Enabled"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L8) |
| `en.PL_CD_IMAGE_ALT` | `"Preview"` | `"Preview"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L10) |
| `en.PL_CD_LOADING` | `"Loading..."` | `"Loading..."` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L3) |
| `en.PL_CD_NO` | `"No"` | `"No"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L7) |
| `en.PL_CD_NO_EMAIL` | `"No email"` | `"No email"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L13) |
| `en.PL_CD_NO_IMAGE` | `"No image"` | `"No image"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L11) |
| `en.PL_CD_NO_PHONE` | `"No phone"` | `"No phone"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L14) |
| `en.PL_CD_NO_URL` | `"No URL"` | `"No URL"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L12) |
| `en.PL_CD_NONE_SELECTED` | `"None selected"` | `"None selected"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L5) |
| `en.PL_CD_NOT_PROVIDED` | `"Not provided"` | `"Not provided"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L4) |
| `en.PL_CD_SECTION_ACCOUNT_DESCRIPTION` | `"Here you can find all your account details that can be used for login."` | `"Here you can find all your account details that can be used for login."` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L22) |
| `en.PL_CD_SECTION_ACCOUNT_EMAIL_NO_EMAILS` | `"No email addresse"` | `"No email addresse"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L26) |
| `en.PL_CD_SECTION_ACCOUNT_EMAILS` | `"Email addresses"` | `"Email addresses"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L23) |
| `en.PL_CD_SECTION_ACCOUNT_ERROR_FETCHING_DETAILS` | `"Error getting the profile"` | `"Error getting the profile"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:29](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L29) |
| `en.PL_CD_SECTION_ACCOUNT_LABEL` | `"Account"` | `"Account"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L21) |
| `en.PL_CD_SECTION_ACCOUNT_PHONE_NUMBERS` | `"Phone numbers"` | `"Phone numbers"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L27) |
| `en.PL_CD_SECTION_ACCOUNT_PHONE_NUMBERS_NO_PHONE_NUMBERS` | `"No phone number"` | `"No phone number"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L28) |
| `en.PL_CD_SECTION_ACCOUNT_TIME_JOINED` | `"Join date"` | `"Join date"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L24) |
| `en.PL_CD_SECTION_ACCOUNT_TIME_JOINED_NO_TIME_JOINED` | `"No join date"` | `"No join date"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L25) |
| `en.PL_CD_SECTION_DETAILS_CANCEL_BUTTON` | `"Cancel"` | `"Cancel"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L17) |
| `en.PL_CD_SECTION_DETAILS_EDIT_BUTTON` | `"Edit"` | `"Edit"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L18) |
| `en.PL_CD_SECTION_DETAILS_ERROR_FETCHING_DETAILS` | `"Error getting the profile"` | `"Error getting the profile"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L16) |
| `en.PL_CD_SECTION_DETAILS_SAVE_BUTTON` | `"Save"` | `"Save"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L19) |
| `en.PL_CD_YES` | `"Yes"` | `"Yes"` | [supertokens-plugins/packages/profile-details-react/src/translations.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/translations.ts#L6) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/logger.ts#L5)

***

### FIELD\_INPUT\_COMPONENT\_MAP

```ts
const FIELD_INPUT_COMPONENT_MAP: FormInputComponentMap;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/constants.ts:36](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/constants.ts#L36)

***

### FIELD\_VIEW\_COMPONENT\_MAP

```ts
const FIELD_VIEW_COMPONENT_MAP: FormViewComponentMap;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/constants.ts:63](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/constants.ts#L63)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/plugin.ts:39](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/plugin.ts#L39)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/logger.ts#L5)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-profile-details" = "supertokens-plugin-profile-details";
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/constants.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/constants.ts#L31)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/constants.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/constants.ts#L32)

***

### usePluginContext

```ts
usePluginContext: any;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/plugin.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/plugin.ts#L26)

## Functions

### AccountDetailsSection()

```ts
function AccountDetailsSection(__namedParameters: {
  onFetch: () => Promise<{
     profile: Record<string, any>;
     user: User;
  }>;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/account-details-section.tsx:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/account-details-section.tsx#L13)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `onFetch`: () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `profile`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; `user`: `User`; \}\>; \} |
| `__namedParameters.onFetch` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `profile`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; `user`: `User`; \}\> |

#### Returns

`Element`

***

### AccountSectionWrapper()

```ts
function AccountSectionWrapper(): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/account-section-wrapper.tsx:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/account-section-wrapper.tsx#L7)

#### Returns

`Element`

***

### BooleanFieldViewComponent()

```ts
function BooleanFieldViewComponent(__namedParameters: FieldViewComponentProps<boolean>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L12)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`boolean`\> |

#### Returns

`Element`

***

### DateFieldViewComponent()

```ts
function DateFieldViewComponent(__namedParameters: FieldViewComponentProps<string>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:160](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L160)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`\> |

#### Returns

`Element`

***

### DefaultFieldViewComponent()

```ts
function DefaultFieldViewComponent(__namedParameters: FieldViewComponentProps): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:149](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L149)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops) |

#### Returns

`Element`

***

### DetailsSectionContent()

```ts
function DetailsSectionContent(__namedParameters: {
  onFetch: () => Promise<{
     profile: Record<string, any>;
     user: User;
  }>;
  onSubmit: (data: BaseFormFieldPayload[]) => Promise<any>;
  section: BaseFormSection;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/details-section.tsx:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/details-section.tsx#L15)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `onFetch`: () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `profile`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; `user`: `User`; \}\>; `onSubmit`: (`data`: `BaseFormFieldPayload`[]) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\>; `section`: `BaseFormSection`; \} |
| `__namedParameters.onFetch` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `profile`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; `user`: `User`; \}\> |
| `__namedParameters.onSubmit` | (`data`: `BaseFormFieldPayload`[]) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> |
| `__namedParameters.section` | `BaseFormSection` |

#### Returns

`Element`

***

### DetailsSectionWrapper()

```ts
function DetailsSectionWrapper(__namedParameters: {
  section: BaseFormSection;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/details-section-wrapper.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/details-section-wrapper.tsx#L8)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `section`: `BaseFormSection`; \} |
| `__namedParameters.section` | `BaseFormSection` |

#### Returns

`Element`

***

### EmailFieldViewComponent()

```ts
function EmailFieldViewComponent(__namedParameters: FieldViewComponentProps<string>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:119](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L119)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`\> |

#### Returns

`Element`

***

### FieldView()

```ts
function FieldView(__namedParameters: FieldViewComponentProps<FormFieldValue> & {
  componentMap: FormViewComponentMap;
  type: any;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:171](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L171)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`FormFieldValue`\> & \{ `componentMap`: [`FormViewComponentMap`](#formviewcomponentmap); `type`: `any`; \} |

#### Returns

`Element`

***

### getApi()

```ts
function getApi(querier: any): {
  getDetails: () => Promise<any>;
  getSections: () => Promise<any>;
  updateProfile: (payload: {
     data: BaseFormFieldPayload[];
  }) => Promise<any>;
};
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/api.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/api.ts#L7)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `querier` | `any` |

#### Returns

```ts
{
  getDetails: () => Promise<any>;
  getSections: () => Promise<any>;
  updateProfile: (payload: {
     data: BaseFormFieldPayload[];
  }) => Promise<any>;
}
```

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `getDetails()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/profile-details-react/src/api.ts:33](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/api.ts#L33) |
| `getSections()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/profile-details-react/src/api.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/api.ts#L35) |
| `updateProfile()` | (`payload`: \{ `data`: `BaseFormFieldPayload`[]; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/profile-details-react/src/api.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/api.ts#L34) |

***

### ImageUrlFieldViewComponent()

```ts
function ImageUrlFieldViewComponent(__namedParameters: FieldViewComponentProps<string>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:80](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L80)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`\> |

#### Returns

`Element`

***

### MultiselectFieldViewComponent()

```ts
function MultiselectFieldViewComponent(__namedParameters: FieldViewComponentProps<string[]>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L38)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`[]\> |

#### Returns

`Element`

***

### PhoneFieldViewComponent()

```ts
function PhoneFieldViewComponent(__namedParameters: FieldViewComponentProps<string>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:134](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L134)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`\> |

#### Returns

`Element`

***

### SectionEdit()

```ts
function SectionEdit(__namedParameters: {
  fields: any;
  id: any;
  onCancel: any;
  onSubmit: any;
  values: any;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/section-edit.tsx:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/section-edit.tsx#L12)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `fields`: `any`; `id`: `any`; `onCancel`: `any`; `onSubmit`: `any`; `values`: `any`; \} |
| `__namedParameters.fields` | `any` |
| `__namedParameters.id` | `any` |
| `__namedParameters.onCancel` | `any` |
| `__namedParameters.onSubmit` | `any` |
| `__namedParameters.values` | `any` |

#### Returns

`Element`

***

### SectionView()

```ts
function SectionView(__namedParameters: {
  fields: any;
  onEdit: any;
  values: any;
}): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/section-view.tsx:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/section-view.tsx#L11)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `fields`: `any`; `onEdit`: `any`; `values`: `any`; \} |
| `__namedParameters.fields` | `any` |
| `__namedParameters.onEdit` | `any` |
| `__namedParameters.values` | `any` |

#### Returns

`Element`

***

### SelectFieldViewComponent()

```ts
function SelectFieldViewComponent(__namedParameters: FieldViewComponentProps<string>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:62](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L62)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`\> |

#### Returns

`Element`

***

### ToggleFieldViewComponent()

```ts
function ToggleFieldViewComponent(__namedParameters: FieldViewComponentProps<boolean>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L25)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`boolean`\> |

#### Returns

`Element`

***

### UrlFieldViewComponent()

```ts
function UrlFieldViewComponent(__namedParameters: FieldViewComponentProps<string>): Element;
```

Defined in: [supertokens-plugins/packages/profile-details-react/src/components/details-section/field-view-components.tsx:100](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-react/src/components/details-section/field-view-components.tsx#L100)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | [`FieldViewComponentProps`](#fieldviewcomponentprops)\<`string`\> |

#### Returns

`Element`

# References - Plugins -  profile-details-shared
Source: https://supertokens.com/docs/references/plugins/profile-details-shared

## Type Aliases

### BaseField\<T\>

```ts
type BaseField<T> = {
  default?: BaseProfile[string];
  id: string;
};
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L3)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`BaseProfile`](#baseprofile)\[`string`\] | [`BaseProfile`](#baseprofile)\[`string`\] |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="default"></a> `default?` | [`BaseProfile`](#baseprofile)\[`string`\] | [supertokens-plugins/packages/profile-details-shared/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L5) |
| <a id="id"></a> `id` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L4) |

***

### BaseFormField\<T\>

```ts
type BaseFormField<T> = BaseField<T> & {
  label: string;
  options?: {
     label: string;
     value: T;
  }[];
  order?: number;
  placeholder?: string;
  required?: boolean;
  type:   | "string"
     | "text"
     | "number"
     | "boolean"
     | "email"
     | "phone"
     | "date"
     | "select"
     | "multiselect"
     | "password"
     | "url"
     | "image-url"
     | "toggle";
};
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/types.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L8)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `label` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L9) |
| `options?` | \{ `label`: `string`; `value`: `T`; \}[] | [supertokens-plugins/packages/profile-details-shared/src/types.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L26) |
| `order?` | `number` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L27) |
| `placeholder?` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L10) |
| `required?` | `boolean` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L11) |
| `type` | \| `"string"` \| `"text"` \| `"number"` \| `"boolean"` \| `"email"` \| `"phone"` \| `"date"` \| `"select"` \| `"multiselect"` \| `"password"` \| `"url"` \| `"image-url"` \| `"toggle"` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L12) |

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`BaseProfile`](#baseprofile)\[`string`\] | [`BaseProfile`](#baseprofile)\[`string`\] |

***

### BaseFormFieldPayload\<T\>

```ts
type BaseFormFieldPayload<T> = {
  fieldId: string;
  sectionId: string;
  value: T;
};
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/types.ts:39](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L39)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` *extends* [`BaseProfile`](#baseprofile)\[`string`\] | [`BaseProfile`](#baseprofile)\[`string`\] |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="fieldid"></a> `fieldId` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:41](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L41) |
| <a id="sectionid"></a> `sectionId` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:40](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L40) |
| <a id="value"></a> `value` | `T` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:42](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L42) |

***

### BaseFormFieldSet

```ts
type BaseFormFieldSet = Record<string, Omit<BaseFormField, "id">>;
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/types.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L37)

***

### BaseFormSection

```ts
type BaseFormSection = {
  description?: string;
  fields: BaseFormField[];
  id: string;
  label: string;
};
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/types.ts:30](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L30)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="description"></a> `description?` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:33](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L33) |
| <a id="fields"></a> `fields` | [`BaseFormField`](#baseformfield)[] | [supertokens-plugins/packages/profile-details-shared/src/types.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L34) |
| <a id="id-1"></a> `id` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L31) |
| <a id="label"></a> `label` | `string` | [supertokens-plugins/packages/profile-details-shared/src/types.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L32) |

***

### BaseProfile

```ts
type BaseProfile = Record<string, string | number | boolean | null | undefined | string[]>;
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/types.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/types.ts#L1)

## Variables

### BASE\_FORM\_SECTIONS

```ts
const BASE_FORM_SECTIONS: BaseFormSection[];
```

Defined in: [supertokens-plugins/packages/profile-details-shared/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/profile-details-shared/src/constants.ts#L3)

# References - Plugins -  `@supertokens-plugins/progressive-profiling-nodejs`
Source: https://supertokens.com/docs/references/plugins/progressive-profiling-nodejs

## Classes

### Implementation

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L11)

#### Constructors

##### Constructor

```ts
new Implementation(): Implementation;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:42](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L42)

###### Returns

[`Implementation`](#implementation)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="areallsectionscompleted"></a> `areAllSectionsCompleted` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `recipeUserId`: `string`; `tenantId`: `string`; `userContext`: `any`; `userId`: `string`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:362](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L362) |
| <a id="defaultstoragehandlergetfields"></a> `defaultStorageHandlerGetFields` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `pluginFormFields`: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<`FormField`, `"id"` \| `"defaultValue"`\> & \{ `sectionId`: `string`; \}[]; `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`ProfileFormData`\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:61](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L61) |
| <a id="defaultstoragehandlersetfields"></a> `defaultStorageHandlerSetFields` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `data`: `ProfileFormData`; `pluginFormFields`: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<`FormField`, `"id"` \| `"defaultValue"`\> & \{ `sectionId`: `string`; \}[]; `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:87](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L87) |
| <a id="existingsections"></a> `existingSections` | `protected` | [`FormSection`](#formsection) & \{ `storageHandlerId`: `string`; \}[] | `[]` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L14) |
| <a id="existingstoragehandlers"></a> `existingStorageHandlers` | `protected` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`Parameters`](https://www.typescriptlang.org/docs/handbook/utility-types.html#parameterstype)\<[`RegisterSections`](#registersections-1)\>\[`0`\], `"set"` \| `"get"`\>\> | `{}` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L15) |
| <a id="getallsections"></a> `getAllSections` | `public` | (`this`: [`Implementation`](#implementation), `input`: \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`FormSection`](#formsection) & \{ `storageHandlerId`: `string`; \}[] | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:158](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L158) |
| <a id="getglobalclaimvalidatoroverrides"></a> `getGlobalClaimValidatorOverrides` | `public` | (`this`: [`Implementation`](#implementation)) => `FilterGlobalClaimValidators`[] | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:403](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L403) |
| <a id="getsectionvalues"></a> `getSectionValues` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `data`: `ProfileFormData`; `status`: `string`; \}\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:298](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L298) |
| <a id="getsessionusersections"></a> `getSessionUserSections` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `sections`: \{ `completed`: `any`; `description`: `SharedFormSection`; `fields`: `any`; `id`: `SharedFormSection`; `label`: `SharedFormSection`; \}[]; `status`: `string`; \}\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:166](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L166) |
| <a id="globalclaimvalidatoroverrides"></a> `globalClaimValidatorOverrides` | `protected` | `FilterGlobalClaimValidators`[] | `[]` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L17) |
| <a id="issectionvalid"></a> `isSectionValid` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `data`: `ProfileFormData`; `section`: [`FormSection`](#formsection); `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:338](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L338) |
| <a id="metadata"></a> `metadata` | `protected` | `any` | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L16) |
| <a id="registerglobalclaimvalidatoroverride"></a> `registerGlobalClaimValidatorOverride` | `public` | (`this`: [`Implementation`](#implementation), `fn`: `FilterGlobalClaimValidators`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:399](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L399) |
| <a id="registersections"></a> `registerSections` | `public` | [`RegisterSections`](#registersections-1) | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:131](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L131) |
| <a id="setsectionvalues"></a> `setSectionValues` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `data`: `ProfileFormData`; `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `errors`: `any`; `status`: `string`; \} \| \{ `errors?`: `undefined`; `status`: `string`; \}\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:195](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L195) |
| <a id="storecompletedsections"></a> `storeCompletedSections` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `sectionsCompleted`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `boolean`\>; `session`: `SessionContainerInterface`; `userContext`: `any`; `userId`: `string`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:372](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L372) |
| <a id="validatefield"></a> `validateField` | `public` | (`this`: [`Implementation`](#implementation), `__namedParameters`: \{ `field`: `FormField`; `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; `value`: `FormFieldValue`; \}) => `string` \| `string`[] | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:319](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L319) |
| <a id="instance"></a> `instance` | `static` | [`Implementation`](#implementation) | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L12) |
| <a id="progressiveprofilingcompletedclaim"></a> `ProgressiveProfilingCompletedClaim` | `static` | `BooleanClaim` | `undefined` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L19) |

#### Methods

##### getInstanceOrThrow()

```ts
static getInstanceOrThrow(): Implementation;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:30](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L30)

###### Returns

[`Implementation`](#implementation)

##### init()

```ts
static init(): Implementation;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L21)

###### Returns

[`Implementation`](#implementation)

##### reset()

```ts
static reset(): void;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/implementation.ts:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/implementation.ts#L38)

###### Returns

`void`

## Type Aliases

### FormSection

```ts
type FormSection = Omit<BaseFormSection, "completed">;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L14)

***

### RegisterSections()

```ts
type RegisterSections = (payload: {
  get: (session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<BaseFormSection>;
  sections: FormSection[];
  set: (data: BaseFormSection, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>;
  storageHandlerId: string;
}) => void;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L16)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | \{ `get`: (`session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\>; `sections`: [`FormSection`](#formsection)[]; `set`: (`data`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection), `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>; `storageHandlerId`: `string`; \} |
| `payload.get` | (`session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)\> |
| `payload.sections` | [`FormSection`](#formsection)[] |
| `payload.set` | (`data`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection), `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> |
| `payload.storageHandlerId` | `string` |

#### Returns

`void`

***

### SuperTokensPluginProfileProgressiveProfilingConfig

```ts
type SuperTokensPluginProfileProgressiveProfilingConfig = {
  sections?: FormSection[];
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L4)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="sections"></a> `sections?` | [`FormSection`](#formsection)[] | [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L5) |

***

### SuperTokensPluginProfileProgressiveProfilingNormalisedConfig

```ts
type SuperTokensPluginProfileProgressiveProfilingNormalisedConfig = Required<SuperTokensPluginProfileProgressiveProfilingConfig>;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L7)

***

### UserMetadataConfig

```ts
type UserMetadataConfig = {
  sectionsCompleted: Record<string, boolean>;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L10)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="sectionscompleted"></a> `sectionsCompleted` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `boolean`\> | [supertokens-plugins/packages/progressive-profiling-nodejs/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/types.ts#L11) |

## Variables

### default

```ts
default: {
  getAllSections: (input: {
     session: SessionContainerInterface;
     userContext?: Record<string, any>;
   }) => FormSection & {
     storageHandlerId: string;
  }[];
  getSectionValues: (input: {
     session: SessionContainerInterface;
     userContext?: Record<string, any>;
   }) => Promise<{
     data: ProfileFormData;
     status: string;
  }>;
  init: any;
  PLUGIN_ID: string;
  PLUGIN_VERSION: string;
  registerGlobalClaimValidatorOverride: (fn: FilterGlobalClaimValidators) => Promise<void>;
  registerSections: (payload: {
     get: (session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<ProfileFormData>;
     sections: FormSection[];
     set: (data: ProfileFormData, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>;
     storageHandlerId: string;
  }) => void;
  setSectionValues: (input: {
     data: ProfileFormData;
     session: SessionContainerInterface;
     userContext?: Record<string, any>;
   }) => Promise<
     | {
     errors: any;
     status: string;
   }
     | {
     errors?: undefined;
     status: string;
  }>;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:36](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L36)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getallsections-1"></a> `getAllSections()` | (`input`: \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`FormSection`](#formsection) & \{ `storageHandlerId`: `string`; \}[] | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:43](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L43) |
| <a id="getsectionvalues-1"></a> `getSectionValues()` | (`input`: \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `data`: `ProfileFormData`; `status`: `string`; \}\> | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:40](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L40) |
| <a id="init-2"></a> `init` | `any` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L37) |
| <a id="plugin_id"></a> `PLUGIN_ID` | `string` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L38) |
| <a id="plugin_version"></a> `PLUGIN_VERSION` | `string` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:39](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L39) |
| <a id="registerglobalclaimvalidatoroverride-1"></a> `registerGlobalClaimValidatorOverride()` | (`fn`: `FilterGlobalClaimValidators`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:44](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L44) |
| <a id="registersections-2"></a> `registerSections()` | (`payload`: \{ `get`: (`session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`ProfileFormData`\>; `sections`: [`FormSection`](#formsection)[]; `set`: (`data`: `ProfileFormData`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>; `storageHandlerId`: `string`; \}) => `void` | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:42](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L42) |
| <a id="setsectionvalues-1"></a> `setSectionValues()` | (`input`: \{ `data`: `ProfileFormData`; `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `errors`: `any`; `status`: `string`; \} \| \{ `errors?`: `undefined`; `status`: `string`; \}\> | [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:41](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L41) |

***

### DEFAULT\_SECTIONS

```ts
const DEFAULT_SECTIONS: FormSection[] = [];
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L12)

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/logger.ts#L4)

***

### HANDLE\_BASE\_PATH

```ts
const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-progressive-profiling";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L10)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/plugin.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/plugin.ts#L17)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/logger.ts#L4)

***

### METADATA\_KEY

```ts
const METADATA_KEY: "supertokens-plugin-progressive-profiling";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L7)

***

### METADATA\_PROFILE\_KEY

```ts
const METADATA_PROFILE_KEY: "st-profile" = "st-profile";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L8)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-progressive-profiling" = "supertokens-plugin-progressive-profiling";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L3)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: string[];
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L5)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/constants.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/constants.ts#L4)

## Functions

### getAllSections()

```ts
function getAllSections(input: {
  session: SessionContainerInterface;
  userContext?: Record<string, any>;
}): FormSection & {
  storageHandlerId: string;
}[];
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L27)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \} |
| `input.session` | `SessionContainerInterface` |
| `input.userContext?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> |

#### Returns

[`FormSection`](#formsection) & \{
  `storageHandlerId`: `string`;
\}[]

***

### getSectionValues()

```ts
function getSectionValues(input: {
  session: SessionContainerInterface;
  userContext?: Record<string, any>;
}): Promise<{
  data: ProfileFormData;
  status: string;
}>;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L11)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \} |
| `input.session` | `SessionContainerInterface` |
| `input.userContext?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{
  `data`: `ProfileFormData`;
  `status`: `string`;
\}\>

***

### registerSections()

```ts
function registerSections(payload: {
  get: (session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<ProfileFormData>;
  sections: FormSection[];
  set: (data: ProfileFormData, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>;
  storageHandlerId: string;
}): void;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L23)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | \{ `get`: (`session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`ProfileFormData`\>; `sections`: [`FormSection`](#formsection)[]; `set`: (`data`: `ProfileFormData`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>; `storageHandlerId`: `string`; \} |
| `payload.get` | (`session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`ProfileFormData`\> |
| `payload.sections` | [`FormSection`](#formsection)[] |
| `payload.set` | (`data`: `ProfileFormData`, `session`: `SessionContainerInterface`, `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> |
| `payload.storageHandlerId` | `string` |

#### Returns

`void`

***

### setSectionValues()

```ts
function setSectionValues(input: {
  data: ProfileFormData;
  session: SessionContainerInterface;
  userContext?: Record<string, any>;
}): Promise<
  | {
  errors: any;
  status: string;
}
  | {
  errors?: undefined;
  status: string;
}>;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-nodejs/src/index.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-nodejs/src/index.ts#L15)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `data`: `ProfileFormData`; `session`: `SessionContainerInterface`; `userContext?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; \} |
| `input.data` | `ProfileFormData` |
| `input.session` | `SessionContainerInterface` |
| `input.userContext?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<
  \| \{
  `errors`: `any`;
  `status`: `string`;
\}
  \| \{
  `errors?`: `undefined`;
  `status`: `string`;
\}\>

# References - Plugins -  `@supertokens-plugins/progressive-profiling-react`
Source: https://supertokens.com/docs/references/plugins/progressive-profiling-react

## Type Aliases

### FormInputComponentMap

```ts
type FormInputComponentMap = Record<BaseFormSection, React.FC<BaseFormSection<any>>>;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L27)

***

### SuperTokensPluginProfileProgressiveProfilingConfig

```ts
type SuperTokensPluginProfileProgressiveProfilingConfig = {
  onSuccess?: (data: BaseFormSection) => 
     | Promise<void>
    | undefined;
  requireSetup?: boolean;
  setupPagePath?: string;
  showEndSection?: boolean;
  showStartSection?: boolean;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L6)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="onsuccess"></a> `onSuccess?` | (`data`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)) => \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> \| `undefined` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L11) |
| <a id="requiresetup"></a> `requireSetup?` | `boolean` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L8) |
| <a id="setuppagepath"></a> `setupPagePath?` | `string` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L7) |
| <a id="showendsection"></a> `showEndSection?` | `boolean` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L10) |
| <a id="showstartsection"></a> `showStartSection?` | `boolean` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L9) |

***

### SuperTokensPluginProfileProgressiveProfilingImplementation

```ts
type SuperTokensPluginProfileProgressiveProfilingImplementation = {
  componentMap: () => FormInputComponentMap;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L22)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="componentmap"></a> `componentMap` | () => [`FormInputComponentMap`](#forminputcomponentmap) | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L23) |

***

### SuperTokensPluginProfileProgressiveProfilingNormalisedConfig

```ts
type SuperTokensPluginProfileProgressiveProfilingNormalisedConfig = {
  onSuccess?: (data: BaseFormSection) => 
     | Promise<void>
    | undefined;
  requireSetup: boolean;
  setupPagePath: string;
  showEndSection: boolean;
  showStartSection: boolean;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L14)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="onsuccess-1"></a> `onSuccess?` | (`data`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)) => \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> \| `undefined` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L19) |
| <a id="requiresetup-1"></a> `requireSetup` | `boolean` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L16) |
| <a id="setuppagepath-1"></a> `setupPagePath` | `string` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L15) |
| <a id="showendsection-1"></a> `showEndSection` | `boolean` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L18) |
| <a id="showstartsection-1"></a> `showStartSection` | `boolean` | [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L17) |

***

### TranslationKeys

```ts
type TranslationKeys = keyof typeof defaultTranslationsProgressiveProfiling["en"];
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/types.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/types.ts#L26)

## Variables

### API\_PATH

```ts
const API_PATH: "plugin/supertokens-plugin-progressive-profiling";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L22)

***

### default

```ts
default: {
  init: any;
  PLUGIN_ID: string;
  PLUGIN_VERSION: string;
  usePluginContext: any;
  UserProfileWrapper: () => Element;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/index.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/index.ts#L7)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | - | [supertokens-plugins/packages/progressive-profiling-react/src/index.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/index.ts#L8) |
| <a id="plugin_id"></a> `PLUGIN_ID` | `string` | - | [supertokens-plugins/packages/progressive-profiling-react/src/index.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/index.ts#L10) |
| <a id="plugin_version"></a> `PLUGIN_VERSION` | `string` | - | [supertokens-plugins/packages/progressive-profiling-react/src/index.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/index.ts#L11) |
| <a id="useplugincontext"></a> `usePluginContext` | `any` | - | [supertokens-plugins/packages/progressive-profiling-react/src/index.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/index.ts#L9) |
| <a id="userprofilewrapper"></a> `UserProfileWrapper()` | () => `Element` | `ProgressiveProfilingWrapper` | [supertokens-plugins/packages/progressive-profiling-react/src/index.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/index.ts#L12) |

***

### DEFAULT\_FIELD\_TYPE\_COMPONENT\_MAP

```ts
const DEFAULT_FIELD_TYPE_COMPONENT_MAP: FormInputComponentMap;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L24)

***

### DEFAULT\_REQUIRE\_SETUP

```ts
const DEFAULT_REQUIRE_SETUP: true = true;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:40](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L40)

***

### DEFAULT\_SETUP\_PAGE\_PATH

```ts
const DEFAULT_SETUP_PAGE_PATH: "/user/setup" = "/user/setup";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:41](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L41)

***

### DEFAULT\_SHOW\_END\_SECTION

```ts
const DEFAULT_SHOW_END_SECTION: true = true;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:44](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L44)

***

### DEFAULT\_SHOW\_START\_SECTION

```ts
const DEFAULT_SHOW_START_SECTION: true = true;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:43](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L43)

***

### defaultTranslationsProgressiveProfiling

```ts
const defaultTranslationsProgressiveProfiling: {
  en: {
     PL_PP_LOADING: "Loading...";
     PL_PP_NO_SECTIONS: "No sections found";
     PL_PP_PROFILE_SETUP_NOT_AVAILABLE: "The profile setup is not available";
     PL_PP_SECTION_COMPLETE_BUTTON: "Complete";
     PL_PP_SECTION_NEXT_BUTTON: "Next";
     PL_PP_SECTION_PROFILE_END_DESCRIPTION: "You have completed the profile setup. You can now advance to the next step.";
     PL_PP_SECTION_PROFILE_END_LABEL: "Profile";
     PL_PP_SECTION_PROFILE_START_DESCRIPTION: "Before advancing any further, you will have to go through a quick {steps} step process for setting up your profile. This is only done once.";
     PL_PP_SECTION_PROFILE_START_LABEL: "Profile";
     PL_PP_SECTION_SAVE_AND_NEXT_BUTTON: "Save & Next";
  };
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L1)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="en"></a> `en` | \{ `PL_PP_LOADING`: `"Loading..."`; `PL_PP_NO_SECTIONS`: `"No sections found"`; `PL_PP_PROFILE_SETUP_NOT_AVAILABLE`: `"The profile setup is not available"`; `PL_PP_SECTION_COMPLETE_BUTTON`: `"Complete"`; `PL_PP_SECTION_NEXT_BUTTON`: `"Next"`; `PL_PP_SECTION_PROFILE_END_DESCRIPTION`: `"You have completed the profile setup. You can now advance to the next step."`; `PL_PP_SECTION_PROFILE_END_LABEL`: `"Profile"`; `PL_PP_SECTION_PROFILE_START_DESCRIPTION`: `"Before advancing any further, you will have to go through a quick {steps} step process for setting up your profile. This is only done once."`; `PL_PP_SECTION_PROFILE_START_LABEL`: `"Profile"`; `PL_PP_SECTION_SAVE_AND_NEXT_BUTTON`: `"Save & Next"`; \} | - | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L2) |
| `en.PL_PP_LOADING` | `"Loading..."` | `"Loading..."` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L13) |
| `en.PL_PP_NO_SECTIONS` | `"No sections found"` | `"No sections found"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L3) |
| `en.PL_PP_PROFILE_SETUP_NOT_AVAILABLE` | `"The profile setup is not available"` | `"The profile setup is not available"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L14) |
| `en.PL_PP_SECTION_COMPLETE_BUTTON` | `"Complete"` | `"Complete"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L12) |
| `en.PL_PP_SECTION_NEXT_BUTTON` | `"Next"` | `"Next"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L10) |
| `en.PL_PP_SECTION_PROFILE_END_DESCRIPTION` | `"You have completed the profile setup. You can now advance to the next step."` | `"You have completed the profile setup. You can now advance to the next step."` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L8) |
| `en.PL_PP_SECTION_PROFILE_END_LABEL` | `"Profile"` | `"Profile"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L7) |
| `en.PL_PP_SECTION_PROFILE_START_DESCRIPTION` | `"Before advancing any further, you will have to go through a quick {steps} step process for setting up your profile. This is only done once."` | `"Before advancing any further, you will have to go through a quick {steps} step process for setting up your profile. This is only done once."` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L5) |
| `en.PL_PP_SECTION_PROFILE_START_LABEL` | `"Profile"` | `"Profile"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L4) |
| `en.PL_PP_SECTION_SAVE_AND_NEXT_BUTTON` | `"Save & Next"` | `"Save & Next"` | [supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/translations.ts#L11) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/logger.ts#L5)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/plugin.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/plugin.ts#L37)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/logger.ts#L5)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-progressive-profiling" = "supertokens-plugin-progressive-profiling";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L19)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/constants.ts#L20)

***

### usePluginContext

```ts
usePluginContext: any;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/plugin.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/plugin.ts#L27)

## Functions

### getApi()

```ts
function getApi(querier: any): {
  getProfile: () => Promise<any>;
  getSections: () => Promise<any>;
  updateProfile: (payload: {
     data: ProfileFormData;
  }) => Promise<any>;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/api.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/api.ts#L4)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `querier` | `any` |

#### Returns

```ts
{
  getProfile: () => Promise<any>;
  getSections: () => Promise<any>;
  updateProfile: (payload: {
     data: ProfileFormData;
  }) => Promise<any>;
}
```

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `getProfile()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/progressive-profiling-react/src/api.ts:58](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/api.ts#L58) |
| `getSections()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/progressive-profiling-react/src/api.ts:60](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/api.ts#L60) |
| `updateProfile()` | (`payload`: \{ `data`: `ProfileFormData`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/progressive-profiling-react/src/api.ts:59](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/api.ts#L59) |

***

### PageWrapper()

```ts
function PageWrapper(__namedParameters: {
  children: ReactNode;
  style?: CSSProperties;
}): Element;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/components/page-wrapper/page-wrapper.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/components/page-wrapper/page-wrapper.tsx#L8)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `children`: `ReactNode`; `style?`: `CSSProperties`; \} |
| `__namedParameters.children` | `ReactNode` |
| `__namedParameters.style?` | `CSSProperties` |

#### Returns

`Element`

***

### ProgressiveProfilingForm()

```ts
function ProgressiveProfilingForm(__namedParameters: ProgressiveProfilingFormProps): Element;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/components/progressive-profiling-form/progressive-profiling-form.tsx:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/components/progressive-profiling-form/progressive-profiling-form.tsx#L32)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | `ProgressiveProfilingFormProps` |

#### Returns

`Element`

***

### ProgressiveProfilingSetupPage()

```ts
function ProgressiveProfilingSetupPage(): Element;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/progressive-profiling-setup-page.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/progressive-profiling-setup-page.tsx#L8)

#### Returns

`Element`

***

### ProgressiveProfilingWrapper()

```ts
function ProgressiveProfilingWrapper(): Element;
```

Defined in: [supertokens-plugins/packages/progressive-profiling-react/src/progressive-profiling-wrapper.tsx:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-react/src/progressive-profiling-wrapper.tsx#L9)

#### Returns

`Element`

# References - Plugins -  progressive-profiling-shared
Source: https://supertokens.com/docs/references/plugins/progressive-profiling-shared

## Type Aliases

### FormField

```ts
type FormField = {
  defaultValue?: FormFieldValue;
  description?: string;
  id: string;
  label: string;
  options?: {
     label: string;
     value: FormFieldValue;
  }[];
  placeholder?: string;
  required: boolean;
  type:   | "string"
     | "text"
     | "number"
     | "boolean"
     | "email"
     | "phone"
     | "date"
     | "select"
     | "multiselect"
     | "password"
     | "url"
     | "image-url"
     | "toggle";
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L3)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultvalue"></a> `defaultValue?` | [`FormFieldValue`](#formfieldvalue) | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L21) |
| <a id="description"></a> `description?` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L23) |
| <a id="id"></a> `id` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L4) |
| <a id="label"></a> `label` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L5) |
| <a id="options"></a> `options?` | \{ `label`: `string`; `value`: [`FormFieldValue`](#formfieldvalue); \}[] | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L24) |
| <a id="placeholder"></a> `placeholder?` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L22) |
| <a id="required"></a> `required` | `boolean` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L20) |
| <a id="type"></a> `type` | \| `"string"` \| `"text"` \| `"number"` \| `"boolean"` \| `"email"` \| `"phone"` \| `"date"` \| `"select"` \| `"multiselect"` \| `"password"` \| `"url"` \| `"image-url"` \| `"toggle"` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L6) |

***

### FormFieldValue

```ts
type FormFieldValue = string | number | boolean | null | undefined | string[];
```

Defined in: [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L1)

***

### FormSection

```ts
type FormSection = {
  completed: boolean;
  description?: string;
  fields: FormField[];
  id: string;
  label: string;
};
```

Defined in: [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L27)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="completed"></a> `completed` | `boolean` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L32) |
| <a id="description-1"></a> `description?` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:30](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L30) |
| <a id="fields"></a> `fields` | [`FormField`](#formfield)[] | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L31) |
| <a id="id-1"></a> `id` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L28) |
| <a id="label-1"></a> `label` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:29](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L29) |

***

### ProfileFormData

```ts
type ProfileFormData = {
  fieldId: string;
  sectionId: string;
  value: FormFieldValue;
}[];
```

Defined in: [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L35)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `fieldId` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L35) |
| `sectionId` | `string` | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L35) |
| `value` | [`FormFieldValue`](#formfieldvalue) | [supertokens-plugins/packages/progressive-profiling-shared/src/types.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/progressive-profiling-shared/src/types.ts#L35) |

# References - Plugins -  `@supertokens-plugins/tenant-discovery-nodejs`
Source: https://supertokens.com/docs/references/plugins/tenant-discovery-nodejs

## Type Aliases

### MinimalTenantDetails

```ts
type MinimalTenantDetails = {
  displayName: string;
  tenantId: string;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L13)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="displayname"></a> `displayName` | `string` | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L15) |
| <a id="tenantid"></a> `tenantId` | `string` | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L14) |

***

### OverrideableTenantFunctionImplementation

```ts
type OverrideableTenantFunctionImplementation = {
  getTenantIdFromEmail: (email: string) => Promise<string>;
  getTenants: (userContext?: UserContext) => Promise<MinimalTenantDetails[]>;
  isRestrictedEmailDomain: (emailDomain: string) => boolean;
  isTenantAllowedForEmail: (email: string, tenantId: string) => boolean;
  isValidTenant: (tenantId: string, userContext?: UserContext) => Promise<boolean>;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L18)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="gettenantidfromemail"></a> `getTenantIdFromEmail` | (`email`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L19) |
| <a id="gettenants"></a> `getTenants` | (`userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`MinimalTenantDetails`](#minimaltenantdetails)[]\> | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L20) |
| <a id="isrestrictedemaildomain"></a> `isRestrictedEmailDomain` | (`emailDomain`: `string`) => `boolean` | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L22) |
| <a id="istenantallowedforemail"></a> `isTenantAllowedForEmail` | (`email`: `string`, `tenantId`: `string`) => `boolean` | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L23) |
| <a id="isvalidtenant"></a> `isValidTenant` | (`tenantId`: `string`, `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L21) |

***

### SuperTokensPluginTenantDiscoveryPluginConfig

```ts
type SuperTokensPluginTenantDiscoveryPluginConfig = {
  enableTenantListAPI?: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L3)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="enabletenantlistapi"></a> `enableTenantListAPI?` | `boolean` | Option to opt-in for the tenant selector dropdown | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L5) |

***

### SuperTokensPluginTenantDiscoveryPluginNormalisedConfig

```ts
type SuperTokensPluginTenantDiscoveryPluginNormalisedConfig = {
  enableTenantListAPI: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L8)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="enabletenantlistapi-1"></a> `enableTenantListAPI` | `boolean` | Option to opt-in for the tenant selector dropdown | [supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/types.ts#L10) |

## Variables

### default

```ts
default: {
  init: any;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/index.ts#L4)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/tenant-discovery-nodejs/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/index.ts#L4) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/logger.ts#L4)

***

### HANDLE\_BASE\_PATH

```ts
const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-tenant-discovery";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/constants.ts#L6)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/plugin.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/plugin.ts#L14)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/logger.ts#L4)

***

### PLUGIN\_ERROR\_NAME

```ts
const PLUGIN_ERROR_NAME: "supertokens-plugin-tenant-discovery-error";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/constants.ts#L8)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-tenant-discovery" = "supertokens-plugin-tenant-discovery";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/constants.ts#L1)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: string[];
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/constants.ts#L4)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/constants.ts#L2)

***

### POPULAR\_EMAIL\_DOMAINS

```ts
const POPULAR_EMAIL_DOMAINS: string[];
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/constants.ts#L16)

This is a list of popular email domains that we do not allow
to be used in email domain to tenant ID map.

This list contains the top 20 most used email domains
from this list:
https://email-verify.my-addr.com/list-of-most-popular-email-domains.php

## Functions

### getOverrideableTenantFunctionImplementation()

```ts
function getOverrideableTenantFunctionImplementation(): OverrideableTenantFunctionImplementation;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-nodejs/src/pluginImplementation.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-nodejs/src/pluginImplementation.ts#L6)

#### Returns

[`OverrideableTenantFunctionImplementation`](#overrideabletenantfunctionimplementation)

# References - Plugins -  `@supertokens-plugins/tenant-discovery-react`
Source: https://supertokens.com/docs/references/plugins/tenant-discovery-react

## Interfaces

### TenantDetails

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L32)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="displayname"></a> `displayName` | `string` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L34) |
| <a id="tenantid"></a> `tenantId` | `string` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:33](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L33) |

***

### TenantList

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L37)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="tenants"></a> `tenants` | [`TenantDetails`](#tenantdetails)[] | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L38) |

## Type Aliases

### FromEmailReturnType

```ts
type FromEmailReturnType = 
  | {
  status: "OK";
  tenant: string;
}
  | {
  message: string;
  status: "NOT_ALLOWED";
}
  | {
  message: string;
  status: "ERROR";
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L17)

***

### OverrideableTenantFunctionImplementation

```ts
type OverrideableTenantFunctionImplementation = {
  determineTenantFromSubdomain: () => string | undefined;
  determineTenantFromURL: () => Promise<string | undefined>;
  getEmailId: () => string | undefined;
  getTenantIdFromQuery: () => string | undefined;
  parseTenantId: () => ParseTenantIdReturnType;
  removeEmailId: () => void;
  setEmailId: (emailId: string) => void;
  setTenantId: (tenantId: string) => void;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L21)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="determinetenantfromsubdomain"></a> `determineTenantFromSubdomain` | () => `string` \| `undefined` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L24) |
| <a id="determinetenantfromurl"></a> `determineTenantFromURL` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string` \| `undefined`\> | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L23) |
| <a id="getemailid"></a> `getEmailId` | () => `string` \| `undefined` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L27) |
| <a id="gettenantidfromquery"></a> `getTenantIdFromQuery` | () => `string` \| `undefined` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:29](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L29) |
| <a id="parsetenantid"></a> `parseTenantId` | () => [`ParseTenantIdReturnType`](#parsetenantidreturntype) | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L25) |
| <a id="removeemailid"></a> `removeEmailId` | () => `void` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L28) |
| <a id="setemailid"></a> `setEmailId` | (`emailId`: `string`) => `void` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:26](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L26) |
| <a id="settenantid"></a> `setTenantId` | (`tenantId`: `string`) => `void` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L22) |

***

### ParseTenantIdReturnType

```ts
type ParseTenantIdReturnType = 
  | {
  doTenantDiscovery: false;
  tenantId: string;
}
  | {
  doTenantDiscovery: true;
  tenantId: null;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L13)

***

### SuperTokensPluginTenantDiscoveryPluginConfig

```ts
type SuperTokensPluginTenantDiscoveryPluginConfig = {
  extractTenantIdFromDomain?: boolean;
  showTenantSelector?: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L3)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="extracttenantidfromdomain"></a> `extractTenantIdFromDomain?` | `boolean` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L5) |
| <a id="showtenantselector"></a> `showTenantSelector?` | `boolean` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L4) |

***

### SuperTokensPluginTenantDiscoveryPluginNormalisedConfig

```ts
type SuperTokensPluginTenantDiscoveryPluginNormalisedConfig = {
  extractTenantIdFromDomain?: boolean;
  showTenantSelector?: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L8)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="extracttenantidfromdomain-1"></a> `extractTenantIdFromDomain?` | `boolean` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L10) |
| <a id="showtenantselector-1"></a> `showTenantSelector?` | `boolean` | [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L9) |

***

### TranslationKeys

```ts
type TranslationKeys = keyof typeof defaultTranslationsTenantDiscovery["en"];
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/types.ts:41](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/types.ts#L41)

## Variables

### API\_PATH

```ts
const API_PATH: "plugin/supertokens-plugin-tenant-discovery";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/constants.ts#L3)

***

### default

```ts
default: {
  init: any;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/index.ts#L4)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/tenant-discovery-react/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/index.ts#L4) |

***

### defaultTranslationsTenantDiscovery

```ts
const defaultTranslationsTenantDiscovery: {
  en: {
     PL_TD_AVAILABLE_TENANTS: "Available Tenants";
     PL_TD_DEFAULT_OPTION: "-- Select a tenant --";
     PL_TD_EMAIL_DISCOVERY_CONTINUE_BUTTON: "CONTINUE";
     PL_TD_EMAIL_DISCOVERY_HEADER_TEXT: "Enter email to continue";
     PL_TD_LOADING: "Loading...";
     PL_TD_NO_TENANT_AVAILABLE: "No tenants available";
     PL_TD_SELECT_TENANT_HEADING: "Select Tenant";
     PL_TD_SELECT_TENANT_SUBHEADING: "Choose a tenant to continue";
  };
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L1)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="en"></a> `en` | \{ `PL_TD_AVAILABLE_TENANTS`: `"Available Tenants"`; `PL_TD_DEFAULT_OPTION`: `"-- Select a tenant --"`; `PL_TD_EMAIL_DISCOVERY_CONTINUE_BUTTON`: `"CONTINUE"`; `PL_TD_EMAIL_DISCOVERY_HEADER_TEXT`: `"Enter email to continue"`; `PL_TD_LOADING`: `"Loading..."`; `PL_TD_NO_TENANT_AVAILABLE`: `"No tenants available"`; `PL_TD_SELECT_TENANT_HEADING`: `"Select Tenant"`; `PL_TD_SELECT_TENANT_SUBHEADING`: `"Choose a tenant to continue"`; \} | - | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L2) |
| `en.PL_TD_AVAILABLE_TENANTS` | `"Available Tenants"` | `"Available Tenants"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L7) |
| `en.PL_TD_DEFAULT_OPTION` | `"-- Select a tenant --"` | `"-- Select a tenant --"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L9) |
| `en.PL_TD_EMAIL_DISCOVERY_CONTINUE_BUTTON` | `"CONTINUE"` | `"CONTINUE"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L3) |
| `en.PL_TD_EMAIL_DISCOVERY_HEADER_TEXT` | `"Enter email to continue"` | `"Enter email to continue"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L10) |
| `en.PL_TD_LOADING` | `"Loading..."` | `"Loading..."` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L4) |
| `en.PL_TD_NO_TENANT_AVAILABLE` | `"No tenants available"` | `"No tenants available"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L8) |
| `en.PL_TD_SELECT_TENANT_HEADING` | `"Select Tenant"` | `"Select Tenant"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L5) |
| `en.PL_TD_SELECT_TENANT_SUBHEADING` | `"Choose a tenant to continue"` | `"Choose a tenant to continue"` | [supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/translations.ts#L6) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/logger.ts#L5)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/plugin.tsx:40](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/plugin.tsx#L40)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/logger.ts#L5)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-tenant-discovery" = "supertokens-plugin-tenant-discovery";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/constants.ts#L1)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/constants.ts#L2)

***

### ST\_EMAIL\_VALUE\_STORAGE\_KEY

```ts
const ST_EMAIL_VALUE_STORAGE_KEY: "supertokens--email-input-value" = "supertokens--email-input-value";
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/constants.ts#L5)

***

### usePluginContext

```ts
usePluginContext: any;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/plugin.tsx:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/plugin.tsx#L28)

## Functions

### getApi()

```ts
function getApi(querier: any): {
  fetchTenants: () => Promise<any>;
  tenantIdFromEmail: (email: string) => Promise<any>;
};
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/api.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/api.ts#L5)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `querier` | `any` |

#### Returns

```ts
{
  fetchTenants: () => Promise<any>;
  tenantIdFromEmail: (email: string) => Promise<any>;
}
```

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `fetchTenants()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/tenant-discovery-react/src/api.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/api.ts#L32) |
| `tenantIdFromEmail()` | (`email`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/tenant-discovery-react/src/api.ts:33](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/api.ts#L33) |

***

### getOverrideableTenantFunctionImplementation()

```ts
function getOverrideableTenantFunctionImplementation(config: SuperTokensPluginTenantDiscoveryPluginConfig): OverrideableTenantFunctionImplementation;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/pluginImplementation.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/pluginImplementation.ts#L11)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensPluginTenantDiscoveryPluginConfig`](#supertokensplugintenantdiscoverypluginconfig) |

#### Returns

[`OverrideableTenantFunctionImplementation`](#overrideabletenantfunctionimplementation)

***

### populateEmailFromStorage()

```ts
function populateEmailFromStorage(implementation: OverrideableTenantFunctionImplementation): void;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/util.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/util.ts#L31)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `implementation` | [`OverrideableTenantFunctionImplementation`](#overrideabletenantfunctionimplementation) |

#### Returns

`void`

***

### SelectTenantPage()

```ts
function SelectTenantPage(): Element;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/pages/SelectTenantPage.tsx:163](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/pages/SelectTenantPage.tsx#L163)

#### Returns

`Element`

***

### setInputValue()

```ts
function setInputValue(input: HTMLInputElement, val: string): void;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/util.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/util.ts#L4)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement) |
| `val` | `string` |

#### Returns

`void`

***

### updateSignInSubmitBtn()

```ts
function updateSignInSubmitBtn(btnText: string): void;
```

Defined in: [supertokens-plugins/packages/tenant-discovery-react/src/util.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenant-discovery-react/src/util.ts#L13)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `btnText` | `string` |

#### Returns

`void`

# References - Plugins -  `@supertokens-plugins/tenants-nodejs`
Source: https://supertokens.com/docs/references/plugins/tenants-nodejs

## Classes

### DefaultPluginEmailService

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/defaultEmailService.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/defaultEmailService.ts#L7)

Default email service that provides template generation but throws on send

#### Implements

- `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>

#### Constructors

##### Constructor

```ts
new DefaultPluginEmailService(): DefaultPluginEmailService;
```

###### Returns

[`DefaultPluginEmailService`](#defaultpluginemailservice)

#### Methods

##### generateEmailContent()

```ts
generateEmailContent(input: PluginEmailDeliveryInput): {
  html: string;
  subject: string;
  text: string;
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/defaultEmailService.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/defaultEmailService.ts#L9)

Public method to generate email content - can be used in overrides

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`PluginEmailDeliveryInput`](#pluginemaildeliveryinput) |

###### Returns

```ts
{
  html: string;
  subject: string;
  text: string;
}
```

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `html` | `string` | [supertokens-plugins/packages/tenants-nodejs/src/defaultEmailService.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/defaultEmailService.ts#L14) |
| `subject` | `string` | [supertokens-plugins/packages/tenants-nodejs/src/defaultEmailService.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/defaultEmailService.ts#L13) |
| `text` | `string` | [supertokens-plugins/packages/tenants-nodejs/src/defaultEmailService.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/defaultEmailService.ts#L37) |

##### sendEmail()

```ts
sendEmail(input: PluginEmailDeliveryInput & {
  userContext: UserContext;
}): Promise<never>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/defaultEmailService.ts:76](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/defaultEmailService.ts#L76)

eslint-disable-next-line @typescript-eslint/no-unused-vars

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`PluginEmailDeliveryInput`](#pluginemaildeliveryinput) & \{ `userContext`: `UserContext`; \} |

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`never`\>

###### Implementation of

```ts
EmailDeliveryInterface.sendEmail
```

***

### PluginSMTPService

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/emailServices.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/emailServices.ts#L7)

#### Implements

- `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>

#### Constructors

##### Constructor

```ts
new PluginSMTPService(config: {
  smtpSettings: {
     authUsername?: string;
     from: {
        email: string;
        name: string;
     };
     host: string;
     password: string;
     port: number;
     secure?: boolean;
  };
}): PluginSMTPService;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/emailServices.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/emailServices.ts#L11)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | \{ `smtpSettings`: \{ `authUsername?`: `string`; `from`: \{ `email`: `string`; `name`: `string`; \}; `host`: `string`; `password`: `string`; `port`: `number`; `secure?`: `boolean`; \}; \} |
| `config.smtpSettings` | \{ `authUsername?`: `string`; `from`: \{ `email`: `string`; `name`: `string`; \}; `host`: `string`; `password`: `string`; `port`: `number`; `secure?`: `boolean`; \} |
| `config.smtpSettings.authUsername?` | `string` |
| `config.smtpSettings.from` | \{ `email`: `string`; `name`: `string`; \} |
| `config.smtpSettings.from.email` | `string` |
| `config.smtpSettings.from.name` | `string` |
| `config.smtpSettings.host` | `string` |
| `config.smtpSettings.password` | `string` |
| `config.smtpSettings.port` | `number` |
| `config.smtpSettings.secure?` | `boolean` |

###### Returns

[`PluginSMTPService`](#pluginsmtpservice)

#### Methods

##### sendEmail()

```ts
sendEmail(input: PluginEmailDeliveryInput & {
  userContext: UserContext;
}): Promise<void>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/emailServices.ts:33](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/emailServices.ts#L33)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`PluginEmailDeliveryInput`](#pluginemaildeliveryinput) & \{ `userContext`: `UserContext`; \} |

###### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

###### Implementation of

```ts
EmailDeliveryInterface.sendEmail
```

## Type Aliases

### AssociateAllLoginMethodsOfUserWithTenant()

```ts
type AssociateAllLoginMethodsOfUserWithTenant = (tenantId: string, userId: string, loginMethodFilter?: (loginMethod: LoginMethod) => boolean) => Promise<void>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:77](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L77)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `loginMethodFilter?` | (`loginMethod`: `LoginMethod`) => `boolean` |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### ErrorResponse

```ts
type ErrorResponse = {
  message: string;
  status: "ERROR";
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L16)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="message"></a> `message` | `string` | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L18) |
| <a id="status"></a> `status` | `"ERROR"` | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L17) |

***

### GetAppUrl()

```ts
type GetAppUrl = (appInfo: NormalisedAppinfo, request: BaseRequest | undefined, userContext: UserContext) => string;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:85](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L85)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `appInfo` | `NormalisedAppinfo` |
| `request` | `BaseRequest` \| `undefined` |
| `userContext` | `UserContext` |

#### Returns

`string`

***

### GetUserIdsInTenantWithRole()

```ts
type GetUserIdsInTenantWithRole = (tenantId: string, role: string) => Promise<string[]>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:83](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L83)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `role` | `string` |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`[]\>

***

### MetadataType

```ts
type MetadataType = ReturnType<typeof BaseFormSection>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L21)

***

### OverrideableTenantFunctionImplementation

```ts
type OverrideableTenantFunctionImplementation = {
  acceptInvitation: (code: string, tenantId: string, session: SessionContainerInterface, metadata: MetadataType) => Promise<
     | {
     status: "OK";
   }
    | ErrorResponse>;
  acceptTenantCreationRequest: (requestId: string, session: SessionContainerInterface, metadata: TenantCreationRequestMetadataType) => Promise<
     | {
     status: "OK";
   }
    | ErrorResponse>;
  addInvitation: (email: string, tenantId: string, role: string, metadata: MetadataType) => Promise<
     | {
     code: string;
     status: "OK";
   }
    | ErrorResponse>;
  addTenantCreationRequest: (session: SessionContainerInterface, tenantDetails: {
     firstFactors?: string[] | null;
     name: string;
   }, metadata: TenantCreationRequestMetadataType, appUrl: string, userContext: UserContext, sendEmail: SendPluginEmail) => Promise<
     | {
     status: "OK";
   }
    | ErrorResponse>;
  assignRoleToUserInTenant: (tenantId: string, userId: string, role: string) => Promise<void>;
  associateAllLoginMethodsOfUserWithTenant: AssociateAllLoginMethodsOfUserWithTenant;
  canApproveJoinRequest: (targetUser: User, tenantId: string, session: SessionContainerInterface) => Promise<boolean>;
  canApproveTenantCreationRequest: (targetUser: User, creationRequest: BaseFormSection, session: SessionContainerInterface) => Promise<boolean>;
  canCreateInvitation: (email: string, role: string, tenantId: string, session: SessionContainerInterface) => Promise<boolean>;
  canRemoveTargetUserFromTenant: (targetUser: User, tenantId: string, session: SessionContainerInterface) => Promise<boolean>;
  createTenantAndAssignAdmin: (tenantDetails: {
     firstFactors?: string[] | null;
     name: string;
   }, userId: string) => Promise<
     | {
     createdNew: boolean;
     status: "OK";
   }
    | ErrorResponse>;
  doesTenantCreationRequireApproval: (session: SessionContainerInterface) => Promise<boolean>;
  doesUserHaveTenantCreationRequest: (userId: string, metadata: TenantCreationRequestMetadataType) => Promise<boolean>;
  getAppUrl: GetAppUrl;
  getInvitations: (tenantId: string, metadata: MetadataType) => Promise<
     | {
     invitees: BaseFormSection[];
     status: "OK";
   }
    | ErrorResponse>;
  getPreferredTenantId: (tenantIds: string[], inputTenantId: string) => string | undefined;
  getTenantCreationRequests: (metadata: TenantCreationRequestMetadataType, userContext: UserContext) => Promise<
     | {
     status: "OK";
   } & {
     requests: BaseFormSection[];
   }
    | ErrorResponse>;
  getTenants: (session: SessionContainerInterface | string) => Promise<
     | {
     status: "OK";
   } & BaseFormSection
    | ErrorResponse>;
  getTenantUsers: (tenantId: string) => Promise<
     | {
     status: "OK";
     users: User & {
        roles?: string[];
     }[];
   }
    | ErrorResponse>;
  isAllowedToCreateTenant: (session: SessionContainerInterface) => Promise<boolean>;
  isAllowedToJoinTenant: (targetUser: User, session: SessionContainerInterface) => Promise<boolean>;
  rejectRequestToJoinTenant: (tenantId: string, userId: string) => Promise<
     | {
     status: "OK";
   }
    | ErrorResponse>;
  rejectTenantCreationRequest: (requestId: string, session: SessionContainerInterface, metadata: TenantCreationRequestMetadataType) => Promise<
     | {
     status: "OK";
   }
    | ErrorResponse>;
  removeInvitation: (email: string, tenantId: string, metadata: MetadataType) => Promise<
     | {
     status: "OK";
   }
    | ErrorResponse>;
  sendTenantCreationRequestEmail: (tenantId: string, creatorEmail: string, appUrl: string, userContext: UserContext, sendEmail: SendPluginEmail) => Promise<void>;
  shouldHaveTenantAccess: (userId: string, tenantId: string, userContext: UserContext) => Promise<{
     canAccess: boolean;
     reason?: string;
  }>;
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:91](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L91)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="acceptinvitation"></a> `acceptInvitation` | (`code`: `string`, `tenantId`: `string`, `session`: `SessionContainerInterface`, `metadata`: [`MetadataType`](#metadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:134](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L134) |
| <a id="accepttenantcreationrequest"></a> `acceptTenantCreationRequest` | (`requestId`: `string`, `session`: `SessionContainerInterface`, `metadata`: [`TenantCreationRequestMetadataType`](#tenantcreationrequestmetadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:160](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L160) |
| <a id="addinvitation"></a> `addInvitation` | (`email`: `string`, `tenantId`: `string`, `role`: `string`, `metadata`: [`MetadataType`](#metadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `code`: `string`; `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:123](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L123) |
| <a id="addtenantcreationrequest"></a> `addTenantCreationRequest` | (`session`: `SessionContainerInterface`, `tenantDetails`: \{ `firstFactors?`: `string`[] \| `null`; `name`: `string`; \}, `metadata`: [`TenantCreationRequestMetadataType`](#tenantcreationrequestmetadatatype), `appUrl`: `string`, `userContext`: `UserContext`, `sendEmail`: [`SendPluginEmail`](#sendpluginemail)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:145](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L145) |
| <a id="assignroletouserintenant"></a> `assignRoleToUserInTenant` | (`tenantId`: `string`, `userId`: `string`, `role`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:181](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L181) |
| <a id="associateallloginmethodsofuserwithtenant-1"></a> `associateAllLoginMethodsOfUserWithTenant` | [`AssociateAllLoginMethodsOfUserWithTenant`](#associateallloginmethodsofuserwithtenant) | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:144](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L144) |
| <a id="canapprovejoinrequest"></a> `canApproveJoinRequest` | (`targetUser`: `User`, `tenantId`: `string`, `session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:102](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L102) |
| <a id="canapprovetenantcreationrequest"></a> `canApproveTenantCreationRequest` | (`targetUser`: `User`, `creationRequest`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection), `session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:103](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L103) |
| <a id="cancreateinvitation"></a> `canCreateInvitation` | (`email`: `string`, `role`: `string`, `tenantId`: `string`, `session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:96](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L96) |
| <a id="canremovetargetuserfromtenant"></a> `canRemoveTargetUserFromTenant` | (`targetUser`: `User`, `tenantId`: `string`, `session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:108](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L108) |
| <a id="createtenantandassignadmin"></a> `createTenantAndAssignAdmin` | (`tenantDetails`: \{ `firstFactors?`: `string`[] \| `null`; `name`: `string`; \}, `userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `createdNew`: `boolean`; `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:113](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L113) |
| <a id="doestenantcreationrequireapproval"></a> `doesTenantCreationRequireApproval` | (`session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:95](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L95) |
| <a id="doesuserhavetenantcreationrequest"></a> `doesUserHaveTenantCreationRequest` | (`userId`: `string`, `metadata`: [`TenantCreationRequestMetadataType`](#tenantcreationrequestmetadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:179](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L179) |
| <a id="getappurl-1"></a> `getAppUrl` | [`GetAppUrl`](#getappurl) | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:177](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L177) |
| <a id="getinvitations"></a> `getInvitations` | (`tenantId`: `string`, `metadata`: [`MetadataType`](#metadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `invitees`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)[]; `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:140](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L140) |
| <a id="getpreferredtenantid"></a> `getPreferredTenantId` | (`tenantIds`: `string`[], `inputTenantId`: `string`) => `string` \| `undefined` | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:180](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L180) |
| <a id="gettenantcreationrequests"></a> `getTenantCreationRequests` | (`metadata`: [`TenantCreationRequestMetadataType`](#tenantcreationrequestmetadatatype), `userContext`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} & \{ `requests`: [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)[]; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:156](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L156) |
| <a id="gettenants"></a> `getTenants` | (`session`: `SessionContainerInterface` \| `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} & [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection) \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:92](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L92) |
| <a id="gettenantusers"></a> `getTenantUsers` | (`tenantId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; `users`: `User` & \{ `roles?`: `string`[]; \}[]; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:120](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L120) |
| <a id="isallowedtocreatetenant"></a> `isAllowedToCreateTenant` | (`session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:94](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L94) |
| <a id="isallowedtojointenant"></a> `isAllowedToJoinTenant` | (`targetUser`: `User`, `session`: `SessionContainerInterface`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:93](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L93) |
| <a id="rejectrequesttojointenant"></a> `rejectRequestToJoinTenant` | (`tenantId`: `string`, `userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:178](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L178) |
| <a id="rejecttenantcreationrequest"></a> `rejectTenantCreationRequest` | (`requestId`: `string`, `session`: `SessionContainerInterface`, `metadata`: [`TenantCreationRequestMetadataType`](#tenantcreationrequestmetadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:165](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L165) |
| <a id="removeinvitation"></a> `removeInvitation` | (`email`: `string`, `tenantId`: `string`, `metadata`: [`MetadataType`](#metadatatype)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| [`ErrorResponse`](#errorresponse)\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:129](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L129) |
| <a id="sendtenantcreationrequestemail"></a> `sendTenantCreationRequestEmail` | (`tenantId`: `string`, `creatorEmail`: `string`, `appUrl`: `string`, `userContext`: `UserContext`, `sendEmail`: [`SendPluginEmail`](#sendpluginemail)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:170](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L170) |
| <a id="shouldhavetenantaccess"></a> `shouldHaveTenantAccess` | (`userId`: `string`, `tenantId`: `string`, `userContext`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ `canAccess`: `boolean`; `reason?`: `string`; \}\> | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:182](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L182) |

***

### PluginEmailDeliveryInput

```ts
type PluginEmailDeliveryInput = 
  | {
  appUrl: string;
  customData?: Record<string, any>;
  email: string;
  senderEmail: string;
  tenantId: string;
  type: "TENANT_REQUEST_APPROVAL";
}
  | {
  appUrl: string;
  creatorEmail: string;
  customData?: Record<string, any>;
  email: string;
  tenantId: string;
  type: "TENANT_CREATE_APPROVAL";
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L25)

Define custom email input type for the plugin

***

### SendPluginEmail()

```ts
type SendPluginEmail = (input: PluginEmailDeliveryInput, userContext: UserContext) => Promise<void>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:75](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L75)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`PluginEmailDeliveryInput`](#pluginemaildeliveryinput) |
| `userContext` | `UserContext` |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### SuperTokensPluginTenantPluginConfig

```ts
type SuperTokensPluginTenantPluginConfig = {
  allowPublicTenantAccess?: boolean;
  createRolesOnInit?: boolean;
  emailDelivery?: {
     override?: (originalImplementation: EmailDeliveryInterface<PluginEmailDeliveryInput>) => EmailDeliveryInterface<PluginEmailDeliveryInput>;
     service?: EmailDeliveryInterface<PluginEmailDeliveryInput>;
  };
  enableTenantListAPI?: boolean;
  requireNonPublicTenantAssociation?: boolean;
  requireTenantCreationRequestApproval?: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:43](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L43)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="allowpublictenantaccess"></a> `allowPublicTenantAccess?` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:48](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L48) |
| <a id="createrolesoninit"></a> `createRolesOnInit?` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:47](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L47) |
| <a id="emaildelivery"></a> `emailDelivery?` | \{ `override?`: (`originalImplementation`: `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>) => `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>; `service?`: `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>; \} | Email delivery configuration - service is optional, override can provide sendEmail implementation | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:51](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L51) |
| `emailDelivery.override?` | (`originalImplementation`: `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>) => `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\> | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:53](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L53) |
| `emailDelivery.service?` | `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\> | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:52](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L52) |
| <a id="enabletenantlistapi"></a> `enableTenantListAPI?` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:46](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L46) |
| <a id="requirenonpublictenantassociation"></a> `requireNonPublicTenantAssociation?` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:44](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L44) |
| <a id="requiretenantcreationrequestapproval"></a> `requireTenantCreationRequestApproval?` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:45](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L45) |

***

### SuperTokensPluginTenantPluginNormalisedConfig

```ts
type SuperTokensPluginTenantPluginNormalisedConfig = {
  allowPublicTenantAccess: boolean;
  createRolesOnInit: boolean;
  emailDelivery?: {
     override?: (originalImplementation: EmailDeliveryInterface<PluginEmailDeliveryInput>) => EmailDeliveryInterface<PluginEmailDeliveryInput>;
     service?: EmailDeliveryInterface<PluginEmailDeliveryInput>;
  };
  enableTenantListAPI: boolean;
  requireNonPublicTenantAssociation: boolean;
  requireTenantCreationRequestApproval: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:59](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L59)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="allowpublictenantaccess-1"></a> `allowPublicTenantAccess` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:64](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L64) |
| <a id="createrolesoninit-1"></a> `createRolesOnInit` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:63](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L63) |
| <a id="emaildelivery-1"></a> `emailDelivery?` | \{ `override?`: (`originalImplementation`: `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>) => `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>; `service?`: `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>; \} | Email delivery configuration - service is optional, override can provide sendEmail implementation | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:67](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L67) |
| `emailDelivery.override?` | (`originalImplementation`: `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\>) => `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\> | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:69](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L69) |
| `emailDelivery.service?` | `EmailDeliveryInterface`\<[`PluginEmailDeliveryInput`](#pluginemaildeliveryinput)\> | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:68](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L68) |
| <a id="enabletenantlistapi-1"></a> `enableTenantListAPI` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:62](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L62) |
| <a id="requirenonpublictenantassociation-1"></a> `requireNonPublicTenantAssociation` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:60](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L60) |
| <a id="requiretenantcreationrequestapproval-1"></a> `requireTenantCreationRequestApproval` | `boolean` | - | [supertokens-plugins/packages/tenants-nodejs/src/types.ts:61](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L61) |

***

### TenantCreationRequestMetadataType

```ts
type TenantCreationRequestMetadataType = ReturnType<typeof BaseFormSection>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/types.ts:22](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/types.ts#L22)

## Variables

### default

```ts
default: {
  init: any;
  SMTPService: typeof PluginSMTPService;
};
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/index.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/index.ts#L19)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | - | [supertokens-plugins/packages/tenants-nodejs/src/index.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/index.ts#L20) |
| <a id="smtpservice"></a> `SMTPService` | *typeof* [`PluginSMTPService`](#pluginsmtpservice) | `PluginSMTPService` | [supertokens-plugins/packages/tenants-nodejs/src/index.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/index.ts#L21) |

***

### getUserIdsInTenantWithRole

```ts
const getUserIdsInTenantWithRole: GetUserIdsInTenantWithRole;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/roles.ts:64](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/roles.ts#L64)

***

### HANDLE\_BASE\_PATH

```ts
const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-tenants";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L6)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/plugin.ts:36](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/plugin.ts#L36)

***

### METADATA\_KEY

```ts
const METADATA_KEY: "supertokens-plugin-tenants";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L10)

***

### PLUGIN\_ERROR\_NAME

```ts
const PLUGIN_ERROR_NAME: "supertokens-plugin-tenants-error";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L8)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-tenants" = "supertokens-plugin-tenants";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L1)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: string[];
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L4)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L2)

***

### TENANT\_CREATE\_METADATA\_KEY

```ts
const TENANT_CREATE_METADATA_KEY: "supertokens-plugin-tenants-tenant-create-requests";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L11)

***

### TENANT\_CREATE\_METADATA\_REQUESTS\_KEY

```ts
const TENANT_CREATE_METADATA_REQUESTS_KEY: "requests" = "requests";
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/constants.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/constants.ts#L12)

## Functions

### assignAdminToUserInTenant()

```ts
function assignAdminToUserInTenant(tenantId: string, userId: string): Promise<void>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/roles.ts:51](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/roles.ts#L51)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### assignRoleToUserInTenant()

```ts
function assignRoleToUserInTenant(
   tenantId: string, 
   userId: string, 
role: string): Promise<void>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/roles.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/roles.ts#L31)

Default definition of `assignRoleToUserInTenant` to be exported
to be usable without having to initialize the plugin.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `role` | `string` |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### createRoles()

```ts
function createRoles(): Promise<void>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/roles.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/roles.ts#L7)

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

***

### extractInvitationCodeAndTenantId()

```ts
function extractInvitationCodeAndTenantId(req: BaseRequest): Promise<{
  code: any;
  shouldAcceptInvite: boolean;
  tenantId: any;
}>;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/util.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/util.ts#L19)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `req` | `BaseRequest` |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{
  `code`: `any`;
  `shouldAcceptInvite`: `boolean`;
  `tenantId`: `any`;
\}\>

***

### getOverrideableTenantFunctionImplementation()

```ts
function getOverrideableTenantFunctionImplementation(pluginConfig: SuperTokensPluginTenantPluginConfig): OverrideableTenantFunctionImplementation;
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/pluginImplementation.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/pluginImplementation.ts#L32)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `pluginConfig` | [`SuperTokensPluginTenantPluginConfig`](#supertokensplugintenantpluginconfig) |

#### Returns

[`OverrideableTenantFunctionImplementation`](#overrideabletenantfunctionimplementation)

***

### hasPermissions()

```ts
function hasPermissions(permissions: string[]): (globalValidators: SessionClaimValidator[]) => SessionClaimValidator[];
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/util.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/util.ts#L12)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permissions` | `string`[] |

#### Returns

```ts
(globalValidators: SessionClaimValidator[]): SessionClaimValidator[];
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `globalValidators` | `SessionClaimValidator`[] |

##### Returns

`SessionClaimValidator`[]

***

### validateWithoutClaims()

```ts
function validateWithoutClaims(keys: string[]): (existingValidators: SessionClaimValidator[]) => SessionClaimValidator[];
```

Defined in: [supertokens-plugins/packages/tenants-nodejs/src/util.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-nodejs/src/util.ts#L5)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `keys` | `string`[] |

#### Returns

```ts
(existingValidators: SessionClaimValidator[]): SessionClaimValidator[];
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `existingValidators` | `SessionClaimValidator`[] |

##### Returns

`SessionClaimValidator`[]

# References - Plugins -  `@supertokens-plugins/tentants-react`
Source: https://supertokens.com/docs/references/plugins/tenants-react

## Type Aliases

### AddInvitationProps

```ts
type AddInvitationProps = {
  onCreate: (email: string, role: string) => Promise<void>;
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/AddInvitation.tsx:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/AddInvitation.tsx#L12)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="oncreate"></a> `onCreate` | (`email`: `string`, `role`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/tenants-react/src/components/invitations/AddInvitation.tsx:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/AddInvitation.tsx#L13) |

***

### InvitedUsersProps

```ts
type InvitedUsersProps = {
  invitations: BaseFormSection[];
  onRemove: (email: string) => Promise<void>;
  tenantId: string;
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/InvitedUsers.tsx#L15)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="invitations"></a> `invitations` | [`BaseFormSection`](profile-details-nodejs.mdx#baseformsection)[] | [supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/InvitedUsers.tsx#L17) |
| <a id="onremove"></a> `onRemove` | (`email`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | [supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/InvitedUsers.tsx#L16) |
| <a id="tenantid"></a> `tenantId` | `string` | [supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/InvitedUsers.tsx#L18) |

***

### SuperTokensPluginTenantsPluginConfig

```ts
type SuperTokensPluginTenantsPluginConfig = {
  redirectToUrlOnJoiningTenant?: string | () => void;
  requireTenantCreation?: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L5)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="redirecttourlonjoiningtenant"></a> `redirectToUrlOnJoiningTenant?` | `string` \| () => `void` | [supertokens-plugins/packages/tenants-react/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L7) |
| <a id="requiretenantcreation"></a> `requireTenantCreation?` | `boolean` | [supertokens-plugins/packages/tenants-react/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L6) |

***

### SuperTokensPluginTenantsPluginNormalisedConfig

```ts
type SuperTokensPluginTenantsPluginNormalisedConfig = {
  redirectOnJoiningTenantFn: () => void;
  requireTenantCreation?: boolean;
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L10)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="redirectonjoiningtenantfn"></a> `redirectOnJoiningTenantFn` | () => `void` | [supertokens-plugins/packages/tenants-react/src/types.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L12) |
| <a id="requiretenantcreation-1"></a> `requireTenantCreation?` | `boolean` | [supertokens-plugins/packages/tenants-react/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L11) |

***

### TranslationKeys

```ts
type TranslationKeys = keyof typeof defaultTranslationsTenants["en"];
```

Defined in: [supertokens-plugins/packages/tenants-react/src/types.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L15)

***

### UserWithRole

```ts
type UserWithRole = {
  roles: string[];
} & BaseFormSection;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L17)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `roles` | `string`[] | [supertokens-plugins/packages/tenants-react/src/types.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/types.ts#L17) |

## Variables

### Action

```ts
const Action: React.FC<ActionProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/requests/Action.tsx:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/requests/Action.tsx#L15)

***

### AddInvitation

```ts
const AddInvitation: React.FC<AddInvitationProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/AddInvitation.tsx:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/AddInvitation.tsx#L16)

***

### API\_PATH

```ts
const API_PATH: "plugin/supertokens-plugin-tenants";
```

Defined in: [supertokens-plugins/packages/tenants-react/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/constants.ts#L3)

***

### AwaitingApprovalMessage

```ts
const AwaitingApprovalMessage: React.FC<AwaitingApprovalMessageProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/tenant-card/awaiting-approval.tsx:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/tenant-card/awaiting-approval.tsx#L15)

***

### Code

```ts
const Code: React.FC<CodeProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/Code.tsx:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/Code.tsx#L18)

***

### Copy

```ts
const Copy: React.FC<CopyProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/icons/Copy.tsx:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/icons/Copy.tsx#L7)

***

### default

```ts
default: {
  init: any;
  PLUGIN_ID: string;
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/index.ts#L5)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/tenants-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/index.ts#L5) |
| <a id="plugin_id"></a> `PLUGIN_ID` | `string` | [supertokens-plugins/packages/tenants-react/src/index.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/index.ts#L5) |

***

### defaultTranslationsTenants

```ts
const defaultTranslationsTenants: {
  en: {
     PL_TB_ACCESS_BLOCKED_DESCRIPTION_MESSAGE: "You do not have enough permissions to access the tenant, please reach out to an admin if you think this is a mistake";
     PL_TB_ACCESS_BLOCKED_HEADER_MESSAGE: "You cannot access this tenant";
     PL_TB_ADD_INVITE_BUTTON_TEXT: "+ Invite";
     PL_TB_CREATE_TENANT_AWAITING_APPROVAL_HEADER: "Awaiting app admin approval";
     PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE: "It is essential to await the app administrator's approval before proceeding with the";
     PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE_HIGHLIGHT: "creation of the new tenant";
     PL_TB_CREATE_TENANT_BUTTON_TEXT: "Create and Join";
     PL_TB_CREATE_TENANT_ENTER_NAME_LABEL: "Enter name of your tenant";
     PL_TB_CREATE_TENANT_LABEL: "Create Tenant";
     PL_TB_INVITATIONS_ACCEPT_INVITATION_MESSAGE: "Accept Invitation";
     PL_TB_INVITATIONS_AUTHENTICATE_AND_ACCEPT_MESSAGE: "Authenticate and accept invitation";
     PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_POSTFIX: "tenant. Click the button below to accept the invitation.";
     PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_PREFIX: "You have been invited to join";
     PL_TB_INVITATIONS_INVALID_INVITATION_MESSAGE: "Invalid invitation";
     PL_TB_INVITATIONS_INVALID_INVITATION_REDIRECTING_TO_DASHBOARD_MESSAGE: "No invitation code found. Redirecting to dashboard...";
     PL_TB_INVITATIONS_INVITATION_CODE_LABEL: "Invitation Code: ";
     PL_TB_INVITATIONS_TAB_LABEL: "Invitations";
     PL_TB_INVITE_ACCEPT_AUTHENTICATION_HEADER_MESSAGE: "If you authenticate, invitation will be accepted automatically.";
     PL_TB_LOGOUT_TEXT: "Log Out";
     PL_TB_NO_INVITATIONS_FOUND_TEXT: "There are currently no pending invites.";
     PL_TB_NO_USERS_FOUND_TEXT: "No users have been found linked to this tenant.";
     PL_TB_REQUESTS_TAB_LABEL: "Requests";
     PL_TB_TENANT_REQUESTS_CREATION_DESCRIPTION: "List of requests to create new tenant in your app.";
     PL_TB_TENANT_REQUESTS_CREATION_TAB_LABEL: "Tenant Creation";
     PL_TB_TENANT_REQUESTS_ONBOARDING_TAB_LABEL: "Tenant Onboarding";
     PL_TB_TENANT_USERS_COMBINED_DESCRIPTION: "List of users, invitations and requests for your tenant";
     PL_TB_TENANTS_LOADING_MESSAGE: "Loading...";
     PL_TB_TENANTS_REQUESTS_ACCEPT_BUTTON_TEXT: "Accept";
     PL_TB_TENANTS_REQUESTS_DECLINE_BUTTON_TEXT: "Decline";
     PL_TB_USERS_TAB_LABEL: "Users";
     PL_TB_VIEW_CODE_TEXT: "Code";
  };
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/translations.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L1)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="en"></a> `en` | \{ `PL_TB_ACCESS_BLOCKED_DESCRIPTION_MESSAGE`: `"You do not have enough permissions to access the tenant, please reach out to an admin if you think this is a mistake"`; `PL_TB_ACCESS_BLOCKED_HEADER_MESSAGE`: `"You cannot access this tenant"`; `PL_TB_ADD_INVITE_BUTTON_TEXT`: `"+ Invite"`; `PL_TB_CREATE_TENANT_AWAITING_APPROVAL_HEADER`: `"Awaiting app admin approval"`; `PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE`: `"It is essential to await the app administrator's approval before proceeding with the"`; `PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE_HIGHLIGHT`: `"creation of the new tenant"`; `PL_TB_CREATE_TENANT_BUTTON_TEXT`: `"Create and Join"`; `PL_TB_CREATE_TENANT_ENTER_NAME_LABEL`: `"Enter name of your tenant"`; `PL_TB_CREATE_TENANT_LABEL`: `"Create Tenant"`; `PL_TB_INVITATIONS_ACCEPT_INVITATION_MESSAGE`: `"Accept Invitation"`; `PL_TB_INVITATIONS_AUTHENTICATE_AND_ACCEPT_MESSAGE`: `"Authenticate and accept invitation"`; `PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_POSTFIX`: `"tenant. Click the button below to accept the invitation."`; `PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_PREFIX`: `"You have been invited to join"`; `PL_TB_INVITATIONS_INVALID_INVITATION_MESSAGE`: `"Invalid invitation"`; `PL_TB_INVITATIONS_INVALID_INVITATION_REDIRECTING_TO_DASHBOARD_MESSAGE`: `"No invitation code found. Redirecting to dashboard..."`; `PL_TB_INVITATIONS_INVITATION_CODE_LABEL`: `"Invitation Code: "`; `PL_TB_INVITATIONS_TAB_LABEL`: `"Invitations"`; `PL_TB_INVITE_ACCEPT_AUTHENTICATION_HEADER_MESSAGE`: `"If you authenticate, invitation will be accepted automatically."`; `PL_TB_LOGOUT_TEXT`: `"Log Out"`; `PL_TB_NO_INVITATIONS_FOUND_TEXT`: `"There are currently no pending invites."`; `PL_TB_NO_USERS_FOUND_TEXT`: `"No users have been found linked to this tenant."`; `PL_TB_REQUESTS_TAB_LABEL`: `"Requests"`; `PL_TB_TENANT_REQUESTS_CREATION_DESCRIPTION`: `"List of requests to create new tenant in your app."`; `PL_TB_TENANT_REQUESTS_CREATION_TAB_LABEL`: `"Tenant Creation"`; `PL_TB_TENANT_REQUESTS_ONBOARDING_TAB_LABEL`: `"Tenant Onboarding"`; `PL_TB_TENANT_USERS_COMBINED_DESCRIPTION`: `"List of users, invitations and requests for your tenant"`; `PL_TB_TENANTS_LOADING_MESSAGE`: `"Loading..."`; `PL_TB_TENANTS_REQUESTS_ACCEPT_BUTTON_TEXT`: `"Accept"`; `PL_TB_TENANTS_REQUESTS_DECLINE_BUTTON_TEXT`: `"Decline"`; `PL_TB_USERS_TAB_LABEL`: `"Users"`; `PL_TB_VIEW_CODE_TEXT`: `"Code"`; \} | - | [supertokens-plugins/packages/tenants-react/src/translations.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L2) |
| `en.PL_TB_ACCESS_BLOCKED_DESCRIPTION_MESSAGE` | `"You do not have enough permissions to access the tenant, please reach out to an admin if you think this is a mistake"` | `"You do not have enough permissions to access the tenant, please reach out to an admin if you think this is a mistake"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:35](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L35) |
| `en.PL_TB_ACCESS_BLOCKED_HEADER_MESSAGE` | `"You cannot access this tenant"` | `"You cannot access this tenant"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L34) |
| `en.PL_TB_ADD_INVITE_BUTTON_TEXT` | `"+ Invite"` | `"+ Invite"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L8) |
| `en.PL_TB_CREATE_TENANT_AWAITING_APPROVAL_HEADER` | `"Awaiting app admin approval"` | `"Awaiting app admin approval"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L20) |
| `en.PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE` | `"It is essential to await the app administrator's approval before proceeding with the"` | `"It is essential to await the app administrator's approval before proceeding with the"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L21) |
| `en.PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE_HIGHLIGHT` | `"creation of the new tenant"` | `"creation of the new tenant"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L23) |
| `en.PL_TB_CREATE_TENANT_BUTTON_TEXT` | `"Create and Join"` | `"Create and Join"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L18) |
| `en.PL_TB_CREATE_TENANT_ENTER_NAME_LABEL` | `"Enter name of your tenant"` | `"Enter name of your tenant"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L19) |
| `en.PL_TB_CREATE_TENANT_LABEL` | `"Create Tenant"` | `"Create Tenant"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L17) |
| `en.PL_TB_INVITATIONS_ACCEPT_INVITATION_MESSAGE` | `"Accept Invitation"` | `"Accept Invitation"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:27](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L27) |
| `en.PL_TB_INVITATIONS_AUTHENTICATE_AND_ACCEPT_MESSAGE` | `"Authenticate and accept invitation"` | `"Authenticate and accept invitation"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:29](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L29) |
| `en.PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_POSTFIX` | `"tenant. Click the button below to accept the invitation."` | `"tenant. Click the button below to accept the invitation."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L31) |
| `en.PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_PREFIX` | `"You have been invited to join"` | `"You have been invited to join"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:30](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L30) |
| `en.PL_TB_INVITATIONS_INVALID_INVITATION_MESSAGE` | `"Invalid invitation"` | `"Invalid invitation"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L24) |
| `en.PL_TB_INVITATIONS_INVALID_INVITATION_REDIRECTING_TO_DASHBOARD_MESSAGE` | `"No invitation code found. Redirecting to dashboard..."` | `"No invitation code found. Redirecting to dashboard..."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L25) |
| `en.PL_TB_INVITATIONS_INVITATION_CODE_LABEL` | `"Invitation Code: "` | `"Invitation Code: "` | [supertokens-plugins/packages/tenants-react/src/translations.ts:28](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L28) |
| `en.PL_TB_INVITATIONS_TAB_LABEL` | `"Invitations"` | `"Invitations"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L4) |
| `en.PL_TB_INVITE_ACCEPT_AUTHENTICATION_HEADER_MESSAGE` | `"If you authenticate, invitation will be accepted automatically."` | `"If you authenticate, invitation will be accepted automatically."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:32](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L32) |
| `en.PL_TB_LOGOUT_TEXT` | `"Log Out"` | `"Log Out"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:37](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L37) |
| `en.PL_TB_NO_INVITATIONS_FOUND_TEXT` | `"There are currently no pending invites."` | `"There are currently no pending invites."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L7) |
| `en.PL_TB_NO_USERS_FOUND_TEXT` | `"No users have been found linked to this tenant."` | `"No users have been found linked to this tenant."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L6) |
| `en.PL_TB_REQUESTS_TAB_LABEL` | `"Requests"` | `"Requests"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L5) |
| `en.PL_TB_TENANT_REQUESTS_CREATION_DESCRIPTION` | `"List of requests to create new tenant in your app."` | `"List of requests to create new tenant in your app."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L12) |
| `en.PL_TB_TENANT_REQUESTS_CREATION_TAB_LABEL` | `"Tenant Creation"` | `"Tenant Creation"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L11) |
| `en.PL_TB_TENANT_REQUESTS_ONBOARDING_TAB_LABEL` | `"Tenant Onboarding"` | `"Tenant Onboarding"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L10) |
| `en.PL_TB_TENANT_USERS_COMBINED_DESCRIPTION` | `"List of users, invitations and requests for your tenant"` | `"List of users, invitations and requests for your tenant"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L13) |
| `en.PL_TB_TENANTS_LOADING_MESSAGE` | `"Loading..."` | `"Loading..."` | [supertokens-plugins/packages/tenants-react/src/translations.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L14) |
| `en.PL_TB_TENANTS_REQUESTS_ACCEPT_BUTTON_TEXT` | `"Accept"` | `"Accept"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L15) |
| `en.PL_TB_TENANTS_REQUESTS_DECLINE_BUTTON_TEXT` | `"Decline"` | `"Decline"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L16) |
| `en.PL_TB_USERS_TAB_LABEL` | `"Users"` | `"Users"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L3) |
| `en.PL_TB_VIEW_CODE_TEXT` | `"Code"` | `"Code"` | [supertokens-plugins/packages/tenants-react/src/translations.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/translations.ts#L9) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/logger.ts#L5)

***

### Eye

```ts
const Eye: React.FC<EyeProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/icons/Eye.tsx:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/icons/Eye.tsx#L7)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/plugin.tsx:42](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/plugin.tsx#L42)

***

### InvitedUsers

```ts
const InvitedUsers: React.FC<InvitedUsersProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/InvitedUsers.tsx#L21)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/logger.ts#L5)

***

### NoUsers

```ts
const NoUsers: React.FC<NoUsersProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/users/NoUsers.tsx:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/users/NoUsers.tsx#L11)

***

### OnboardingRequests

```ts
const OnboardingRequests: React.FC<OnboardingRequestsProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/requests/OnboardingRequests.tsx:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/requests/OnboardingRequests.tsx#L16)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-tenants" = "supertokens-plugin-tenants";
```

Defined in: [supertokens-plugins/packages/tenants-react/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/constants.ts#L1)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/tenants-react/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/constants.ts#L2)

***

### RemoveInvitation

```ts
const RemoveInvitation: React.FC<RemoveInvitationProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/RemoveInvitation.tsx:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/RemoveInvitation.tsx#L10)

***

### TenantTab

```ts
const TenantTab: React.FC<TenantTabProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/tab/TenantTab.tsx:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/tab/TenantTab.tsx#L15)

***

### TenantUsers

```ts
const TenantUsers: React.FC<TenantUsersProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/users/TenantUsers.tsx:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/users/TenantUsers.tsx#L31)

***

### TenantUsersCombined

```ts
const TenantUsersCombined: React.FC<TenantUsersCombinedProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/tenant-management/tenant-users-combined.tsx:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/tenant-management/tenant-users-combined.tsx#L25)

***

### TenantUsersTable

```ts
const TenantUsersTable: React.FC<TableProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/table/TenantTable.tsx:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/table/TenantTable.tsx#L19)

***

### Trash

```ts
const Trash: React.FC<TrashProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/icons/Trash.tsx:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/icons/Trash.tsx#L7)

***

### usePluginContext

```ts
usePluginContext: any;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/plugin.tsx:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/plugin.tsx#L31)

***

### UserDetails

```ts
const UserDetails: React.FC<UserDetailsProps>;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/users/UserDetails.tsx:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/users/UserDetails.tsx#L31)

## Functions

### AcceptInvitation()

```ts
function AcceptInvitation(__namedParameters: {
  onAccept: (code: string, tenantId: string) => Promise<
     | {
     status: "OK";
   }
     | {
     message: string;
     status: "ERROR";
  }>;
}): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/invitations/accept.tsx:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/invitations/accept.tsx#L13)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `onAccept`: (`code`: `string`, `tenantId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \}\>; \} |
| `__namedParameters.onAccept` | (`code`: `string`, `tenantId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \}\> |

#### Returns

`Element`

***

### AccessBlockedContainer()

```ts
function AccessBlockedContainer(): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/access-blocked/AccessBlocked.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/access-blocked/AccessBlocked.tsx#L8)

#### Returns

`Element`

***

### AccessBlockedPage()

```ts
function AccessBlockedPage(): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/access-blocked/AccessBlocked.tsx:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/access-blocked/AccessBlocked.tsx#L19)

#### Returns

`Element`

***

### CreationRequests()

```ts
function CreationRequests(): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/requests/CreationRequests.tsx:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/requests/CreationRequests.tsx#L16)

#### Returns

`Element`

***

### default()

```ts
function default(): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/select-tenant/TenantWrapper.tsx:98](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/select-tenant/TenantWrapper.tsx#L98)

#### Returns

`Element`

***

### getApi()

```ts
function getApi(querier: any): {
  acceptCreationRequest: (requestId: string) => Promise<any>;
  acceptInvitation: (code: string, tenantId: string) => Promise<any>;
  acceptOnboardingRequest: (userId: string) => Promise<any>;
  addInvitation: (email: string, role: string) => Promise<any>;
  changeRole: (userId: string, role: string) => Promise<any>;
  createTenant: (data: TenantCreateData) => Promise<any>;
  declineCreationRequest: (requestId: string) => Promise<any>;
  declineOnboardingRequest: (userId: string) => Promise<any>;
  doesUserHaveExistingCreationRequest: () => Promise<any>;
  fetchTenants: () => Promise<any>;
  getCreationRequests: () => Promise<any>;
  getInvitations: () => Promise<any>;
  getOnboardingRequests: () => Promise<any>;
  getUsers: () => Promise<any>;
  joinTenant: (data: TenantJoinData) => Promise<any>;
  removeInvitation: (email: string) => Promise<any>;
  removeUserFromTenant: (userId: string) => Promise<any>;
  switchTenant: (tenantId: string) => Promise<any>;
};
```

Defined in: [supertokens-plugins/packages/tenants-react/src/api.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L14)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `querier` | `any` |

#### Returns

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `acceptCreationRequest()` | (`requestId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:194](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L194) |
| `acceptInvitation()` | (`code`: `string`, `tenantId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:186](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L186) |
| `acceptOnboardingRequest()` | (`userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:191](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L191) |
| `addInvitation()` | (`email`: `string`, `role`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:185](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L185) |
| `changeRole()` | (`userId`: `string`, `role`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:188](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L188) |
| `createTenant()` | (`data`: `TenantCreateData`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:181](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L181) |
| `declineCreationRequest()` | (`requestId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:195](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L195) |
| `declineOnboardingRequest()` | (`userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:192](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L192) |
| `doesUserHaveExistingCreationRequest()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:196](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L196) |
| `fetchTenants()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:179](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L179) |
| `getCreationRequests()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | Tenant Creation related endpoints | [supertokens-plugins/packages/tenants-react/src/api.ts:193](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L193) |
| `getInvitations()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:182](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L182) |
| `getOnboardingRequests()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:190](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L190) |
| `getUsers()` | () => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:183](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L183) |
| `joinTenant()` | (`data`: `TenantJoinData`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:180](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L180) |
| `removeInvitation()` | (`email`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:184](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L184) |
| `removeUserFromTenant()` | (`userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:189](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L189) |
| `switchTenant()` | (`tenantId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | - | [supertokens-plugins/packages/tenants-react/src/api.ts:187](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/api.ts#L187) |

***

### InvitationAcceptWrapper()

```ts
function InvitationAcceptWrapper(): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/InvitationAcceptPage.tsx:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/InvitationAcceptPage.tsx#L7)

#### Returns

`Element`

***

### PageWrapper()

```ts
function PageWrapper(__namedParameters: {
  children: ReactNode;
  style?: CSSProperties;
}): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/page-wrapper/page-wrapper.tsx:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/page-wrapper/page-wrapper.tsx#L4)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `children`: `ReactNode`; `style?`: `CSSProperties`; \} |
| `__namedParameters.children` | `ReactNode` |
| `__namedParameters.style?` | `CSSProperties` |

#### Returns

`Element`

***

### SelectTenantPage()

```ts
function SelectTenantPage(): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/select-tenant/SelectTenantPage.tsx:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/select-tenant/SelectTenantPage.tsx#L8)

#### Returns

`Element`

***

### TenantCard()

```ts
function TenantCard(__namedParameters: TenantCardProps): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/components/tenant-card/tenant-card.tsx:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/components/tenant-card/tenant-card.tsx#L20)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | `TenantCardProps` |

#### Returns

`Element`

***

### TenantCreationRequests()

```ts
function TenantCreationRequests(props: any): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/tenant-creation-requests/tenant-creation-requests.tsx:31](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/tenant-creation-requests/tenant-creation-requests.tsx#L31)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `props` | `any` |

#### Returns

`Element`

***

### TenantManagement()

```ts
function TenantManagement(props: any): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/tenant-management/tenant-management.tsx:91](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/tenant-management/tenant-management.tsx#L91)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `props` | `any` |

#### Returns

`Element`

***

### TenantManagementWithoutToastWrapper()

```ts
function TenantManagementWithoutToastWrapper(__namedParameters: {
  section: FormSection;
}): Element;
```

Defined in: [supertokens-plugins/packages/tenants-react/src/pages/tenant-management/tenant-management.tsx:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/tenants-react/src/pages/tenant-management/tenant-management.tsx#L16)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `section`: `FormSection`; \} |
| `__namedParameters.section` | `FormSection` |

#### Returns

`Element`

# References - Plugins -  `@supertokens-plugins/user-banning-nodejs`
Source: https://supertokens.com/docs/references/plugins/user-banning-nodejs

## Classes

### UserBanningService

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L17)

#### Constructors

##### Constructor

```ts
new UserBanningService(pluginConfig: SuperTokensPluginUserBanningPluginNormalisedConfig): UserBanningService;
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L21)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `pluginConfig` | [`SuperTokensPluginUserBanningPluginNormalisedConfig`](#supertokenspluginuserbanningpluginnormalisedconfig) |

###### Returns

[`UserBanningService`](#userbanningservice)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="addbantocache"></a> `addBanToCache` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `tenantId`: `string`, `userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:30](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L30) |
| <a id="cache"></a> `cache` | `protected` | [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, `boolean`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L18) |
| <a id="cachepreloadpromise"></a> `cachePreLoadPromise` | `protected` | [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L19) |
| <a id="checkandaddbanneduserroleifneeded"></a> `checkAndAddBannedUserRoleIfNeeded` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `message`: `string`; `status`: `string`; \} \| \{ `message?`: `undefined`; `status`: `string`; \}\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:65](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L65) |
| <a id="getbanstatus"></a> `getBanStatus` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `tenantId`: `string`, `userId`: `string`, `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `banned`: `boolean`; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"UNKNOWN_ERROR"`; \}\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:90](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L90) |
| <a id="getbanstatusfromcache"></a> `getBanStatusFromCache` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `tenantId`: `string`, `userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:38](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L38) |
| <a id="pluginconfig"></a> `pluginConfig` | `protected` | [`SuperTokensPluginUserBanningPluginNormalisedConfig`](#supertokenspluginuserbanningpluginnormalisedconfig) | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L21) |
| <a id="preloadcache"></a> `preLoadCache` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:42](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L42) |
| <a id="preloadcacheifneeded"></a> `preLoadCacheIfNeeded` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L23) |
| <a id="removebanfromcache"></a> `removeBanFromCache` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `tenantId`: `string`, `userId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:34](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L34) |
| <a id="setbanstatusandupdatesessions"></a> `setBanStatusAndUpdateSessions` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `tenantId`: `string`, `userId`: `string`, `isBanned`: `boolean`, `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\< \| \{ `status`: `"OK"`; \} \| \{ `status`: `"UNKNOWN_ROLE_ERROR"`; \} \| \{ `status`: `"USER_NOT_FOUND"`; \}\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:129](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L129) |
| <a id="updatesessions"></a> `updateSessions` | `public` | (`this`: [`UserBanningService`](#userbanningservice), `userId`: `string`, `tenantId`: `string`, `isBanned`: `boolean`, `userContext?`: `UserContext`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | `undefined` | [supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:112](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/userBanningService.ts#L112) |

## Type Aliases

### SuperTokensPluginUserBanningPluginConfig

```ts
type SuperTokensPluginUserBanningPluginConfig = {
  bannedUserRole?: string;
  globalBanning?: boolean;
  userBanningPermission?: string;
};
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L1)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="banneduserrole"></a> `bannedUserRole?` | `string` | [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L3) |
| <a id="globalbanning"></a> `globalBanning?` | `boolean` | [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L4) |
| <a id="userbanningpermission"></a> `userBanningPermission?` | `string` | [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L2) |

***

### SuperTokensPluginUserBanningPluginNormalisedConfig

```ts
type SuperTokensPluginUserBanningPluginNormalisedConfig = {
  bannedUserRole: string;
  globalBanning: boolean;
  userBanningPermission: string;
};
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L7)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="banneduserrole-1"></a> `bannedUserRole` | `string` | [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L9) |
| <a id="globalbanning-1"></a> `globalBanning` | `boolean` | [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L10) |
| <a id="userbanningpermission-1"></a> `userBanningPermission` | `string` | [supertokens-plugins/packages/user-banning-nodejs/src/types.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/types.ts#L8) |

## Variables

### default

```ts
default: {
  init: any;
};
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/index.ts#L4)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/user-banning-nodejs/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/index.ts#L4) |

***

### DEFAULT\_BANNED\_USER\_ROLE

```ts
const DEFAULT_BANNED_USER_ROLE: "banned" = "banned";
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L9)

***

### DEFAULT\_GLOBAL\_BANNING

```ts
const DEFAULT_GLOBAL_BANNING: true = true;
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L10)

***

### DEFAULT\_PERMISSION\_NAME

```ts
const DEFAULT_PERMISSION_NAME: "ban-user" = "ban-user";
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L8)

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/logger.ts#L4)

***

### HANDLE\_BASE\_PATH

```ts
const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-user-banning";
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L6)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/plugin.ts:20](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/plugin.ts#L20)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/logger.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/logger.ts#L4)

***

### PLUGIN\_ERROR\_NAME

```ts
const PLUGIN_ERROR_NAME: "supertokens-plugin-user-banning-error";
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L12)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-user-banning" = "supertokens-plugin-user-banning";
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L1)

***

### PLUGIN\_SDK\_VERSION

```ts
const PLUGIN_SDK_VERSION: string[];
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L4)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-nodejs/src/constants.ts#L2)

# References - Plugins -  `@supertokens-plugins/user-banning-react`
Source: https://supertokens.com/docs/references/plugins/user-banning-react

## Type Aliases

### SuperTokensPluginUserBanningPluginConfig

```ts
type SuperTokensPluginUserBanningPluginConfig = {
  bannedUserRole?: string;
  onPermissionFailureRedirectPath?: string;
  userBanningPermission?: string;
};
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/types.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L3)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="banneduserrole"></a> `bannedUserRole?` | `string` | [supertokens-plugins/packages/user-banning-react/src/types.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L5) |
| <a id="onpermissionfailureredirectpath"></a> `onPermissionFailureRedirectPath?` | `string` | [supertokens-plugins/packages/user-banning-react/src/types.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L6) |
| <a id="userbanningpermission"></a> `userBanningPermission?` | `string` | [supertokens-plugins/packages/user-banning-react/src/types.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L4) |

***

### SuperTokensPluginUserBanningPluginNormalisedConfig

```ts
type SuperTokensPluginUserBanningPluginNormalisedConfig = {
  bannedUserRole: string;
  onPermissionFailureRedirectPath: string;
  userBanningPermission: string;
};
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/types.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L9)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="banneduserrole-1"></a> `bannedUserRole` | `string` | [supertokens-plugins/packages/user-banning-react/src/types.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L11) |
| <a id="onpermissionfailureredirectpath-1"></a> `onPermissionFailureRedirectPath` | `string` | [supertokens-plugins/packages/user-banning-react/src/types.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L12) |
| <a id="userbanningpermission-1"></a> `userBanningPermission` | `string` | [supertokens-plugins/packages/user-banning-react/src/types.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L10) |

***

### TranslationKeys

```ts
type TranslationKeys = keyof typeof defaultTranslationsUserBanning["en"];
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/types.ts:15](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/types.ts#L15)

## Variables

### API\_PATH

```ts
const API_PATH: "plugin/supertokens-plugin-user-banning";
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/constants.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/constants.ts#L3)

***

### default

```ts
default: {
  init: any;
};
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/index.ts#L4)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| <a id="init"></a> `init` | `any` | [supertokens-plugins/packages/user-banning-react/src/index.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/index.ts#L4) |

***

### DEFAULT\_BANNED\_USER\_ROLE

```ts
const DEFAULT_BANNED_USER_ROLE: "banned" = "banned";
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/constants.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/constants.ts#L6)

***

### DEFAULT\_ON\_PERMISSION\_FAILURE\_REDIRECT\_PATH

```ts
const DEFAULT_ON_PERMISSION_FAILURE_REDIRECT_PATH: "/" = "/";
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/constants.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/constants.ts#L7)

***

### DEFAULT\_PERMISSION\_NAME

```ts
const DEFAULT_PERMISSION_NAME: "ban-user" = "ban-user";
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/constants.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/constants.ts#L5)

***

### defaultTranslationsUserBanning

```ts
const defaultTranslationsUserBanning: {
  en: {
     PL_UB_BAN_PAGE_BAN_BUTTON: "Ban";
     PL_UB_BAN_PAGE_BANNED_STATUS: "Banned";
     PL_UB_BAN_PAGE_CHECK_STATUS_BUTTON: "Check Status";
     PL_UB_BAN_PAGE_DESCRIPTION: "This page is used to ban and unban users. It is useful for preventing users from accessing your application.";
     PL_UB_BAN_PAGE_EMAIL_LABEL: "Email";
     PL_UB_BAN_PAGE_EMAIL_PLACEHOLDER: "Enter email";
     PL_UB_BAN_PAGE_GENERAL_ERROR: "An error occurred while checking the status of the user";
     PL_UB_BAN_PAGE_NOT_BANNED_STATUS: "Not Banned";
     PL_UB_BAN_PAGE_TENANT_ID_LABEL: "Tenant";
     PL_UB_BAN_PAGE_TENANT_ID_PLACEHOLDER: "Enter tenant ID";
     PL_UB_BAN_PAGE_TITLE: "Ban User";
     PL_UB_BAN_PAGE_UNBAN_BUTTON: "Unban";
     PL_UB_BAN_PAGE_UNKNOWN_ERROR: "An unknown error occurred";
     PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE: "An unknown error occurred while checking the status of the user";
     PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE_MESSAGE: "An unknown error occurred while checking the status of the user";
  };
};
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/translations.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L1)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="en"></a> `en` | \{ `PL_UB_BAN_PAGE_BAN_BUTTON`: `"Ban"`; `PL_UB_BAN_PAGE_BANNED_STATUS`: `"Banned"`; `PL_UB_BAN_PAGE_CHECK_STATUS_BUTTON`: `"Check Status"`; `PL_UB_BAN_PAGE_DESCRIPTION`: `"This page is used to ban and unban users. It is useful for preventing users from accessing your application."`; `PL_UB_BAN_PAGE_EMAIL_LABEL`: `"Email"`; `PL_UB_BAN_PAGE_EMAIL_PLACEHOLDER`: `"Enter email"`; `PL_UB_BAN_PAGE_GENERAL_ERROR`: `"An error occurred while checking the status of the user"`; `PL_UB_BAN_PAGE_NOT_BANNED_STATUS`: `"Not Banned"`; `PL_UB_BAN_PAGE_TENANT_ID_LABEL`: `"Tenant"`; `PL_UB_BAN_PAGE_TENANT_ID_PLACEHOLDER`: `"Enter tenant ID"`; `PL_UB_BAN_PAGE_TITLE`: `"Ban User"`; `PL_UB_BAN_PAGE_UNBAN_BUTTON`: `"Unban"`; `PL_UB_BAN_PAGE_UNKNOWN_ERROR`: `"An unknown error occurred"`; `PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE`: `"An unknown error occurred while checking the status of the user"`; `PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE_MESSAGE`: `"An unknown error occurred while checking the status of the user"`; \} | - | [supertokens-plugins/packages/user-banning-react/src/translations.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L2) |
| `en.PL_UB_BAN_PAGE_BAN_BUTTON` | `"Ban"` | `"Ban"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:7](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L7) |
| `en.PL_UB_BAN_PAGE_BANNED_STATUS` | `"Banned"` | `"Banned"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:13](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L13) |
| `en.PL_UB_BAN_PAGE_CHECK_STATUS_BUTTON` | `"Check Status"` | `"Check Status"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:6](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L6) |
| `en.PL_UB_BAN_PAGE_DESCRIPTION` | `"This page is used to ban and unban users. It is useful for preventing users from accessing your application."` | `"This page is used to ban and unban users. It is useful for preventing users from accessing your application."` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:4](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L4) |
| `en.PL_UB_BAN_PAGE_EMAIL_LABEL` | `"Email"` | `"Email"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:9](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L9) |
| `en.PL_UB_BAN_PAGE_EMAIL_PLACEHOLDER` | `"Enter email"` | `"Enter email"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:10](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L10) |
| `en.PL_UB_BAN_PAGE_GENERAL_ERROR` | `"An error occurred while checking the status of the user"` | `"An error occurred while checking the status of the user"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:16](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L16) |
| `en.PL_UB_BAN_PAGE_NOT_BANNED_STATUS` | `"Not Banned"` | `"Not Banned"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:14](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L14) |
| `en.PL_UB_BAN_PAGE_TENANT_ID_LABEL` | `"Tenant"` | `"Tenant"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:11](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L11) |
| `en.PL_UB_BAN_PAGE_TENANT_ID_PLACEHOLDER` | `"Enter tenant ID"` | `"Enter tenant ID"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L12) |
| `en.PL_UB_BAN_PAGE_TITLE` | `"Ban User"` | `"Ban User"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L3) |
| `en.PL_UB_BAN_PAGE_UNBAN_BUTTON` | `"Unban"` | `"Unban"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:8](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L8) |
| `en.PL_UB_BAN_PAGE_UNKNOWN_ERROR` | `"An unknown error occurred"` | `"An unknown error occurred"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:17](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L17) |
| `en.PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE` | `"An unknown error occurred while checking the status of the user"` | `"An unknown error occurred while checking the status of the user"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:18](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L18) |
| `en.PL_UB_BAN_PAGE_UNKNOWN_ERROR_MESSAGE_MESSAGE` | `"An unknown error occurred while checking the status of the user"` | `"An unknown error occurred while checking the status of the user"` | [supertokens-plugins/packages/user-banning-react/src/translations.ts:19](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/translations.ts#L19) |

***

### enableDebugLogs

```ts
enableDebugLogs: any;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/logger.ts#L5)

***

### init

```ts
const init: any;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/plugin.ts:36](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/plugin.ts#L36)

***

### logDebugMessage

```ts
logDebugMessage: any;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/logger.ts:5](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/logger.ts#L5)

***

### PLUGIN\_ID

```ts
const PLUGIN_ID: "supertokens-plugin-user-banning" = "supertokens-plugin-user-banning";
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/constants.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/constants.ts#L1)

***

### PLUGIN\_VERSION

```ts
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/constants.ts:2](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/constants.ts#L2)

***

### ThemeBase

```ts
const ThemeBase: React.FC<PropsWithChildren<{
  userStyles: (string | undefined)[];
}>>;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/utils/ThemeBase.tsx:21](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/utils/ThemeBase.tsx#L21)

***

### usePluginContext

```ts
usePluginContext: any;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/plugin.ts:25](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/plugin.ts#L25)

## Functions

### BanUserPage()

```ts
function BanUserPage(): Element;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/pages/BanUserPage.tsx:12](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/pages/BanUserPage.tsx#L12)

#### Returns

`Element`

***

### getApi()

```ts
function getApi(querier: any): {
  getBanStatus: (tenantId: string, email: string) => Promise<any>;
  updateBanStatus: (tenantId: string, email: string, isBanned: boolean) => Promise<any>;
};
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/api.ts:3](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/api.ts#L3)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `querier` | `any` |

#### Returns

```ts
{
  getBanStatus: (tenantId: string, email: string) => Promise<any>;
  updateBanStatus: (tenantId: string, email: string, isBanned: boolean) => Promise<any>;
}
```

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `getBanStatus()` | (`tenantId`: `string`, `email`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/user-banning-react/src/api.ts:23](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/api.ts#L23) |
| `updateBanStatus()` | (`tenantId`: `string`, `email`: `string`, `isBanned`: `boolean`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | [supertokens-plugins/packages/user-banning-react/src/api.ts:24](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/api.ts#L24) |

***

### getErrorMessage()

```ts
function getErrorMessage(error: any): string;
```

Defined in: [supertokens-plugins/packages/user-banning-react/src/utils/getErrorMessage.ts:1](https://github.com/supertokens/supertokens-plugins/blob/main/packages/user-banning-react/src/utils/getErrorMessage.ts#L1)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `error` | `any` |

#### Returns

`string`

# References - Frontend SDKs -  Frontend SDKs
Source: https://supertokens.com/docs/references/frontend-sdks/reference

## Overview

SuperTokens exposes SDKs for frontend frameworks.
Use this page to find references to each of them and about specific functionalities.

## Customization

<ReferenceCard.Grid>
  <ReferenceCard href="/docs/references/frontend-sdks/function-overrides">
    <ReferenceCard.Title>
      Function overrides
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/frontend-sdks/hooks">
    <ReferenceCard.Title>
      Hooks
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/override-react-components">
    <ReferenceCard.Title>
      Component override
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/changing-style">
    <ReferenceCard.Title>
      Prebuilt UI styling
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/changing-colours">
    <ReferenceCard.Title>
      Prebuilt UI theming
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="/docs/references/frontend-sdks/prebuilt-ui/translations">
    <ReferenceCard.Title>
      Translations
    </ReferenceCard.Title>
  </ReferenceCard>

</ReferenceCard.Grid>

## SDK references

<ReferenceCard.Grid>
  <ReferenceCard href="https://supertokens.com/docs/auth-react">
    <ReferenceCard.Avatar icon="react" />
    <ReferenceCard.Title>
      ReactJS
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/web-js">
    <ReferenceCard.Avatar icon="js" />
    <ReferenceCard.Title>
      Vanilla JS
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/react-native">
    <ReferenceCard.Avatar icon="react" />
    <ReferenceCard.Title>
      React Native
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/ios">
    <ReferenceCard.Avatar icon="ios" />
    <ReferenceCard.Title>
      iOS
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/android">
    <ReferenceCard.Avatar icon="android" />
    <ReferenceCard.Title>
      Android
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/flutter">
    <ReferenceCard.Avatar icon="flutter" />
    <ReferenceCard.Title>
      Flutter
    </ReferenceCard.Title>
  </ReferenceCard>
</ReferenceCard.Grid>

## SDK configuration

The `appInfo` object is the paramter used to configure the SDKs during initialization.
```ts
let appInfo: {
    appName: string,
    websiteDomain: string,
    apiDomain: string,
    websiteBasePath?: string,  
    apiBasePath?: string,  
    apiGatewayPath?: string 
}
```

<Accordion px="4" pb="4">

## `appName` 

This is the name of your application.
Use it when sending password reset or email verification emails (in the default email design).
An example of this is `appName: "GitHub"`.

<br/>

## `websiteDomain` 

This is the domain part of your website.
This is where the login UI appears.
For example:
- For local development, you are likely using `localhost` with some port (ex `8080`). Then the value of this should be `"http://localhost:8080"`.
- If your website is `https://www.example.com`, then the value of this should be `"https://www.example.com"`.
- If your website is `https://example.com`, then the value of this should be `"https://example.com"`.
- If you have multiple sub domains, and your users login via `https://auth.example.com`, then the value of this should be `"https://auth.example.com"`.

By default, the login UI appears on `{websiteDomain}/auth/*`. This configuration can change by using the `websiteBasePath` configuration.

On the frontend, the domain serves routing purposes, and on the backend, it generates correct email verification and password reset links.

<br/>

## `apiDomain` 

This is the domain part of your API endpoint that the frontend talks to. For example:
- For local development, you are likely using `localhost` with some port (ex `9000`). Then the value of this should be `"http://localhost:9000"`.
- If your frontend queries `https://api.example.com/*`, then the value of this should be `"https://api.example.com"`
- If your API endpoint reaches `/api/*`, then the value of this is the same as the `websiteDomain` - since `/api/*` is equal to querying `{websiteDomain}/api/*`.

By default, the login widgets query `{apiDomain}/auth/*`. This configuration can change by using the `apiBasePath` configuration.

<br/>

## `websiteBasePath` 

By default, the login UI appears on `{websiteDomain}/auth`. Other authentication-related user interfaces appear on `{websiteDomain}/auth/*`.

If you want to change the `/auth` to something else, then you must set this value. For example:
- If you want the login UI to show on `{websiteDomain}/user/*`, then the value of this should be `"/user"`.
- If you are using a dedicated sub domain for auth, like `https://auth.example.com`, then you probably want the login UI to show up on `https://auth.example.com`. In this case, set this value to `"/"`.

:::important
Remember to set the same value for this parameter on the backend and the frontend.
:::

<br/>

## `apiBasePath` 

By default, the frontend SDK queries `{apiDomain}/auth/*`.

If you want to change the `/auth` to something else, then you must set this value. For example:
- If you have versioning in your API path and want to query `{apiDomain}/v0/auth/*`, then the value of this should be `"/v0/auth"`.
- If you want to scope the APIs not via `/auth` but via some other string like `/supertokens`, then you can set the value of this to `"/supertokens"`. This means, the APIs appear on `{apiDomain}/supertokens/*`.
- If you do not want to scope the APIs at all, then you can set the values of this to be `"/"`. This means the APIs are available on `{apiDomain}/*`

:::important
Remember to set the same value for this parameter on the backend and the frontend.
:::

:::caution
Note that setting a custom `apiBasePath` updates the refresh API path, this can cause an issue where previously issued refresh tokens no longer get sent to the new API endpoint and the user logs out.
For example, the default `apiBasePath` value is `/auth`, if it changes to `/supertokens`, then your refresh endpoint updates from `/auth/session/refresh` to `/supertokens/session/refresh`. Previously issued refresh tokens do not get sent to the new API endpoint and the user logs out.
:::

<br/>

## `apiGatewayPath` 

:::note
Most relevant if you are using an API gateway or reverse proxy
:::

If you are using an API gateway (like the one provided by AWS) or a reverse proxy (like Nginx), it may add a path to your API endpoints to scope them for different development environments.
For example, your APIs for development appear via `{apiDomain}/dev/*`, and for production, they may appear via `{apiDomain}/prod/*`.

Whilst the frontend would need to use the `/dev/` and `/prod/`, your backend code does not see that sub path (the gateway removes `/dev/` and `/prod/`).

For these situations, you should set the `apiGatewayPath` to `/dev` or `/prod`. For example:
- If your API gateway is using `/development` for scoping, and you want to expose the SuperTokens APIs on `/supertokens/*`, then set `apiGatewayPath: "/development"` & `apiBasePath: "/supertokens"`. This means that the frontend SDK queries `{apiDomain}/development/supertokens/*` to reach the endpoints exposed by SuperTokens.
- If you set this and not `apiBasePath`, then the frontend SDK queries `{apiDomain}{apiGatewayPath}/auth/*` to reach the endpoints exposed by SuperTokens.

The reason for this distinction between `apiGatewayPath` and `apiBasePath` is that when routing, the backend SDK does not see the `apiGatewayPath` path from the request as the gateway removes them.
Taking the above example, whilst the frontend queries `{apiDomain}/development/supertokens/*`, the backend SDK sees `{apiDomain}/supertokens/*`.

<br/>

</Accordion>

# References - Frontend SDKs -  Function overrides
Source: https://supertokens.com/docs/references/frontend-sdks/function-overrides

## Overview

**Function overrides** let you customize the behavior of the functions used internally, by the SDKs.
You can change how actions like signing in, signing up, creating, or revoking sessions or signing out work.
This flexibility lets you integrate your own logic into the authentication and session management processes.

For example, if a recipe checks for an active session using the session recipe’s `doesSessionExist` function, you can override that function to work with your custom session management.
Similarly, if you already have a sign-in/sign-up flow and want to integrate with SuperTokens, overriding allows you to handle the migration process.
You can even implement your own `userId` format by mapping your `userIds` to those generated by SuperTokens.

## Before you start

This page is relevant if you are using the actual frontend SDK.
If you are calling the backend SDK endpoints directly this code does not run in your use case.

## Example

The code snippet shows the general flow of overriding a function. 
You inject your own custom logic while also calling the original implementation of the function.

:::info
The next examples include a couple of override samples.
See all the [functions that can be overridden here](https://supertokens.com/docs/auth-react/modules/recipe_thirdpartyemailpassword.html#RecipeInterface)
:::

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        Session.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // we will only be overriding the function for checking
                        // if a session exists
                        doesSessionExist: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return originalImplementation.doesSessionExist(input);
                        }
                    }
                }
            }
            // highlight-end 
        }),
        EmailPassword.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // we will only be overriding what happens when a user
                        // clicks the sign up button.
                        signUp: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return originalImplementation.signUp(input);
                        },
                        // ...
                        // TODO: override more functions
                    }
                }
            }
            // highlight-end
        }),
        ThirdParty.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // we will only be overriding what happens when a user
                        // clicks the sign in or sign up button.
                        signInAndUp: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return originalImplementation.signInAndUp(input);
                        },
                        // ...
                        // TODO: override more functions
                    }
                }
            }
            // highlight-end
        })
    ]
});
```
</Tab>

<Tab value="angular">

:::info
See all the [functions that can be overridden here](https://supertokens.com/docs/auth-react/modules/recipe_thirdpartyemailpassword.html#RecipeInterface)
:::

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    recipeList: [
        supertokensUISession.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // we will only be overriding the function for checking
                        // if a session exists
                        doesSessionExist: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return originalImplementation.doesSessionExist(input);
                        }
                    }
                }
            }
            // highlight-end 
        }),
        supertokensUIEmailPassword.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // we will only be overriding what happens when a user
                        // clicks the sign up button.
                        signUp: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return originalImplementation.signUp(input);
                        },
                        // ...
                        // TODO: override more functions
                    }
                }
            }
            // highlight-end
        }),
        supertokensUIThirdParty.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // we will only be overriding what happens when a user
                        // clicks the sign in or sign up button.
                        signInAndUp: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return originalImplementation.signInAndUp(input);
                        },
                        // ...
                        // TODO: override more functions
                    }
                }
            }
            // highlight-end
        })
    ]
});
```
</Tab>

</Tabs>

# References - Frontend SDKs -  Hooks
Source: https://supertokens.com/docs/references/frontend-sdks/hooks

## Overview

Hooks are a way to trigger custom logic when certain actions happen in the authentication process.



---

## Handle event hook

<PrebuiltUIInstructions>

Each frontend recipe emits events when certain actions happen.
You can use this hook to trigger side effects when something happens in the authentication process.
This can address things like logging or analytics.

<Tabs>
<Tab value="reactjs">

```tsx

EmailPassword.init({
    onHandleEvent: (context) => {
        if (context.action === "PASSWORD_RESET_SUCCESSFUL") {

        } else if (context.action === "RESET_PASSWORD_EMAIL_SENT") {

        } else if (context.action === "SUCCESS") {
            if (context.createdNewSession) {
                let user = context.user;
                if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                    // sign up success
                } else {
                    // sign in success
                }
            } else {
                // during step up or second factor auth with email password
            }
        }
    }
})

ThirdParty.init({
    onHandleEvent: (context) => {
        if (context.action === "SUCCESS") {
            if (context.createdNewSession) {
                let user = context.user;
                if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                    // sign up success
                } else {
                    // sign in success
                }
            } else {
                // during linking a social account to an existing account
            }
        }
    }
})
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIEmailPassword.init({
    onHandleEvent: (context) => {
        if (context.action === "PASSWORD_RESET_SUCCESSFUL") {

        } else if (context.action === "RESET_PASSWORD_EMAIL_SENT") {

        } else if (context.action === "SUCCESS") {
            if (context.createdNewSession) {
                let user = context.user;
                if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                    // sign up success
                } else {
                    // sign in success
                }
            } else {
                // during step up or second factor auth with email password
            }
        }
    }
})

supertokensUIThirdParty.init({
    onHandleEvent: (context) => {
        if (context.action === "SUCCESS") {
            if (context.createdNewSession) {
                let user = context.user;
                if (context.isNewRecipeUser && context.user.loginMethods.length === 1) {
                    // sign up success
                } else {
                    // sign in success
                }
            } else {
                // during linking a social account to an existing account
            }
        }
    }
})
```
</Tab>
</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

:::caution
Not applicable since you need to build custom UI anyway. 
When you call the functions from the SDK, or call the API directly, you can run custom logic in your own code.
:::

</CustomUIInstructions>

---

## Pre-API hook

This function calls the backend before any API call.
You can use this to change the request properties.

<PrebuiltUIInstructions>

<Tabs>
<Tab value="reactjs">

```tsx

ThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        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
        };

    }
})

EmailPassword.init({
    preAPIHook: async (context) => {
        let url = context.url;
        let requestInit = context.requestInit;
        
        let action = context.action;
        if (action === "EMAIL_EXISTS") {

        } else if (action === "EMAIL_PASSWORD_SIGN_IN") {

        } else if (action === "EMAIL_PASSWORD_SIGN_UP") {

        } else if (action === "SEND_RESET_PASSWORD_EMAIL") {

        } else if (action === "SUBMIT_NEW_PASSWORD") {

        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)

        return {
            requestInit, url
        };

    }
})
```

</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        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
        };

    }
})

supertokensUIEmailPassword.init({
    preAPIHook: async (context) => {
        let url = context.url;
        let requestInit = context.requestInit;
        
        let action = context.action;
        if (action === "EMAIL_EXISTS") {

        } else if (action === "EMAIL_PASSWORD_SIGN_IN") {

        } else if (action === "EMAIL_PASSWORD_SIGN_UP") {

        } else if (action === "SEND_RESET_PASSWORD_EMAIL") {

        } else if (action === "SUBMIT_NEW_PASSWORD") {

        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)

        return {
            requestInit, url
        };

    }
})
```

</Tab>

</Tabs>

</PrebuiltUIInstructions>

<CustomUIInstructions>

<Tabs>
<Tab value="web">

<Tabs>
<Tab value="npm">

```tsx

EmailPassword.init({
    preAPIHook: async (context) => {
        let url = context.url;
        let requestInit = context.requestInit;
        
        let action = context.action;
        if (action === "EMAIL_EXISTS") {

        } else if (action === "EMAIL_PASSWORD_SIGN_IN") {

        } else if (action === "EMAIL_PASSWORD_SIGN_UP") {

        } else if (action === "SEND_RESET_PASSWORD_EMAIL") {

        } else if (action === "SUBMIT_NEW_PASSWORD") {

        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)

        return {
            requestInit, url
        };
    },
})

ThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        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
        };
    },
})
```

<Box px="4" pt="4">
Alternatively you could also declare the pre-API hook when calling the function:
</Box>

```tsx

EmailPassword.doesEmailExist({
    email: "...",
    options: {
        preAPIHook: async (input) => {

            let url = input.url
            let requestInit = input.requestInit

            // TODO: add your code here

            return {url, requestInit}; 
        },
    }
});
```

</Tab>
<Tab value="scripts">

```tsx
supertokensEmailPassword.init({
    preAPIHook: async (context) => {
        let url = context.url;
        let requestInit = context.requestInit;
        
        let action = context.action;
        if (action === "EMAIL_EXISTS") {

        } else if (action === "EMAIL_PASSWORD_SIGN_IN") {

        } else if (action === "EMAIL_PASSWORD_SIGN_UP") {

        } else if (action === "SEND_RESET_PASSWORD_EMAIL") {

        } else if (action === "SUBMIT_NEW_PASSWORD") {

        }

        // events such as sign out are in the 
        // session recipe pre API hook (See the info box below)

        return {
            requestInit, url
        };
    },
})

supertokensThirdParty.init({
    preAPIHook: async (context) => {
        let url = context.url;
        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
        };
    },
})
```

<Box px="4" pt="4">
Alternatively you could also declare the pre-API hook when calling the function:
</Box>

```tsx
supertokensEmailPassword.doesEmailExist({
    email: "...",
    options: {
        preAPIHook: async (input) => {

            let url = input.url
            let requestInit = input.requestInit

            return {url, requestInit}; 
        },
    }
});

```

</Tab>
</Tabs>

</Tab>

<Tab value="mobile">

<Tabs>

<Tab value="reactnative">

```tsx

SuperTokens.init({
  apiDomain: "...",
  preAPIHook: async (context) => {
    let requestInit = context.requestInit;

    if (context.action === "REFRESH_SESSION") {
      requestInit.headers = {
        ...requestInit.headers,
        customHeader: "custom-header",
      };
    } else if (context.action === "SIGN_OUT") {
      requestInit.headers = {
        ...requestInit.headers,
        customHeader: "custom-header",
      };
    }

    return {
      ...context,
      requestInit,
    };
  },
});

```

</Tab>

<Tab value="android">

```kotlin

void main() {
    SuperTokens.init(
    apiDomain: "...",
    preAPIHook: (action, req) {
      if (action == APIAction.SIGN_OUT) {
        req.headers["custom-header"] = "custom-value";
      } else if (action == APIAction.REFRESH_TOKEN) {
        req.headers["custom-header"] = "custom-value";
      }
      
      return req;
    },
  );
}
```

</Tab>

</Tabs>

</Tab>

</Tabs>

</CustomUIInstructions>

---

## Redirection callback hook

<PrebuiltUIInstructions>

Use this function to change where the system redirects the user after certain actions.
For example, you can use this to redirect a user to a specific URL post sign in or sign up.
If you're embedding the UI components in a popup and wish to disable redirection entirely, return `null`.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        appName: "SuperTokens",
        apiDomain: "http://localhost:3000",
        websiteDomain: "http://localhost:3000"
    },
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            // called on a successful sign in / up. Where should the user go next?
            let redirectToPath = context.redirectToPath;
            if (redirectToPath !== undefined) {
                // we are navigating back to where the user was before they authenticated
                return redirectToPath;
            }
            if (context.createdNewUser) {
                // user signed up
                return "/onboarding"
            } else {
                // user signed in
                return "/dashboard"
            }
        } else if (context.action === "TO_AUTH") {
            // called when the user is not authenticated and needs to be redirected to the auth page.
            return "/auth";
        }
        // return undefined to let the default behaviour play out
        return undefined;
    },
    recipeList: [
        EmailPassword.init({
            getRedirectionURL: async (context) => {
                if (context.action === "RESET_PASSWORD") {
                    // called when the user clicked on the forgot password button
                }
                // return undefined to let the default behaviour play out
                return undefined;
            }
        })]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        appName: "SuperTokens",
        apiDomain: "http://localhost:3000",
        websiteDomain: "http://localhost:3000"
    },
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            // called on a successful sign in / up. Where should the user go next?
            let redirectToPath = context.redirectToPath;
            if (redirectToPath !== undefined) {
                // we are navigating back to where the user was before they authenticated
                return redirectToPath;
            }
            if (context.createdNewUser) {
                // user signed up
                return "/onboarding"
            } else {
                // user signed in
                return "/dashboard"
            }
        } else if (context.action === "TO_AUTH") {
            // called when the user is not authenticated and needs to be redirected to the auth page.
            return "/auth";
        }
        // return undefined to let the default behaviour play out
        return undefined;
    },
    recipeList: [
        supertokensUIEmailPassword.init({
            getRedirectionURL: async (context) => {
                if (context.action === "RESET_PASSWORD") {
                    // called when the user clicked on the forgot password button
                }
                // return undefined to let the default behaviour play out
                return undefined;
            }
        })]
});
```
</Tab>
</Tabs>

</PrebuiltUIInstructions>
<CustomUIInstructions>

:::caution
Not applicable since you need to build custom UI anyway. 
When you call the functions from the SDK, or call the API directly, you can run custom logic in your own code.
:::

</CustomUIInstructions>

# References - Frontend SDKs - User Interface -  UI showcase
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/ui-showcase

## Overview

The following page shows the interfaces exposed the pre-built UI for each authentication flow and recipe.

---

## Email password login

You can see the default UI when you visit the `websiteBasePath` (`/auth` by default) on your website. The form includes a sign in and a sign up form, and by default, the sign in form appears.

<Accordion px="4">

## Default sign in form

<img src="/img/emailpassword-sign-in.png" alt="Sign in form UI for email password login" />

## Default sign up form

<img src="/img/emailpassword-sign-up.png" alt="Sign up form UI for email password login" />

## Field validation error UI

The sign up form checks if the email is unique and if not, shows an error to the user saying that the email already exists. Likewise, if any of the form field's validation fails, the user sees an error like below.

<img src="/img/emailpassword-field-validation-error.png" alt="Sign up form field error UI" />

## Incorrect email / password UI
In the sign in form, if the user enters an email that doesn't exist, or is an incorrect email & password combination, they see the following error.

<img src="/img/emailpassword-wrong-cred.png" alt="Sign in form wrong credentials UI" />

## General error UI
If there are network related errors, or the backend sends a status code >= 300, then the following UI appears.

<img src="/img/emailpassword-general-error.png" alt="Sign in form general error" />

</Accordion>

---

## Email verification

<Accordion px="4">

## Email sent screen UI

Once the user visits the email verification screen, this is what they see.

<img src="/img/email-verification-send-email.png" alt="Email verification email sent" />

On screen load, SuperTokens automatically sends an email to the user. This way, the user doesn't have to do any interaction before they get an email. Customizing this behavior is possible via the overrides feature.

The email verification link is of the format: `<WEBSITE_DOMAIN>/<WEBSITE_BASE_PATH>/verify-email?token=...&tenantId=....`

## Post link clicked screen

### If a session exists
In this case, the API automatically consumes the email verification link and shows the following UI.

<img src="/img/email-verification-success.png" alt="Email verification success" />

Clicking on the continue button takes the user to the post sign in / up page (`/` by default).

### If a session does not exist
In this case, the user must do an interaction before calling the API to consume the token. This prevents email clients from automatically verifying the email since many of them may crawl the link in the email.

The user first sees this screen

<img src="/img/email-verification-clicked-no-session.png" alt="Email verification no session prompt" />

And then after they click on continue, they see the same screen as when a session did exist.

### Expired link UI

If the user clicks on an email link that has expired, they see the following UI.

<img src="/img/email-verification-link-expired.png" alt="Email verification no session prompt" />

After clicking continue, they return to the email sent screen (if a session exists), or to the sign in page (if a session doesn't exist).

## General error UI
If there are network related errors, or the backend sends a status code >= 300, then the following UI appears.

<img src="/img/email-verification-send-email-generic-error.png" alt="Email verification generic error" />

The below appears if something went wrong when the user clicked on the email verification link. To try again, they have to reload the page.

<img src="/img/email-verification-link-generic-error.png" alt="Email verification link clicked generic error" />

## Default email UI
The default email sent for email verification appears below. The backend SDK sends it, which calls `https://api.supertokens.com` (the API infrastructure). Follow the link at the end of this page to see how you can change the email content or delivery method.

<img alt="Email UI for email verification email" width="450px" src="/img/emailpassword/email-verify-email.png" />

</Accordion>

---

## Password reset

<Accordion px="4">

## Enter email form
This appears when the user clicks on the "Forgot password" button in the sign in form. You can view it if you visit `/${websiteBasePath}/reset-password` path of your website (default is `/auth/reset-password`).

<img src="/img/reset-password-email.png" alt="Enter email in reset password form" />

Once the user enters their email and clicks on the "Email" button, SuperTokens sends them an email only if that email belongs to an account. Regardless, the user always sees a success state:

<img src="/img/reset-password-email-sent.png" alt="Email sent in reset password form" />

## Enter new password form

This form appears when the user clicks on the password reset link sent to their email. To view this form, you can navigate to `/${websiteBasePath}/reset-password?token=test` path of your website (default is `/auth/reset-password?token=test`).

Notice that the URL path is the same as that of the enter email form. However, there is an extra query parameter `token` which tells SuperTokens to show the enter new password form. If you try and submit a new password with the `test` token value, it fails since it's not a valid password reset token.

<img src="/img/reset-password-new-password.png" alt="Enter new password form" />

If the reset token has expired or is invalid, the user sees the following message.

<img src="/img/reset-password-new-password-invalid-token.png" alt="Enter new password for invalid token" />

Once the user has successfully changed their password, they see the following success screen

<img src="/img/password-reset-success.png" alt="Password change successful" />

:::info Multi tenancy
For multi tenant use case, the password reset token also includes a `tenantId` query parameter which identifies the tenant for which the system created the password reset token.
:::

## General error UI
If there are network related errors, or the backend sends a status code >= 300, then the following UI appears.

<img src="/img/password-reset-general-error.png" alt="Enter email general error" />

<img src="/img/new-password-general-error.png" alt="Enter new password general error" />

## Password reset email UI

The default email sent for password reset appears below. The backend SDK sends it, which calls `https://api.supertokens.com` (the API infrastructure). See the links at the end of this page to change the email content or delivery method.

<img alt="Email UI for password reset email" width="450px" src="/img/emailpassword/pass-reset-email.png" />

</Accordion>

---

## Passwordless login

<Accordion px="4">

## Email or phone input UI

If the `contactMethod` is `EMAIL_OR_PHONE`, the user sees the following UI when they visit the login page.

<img src="/img/passwordless-email-phone.png" alt="Email and phone passwordless login" />

If the user decides to use their phone number and enters a valid phone number with their country code extension, they proceed to the next step. Otherwise, they see an error message asking them to also enter their country code. The UI also changes to show a dropdown containing a list of all countries (equal to the "Only phone input UI" shown below).

## Only email input UI
If the `contactMethod` is `EMAIL`, the user sees the following UI when they visit the login page.

<img src="/img/passwordless-email.png" alt="Email only passwordless login" />

## Only phone input UI
If the `contactMethod` is `PHONE`, the user sees the following UI when they visit the login page.

<img src="/img/passwordless-phone.png" alt="Phone only passwordless login" />

## Invalid email or phone input UI
If the user enters an invalid phone or email, they see the following message

<img src="/img/passwordless-invalid-phone-email.png" alt="Invalid phone or email" />

## Magic link sent screen

If the value of `flowType` on the backend is `MAGIC_LINK`, then after the user has submitted their phone or email, they see the following UI.

<img src="/img/magic-link-sent.png" alt="Magic link sent UI" />

As you can see, a timer makes the user wait for a certain time (15 seconds by default) before they can resend the SMS / email. A button below the input allows them to change the email / SMS (the text on the button changes based on if the user entered an email or phone number).

## Magic link clicked screens

The magic link is of the format: `<WEBSITE_DOMAIN>/<WEBSITE_BASE_PATH>/verify?tenantId=...&preAuthSessionId=<token1>#<token2>`.

### On same device
When the user clicks the magic link and opens it on the same device on which they initiated the flow, they see the following UI before redirecting to the sign in success page (`/` by default). On this screen, SuperTokens automatically extracts the two tokens from the magic link URL. It tries to consume them on the backend to log the user in.

<img src="/img/magic-link-clicked.png" alt="Magic link consumed" />

### On different device

If the user opens the magic link on a different device, they must take an action before consuming tokens from the link. This prevents email clients from automatically consuming the tokens if they crawl links in the email.

<img src="/img/magic-link-clicked-different-device.png" alt="Magic link consumed on different device" />

### Invalid / expired magic link UI

If the user clicks on an invalid magic link or if the token in the magic link has expired, they see the login screen with the following message

<img src="/img/passwordless-magic-link-expired.png" alt="Invalid magic link" />

## Enter OTP screen

If login via OTP is active, then the user sees this screen immediately after their enter their phone number / email.

<img src="/img/enter-otp-screen.png" alt="Enter OTP screen" />

As you can see, a timer makes the user wait for a certain time (15 seconds by default) before they can resend the SMS / email. A button below the input allows them to change the email / SMS (the text on the button changes based on if the user entered an email or phone number).

### Invalid OTP

If the user enters an incorrect OTP, this is what they see.

<img src="/img/enter-otp-invalid.png" alt="Invalid OTP" />

Entering an incorrect OTP too many times results in the user navigating back to the login screen with the following message.

<img src="/img/passwordless-too-many-otp-tries.png" alt="Entered invalid OTP too many times" />

### Logging in via OTP and Magic link simultaneously 

An edge case occurs wherein the end user gets both an OTP and a magic link. Whilst viewing the enter OTP screen, they also click on the magic link. The magic link click opens a new tab and consumes the link to log the user in. The enter OTP screen continues to show the enter OTP UI until the user refreshes the page. After the refresh, it redirects to the post login screen.

## Default email and SMS template

You can find the email and SMS templates along with their UI [in one of the GitHub repositories](https://github.com/supertokens/email-sms-templates).

You can change the content of the email & SMSs and / or how they send. For more information on this, please see the links at the end of this page.

## General errors

If there are network related errors, or the backend sends a status code >= 300, then the following UI shows. This UI also appears if there is a similar error in the callback page.

<img src="/img/passwordless-passwordless-general-error.png" alt="Login screen general error" />

<img src="/img/enter-otp-error.png" alt="Enter OTP screen general error" />

<img src="/img/magic-link-sent-error.png" alt="Magic link sent screen general error" />

The error below appears if something went wrong after the user clicks on the magic link. Reloading the page should result in a reattempt

<img src="/img/email-verification-link-generic-error.png" alt="Email verification link clicked generic error" />

</Accordion>

---

## Social login

You can see the default UI when you visit the `websiteBasePath` (`/auth` by default) on your website.

<Accordion px="4">

## Default social login button UI

<img src="/img/thirdparty-sign-in-custom-provider.png" alt="Sign in form UI for social login" />

## Callback page UI
When the user navigates back to your application from the third party provider, they see the following UI. On this screen, SuperTokens takes the authorisation code from the URL (sent by the provider) and sends it to the backend. The backend exchanges that for the user's access token and information.

<img src="/img/thirdparty-thirdparty-callback.png" alt="Callback screen from third party provider." />

## Sign in / up unsuccessful UI

SuperTokens requires that the third party provider gives an email for the user. If that's not the case for a certain provider, the user sees the following UI.

<img src="/img/thirdparty-no-email.png" alt="No email UI for provider" />

## General error UI

If there are network related errors, or the backend sends a status code >= 300, then the following UI shows. This UI also appears if there is a similar error in the callback page.

<img src="/img/thirdparty-general-error.png" alt="Sign in form general error" />

</Accordion>

# References - Frontend SDKs - User Interface -  ## Overview
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/changing-colours

You can update the default theme with your colors to make it fit with your website. Define a few CSS variables in the `style` property to the `EmailPassword.init` call.
Specify the colors as RGB (see the following example), because the `rgb` and `rgba` functions apply them.

For example, if your website uses a dark theme, here is how you can customize it:

## Before you start

:::caution no-title
This example is relevant only if you use the prebuilt UI components.
:::

## Example

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    style: `
        [data-supertokens~=container] {
             --palette-background: 51, 51, 51;
            --palette-inputBackground: 41, 41, 41;
            --palette-inputBorder: 41, 41, 41;
            --palette-textTitle: 255, 255, 255;
            --palette-textLabel: 255, 255, 255;
            --palette-textPrimary: 255, 255, 255;
            --palette-error: 173, 46, 46;
            --palette-textInput: 169, 169, 169;
            --palette-textLink: 114,114,114;
            --palette-textGray: 158, 158, 158;
        }
    `,
    // highlight-end 
    recipeList: [ /* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    style: `
        [data-supertokens~=container] {
            --palette-background: 51, 51, 51;
            --palette-inputBackground: 41, 41, 41;
            --palette-inputBorder: 41, 41, 41;
            --palette-textTitle: 255, 255, 255;
            --palette-textLabel: 255, 255, 255;
            --palette-textPrimary: 255, 255, 255;
            --palette-error: 173, 46, 46;
            --palette-textInput: 169, 169, 169;
            --palette-textLink: 114,114,114;
            --palette-textGray: 158, 158, 158;
        }
    `,
    // highlight-end 
    recipeList: [ /* ... */]
});
```
</Tab>
</Tabs>

<img alt="Prebuilt form UI with custom color palette" width="600px" src="/img/emailpassword/signin-dark.png" />

:::important
Changes to the palette apply to all the UI components provided. If you want to change a specific component, please see [this section](changing-style).
:::

### Palette values

| Variable Name | Description | Default Value |
|--------------|-------------|---------------|
| `background` | Background color of all forms | `255, 255, 255` (white) |
| `inputBackground` | Background color of input fields | `250, 250, 250` (light grey) |
| `inputBorder` | Border color of input fields | `224, 224, 224` (light grey) |
| `primary` | Primary color for focused inputs, success states and button backgrounds | `28, 34, 42` |
| `primaryBorder` | Border color for primary buttons | `45, 54, 68` |
| `success` | Color used for success events | `65, 167, 0` (green) |
| `successBackground` | Background color for success notifications | `217, 255, 191` (green) |
| `error` | Color for error highlights and messages | `255, 23, 23` (red) |
| `errorBackground` | Background color for error notifications | `255, 241, 235` (red) |
| `textTitle` | Color of form titles | `0, 0, 0` (black) |
| `textLabel` | Color of form field labels | `0, 0, 0` (black) |
| `textInput` | Color of text in form fields | `0, 0, 0` (black) |
| `textPrimary` | Color of subtitles and footer text | `128, 128, 128` (grey) |
| `textLink` | Color of links | `0, 122, 255` (blue) |
| `buttonText` | Color of text in main buttons | `255, 255, 255` (white) |
| `superTokensBrandingBackground` | Color of SuperTokens branding element | `242, 245, 246` (Alice blue) |
| `superTokensBrandingText` | Color of "Powered by SuperTokens" text | `173, 189, 196` (heather grey) |

# References - Frontend SDKs - User Interface -  ## Overview
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/changing-style

Updating the CSS allows you to change the UI of the components to meet your needs.
This section guides you through an example of updating the look of buttons.
Note that the process can update any HTML tag from within SuperTokens components.

## Before you start

:::caution no-title
This example is relevant only if you use the prebuilt UI components.
:::

---

## Global style changes

First, open the website at `/auth`. The Sign-in widget should show up. Use the browser console to find out the class name that you'd like to overwrite.

<img alt="Inspecting submit button in prebuilt form" width="500px" src="/img/emailpassword/inspect-button.png" />

<img alt="Highlighting attribute for customization" width="500px" src="/img/emailpassword/inspect-button-2.png" />

Each stylable component contains `data-supertokens` attributes (in this example `data-supertokens="button"`). 

Let's customize elements with the `button` attribute. The syntax for styling is plain CSS.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    style: `
        [data-supertokens~=button] {
            background-color: #252571;
            border: 0px;
            width: 30%;
            margin: 0 auto;
        }
    `,
    // highlight-end
    recipeList: [ /* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    style: `
        [data-supertokens~=button] {
            background-color: #252571;
            border: 0px;
            width: 30%;
            margin: 0 auto;
        }
    `,
    // highlight-end
    recipeList: [ /* ... */]
});
```
</Tab>
</Tabs>

The above results in: 

<img alt="Prebuilt form with custom submit button" width="500px" src="/img/emailpassword/signup-centered-blue-button.png" />

### Changing fonts

By default, SuperTokens uses the `Arial` font. The best way to override this is to add a `font-family` styling to the `container` component in the recipe configuration.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    style: `
        [data-supertokens~=container] {
            font-family: cursive;
        }
    `,
    recipeList: [ /* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    style: `
        [data-supertokens~=container] {
            font-family: cursive;
        }
    `,
    recipeList: [ /* ... */]
});
```
</Tab>
</Tabs>

### Using media queries

You may want to have different CSS for different `viewports`. This can happen via media queries like this:

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    style: `
        [data-supertokens~=button] {
            background-color: #252571;
            border: 0px;
            width: 30%;
            margin: 0 auto;
        }

        @media (max-width: 440px) {
            [data-supertokens~=button] {
                width: 90%;
            }
        }
    `,
    recipeList: [ /* ... */],
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    style: `
        [data-supertokens~=button] {
            background-color: #252571;
            border: 0px;
            width: 30%;
            margin: 0 auto;
        }

        @media (max-width: 440px) {
            [data-supertokens~=button] {
                width: 90%;
            }
        }
    `,
    recipeList: [ /* ... */],
});
```
</Tab>
</Tabs>

---

## Customize the sign up and sign in forms

These are the screens shown when the user tries to log in or sign up for the application.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    style: `[data-supertokens~=authPage] {
        ...
    }`,
    recipeList: [ /* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    style: `[data-supertokens~=authPage] {
        ...
    }`,
    recipeList: [ /* ... */]
});
```
</Tab>
</Tabs>

---

## Customize the password reset forms

### Send password reset email form

This form appears when the user clicks on "forgot password" in the sign in form.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        EmailPassword.init({
            // highlight-start
            resetPasswordUsingTokenFeature: {
                enterEmailForm: {
                    style: ` ... `
                }
            }
            // highlight-end
        }), 
        Session.init()
	]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        supertokensUIEmailPassword.init({
            // highlight-start
            resetPasswordUsingTokenFeature: {
                enterEmailForm: {
                    style: ` ... `
                }
            }
            // highlight-end
        }), 
        supertokensUISession.init()
	]
});
```
</Tab>
</Tabs>

### Submit new password form

This screen appears when the user clicks the password reset link on their email - to enter their new password

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        EmailPassword.init({
            // highlight-start
            resetPasswordUsingTokenFeature: {
                submitNewPasswordForm: {
                    style: ` ... `
                }
            }
            // highlight-end
        }), 
        Session.init()
	]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
	recipeList: [
        supertokensUIEmailPassword.init({
            // highlight-start
            resetPasswordUsingTokenFeature: {
                submitNewPasswordForm: {
                    style: ` ... `
                }
            }
            // highlight-end
        }), 
        supertokensUISession.init()
	]
});
```
</Tab>
</Tabs>

# References - Frontend SDKs - User Interface -  Override react components
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/override-react-components

## Overview

SuperTokens allows you to customize the React components by overriding them.
In this context, an override is a new component that renders additional data or adds new functionality.
Each override should also render the original component to ensure the integrity of the authentication UI.

## Before you start

:::caution no-title
This feature is only applicable to React apps that use the prebuilt UI.
:::

## Steps

### 1. Figure out which component to override

Discover the name of the component that you need to override by using the React Developer Tools extension.
Look for the names defined in component override configuration and/or components ending in `_Override` in the component tree.

<img alt="Checking which component from the prebuilt UI is overridden using React Developer Tools extension" src="/img/thirdpartyemailpassword/override/find-component.png" />

### 2. Add your override

Inside the `SuperTokensWrapper`, update the recipe specific override context with your next component.
Make sure that it your override renders the SuperTokens components inside it.

<Question question="Do you use react-router-dom?" defaultAnswer="Yes">
<Answer title="Yes">

```tsx

// @ts-ignore

function App() {
    return (
        <SuperTokensWrapper>
            <AuthRecipeComponentsOverrideContextProvider
                components={{
                    AuthPageHeader_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <div>
                                <img src="octocat.jpg" />
                                <DefaultComponent {...props} />
                            </div>
                        );
                    },
                }}>
                <EmailPasswordComponentsOverrideProvider
                    components={{
                        EmailPasswordSignUpForm_Override: ({ DefaultComponent, ...props }) => {
                            // your customisations here for the email password sign up form...
                            return <DefaultComponent {...props} />;
                        },
                    }}>
                    <ThirdpartyComponentsOverrideProvider
                    components={{
                        ThirdPartySignInAndUpProvidersForm_Override: ({ DefaultComponent, ...props }) => {
                            // optionally override the third party providers list..
                            return <DefaultComponent {...props} />;
                        }
                    }}>
                        {/* Rest of the JSX */}
                    </ThirdpartyComponentsOverrideProvider>
                </EmailPasswordComponentsOverrideProvider>
            </AuthRecipeComponentsOverrideContextProvider>
        </SuperTokensWrapper>
    );
}
export default App;
```
</Answer>

<Answer title="No">

```tsx

// @ts-ignore

function App() {
    if(canHandleRoute([EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI])){
        return (
            <AuthRecipeComponentsOverrideContextProvider
                components={{
                    AuthPageHeader_Override: ({ DefaultComponent, ...props }) => {
                        return (
                            <div>
                                <img src="octocat.jpg" />
                                <DefaultComponent {...props} />
                            </div>
                        );
                    },
                }}>
                <EmailPasswordComponentsOverrideProvider
                    components={{
                        EmailPasswordSignUpForm_Override: ({ DefaultComponent, ...props }) => {
                            // your customisations here for the email password sign up form...
                            return <DefaultComponent {...props} />;
                        },
                    }}>
                    <ThirdpartyComponentsOverrideProvider
                    components={{
                        ThirdPartySignInAndUpProvidersForm_Override: ({ DefaultComponent, ...props }) => {
                            // optionally override the third party providers list..
                            return <DefaultComponent {...props} />;
                        }
                    }}>
                        {getRoutingComponent([EmailPasswordPreBuiltUI, ThirdPartyPreBuiltUI])}
                    </ThirdpartyComponentsOverrideProvider>
                </EmailPasswordComponentsOverrideProvider>
            </AuthRecipeComponentsOverrideContextProvider>
        )
    }
    return (
        <SuperTokensWrapper>
            {/* Rest of the JSX */}
        </SuperTokensWrapper>
    );
}
export default App;
```

</Answer>

</Question>

<img alt="Prebuilt sign in UI with custom image" src="/img/thirdpartyemailpassword/react-override-octocat.png" />

:::important
Please make sure that you specify the configuration in a `.tsx` or ` .jsx` file type.
:::

# References - Frontend SDKs - User Interface -  ## Before you start
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/embed-sign-in-up-form

:::caution no-title
This example is relevant only if you use the React SDK with prebuilt UI components. 
:::

---

## Render the form in a page

The following example shows the scenario where you have a dedicated route, such as `/auth`, for rendering the Auth Widget. Upon a successful login, the user automatically redirects to the return value of `getRedirectionURL` (defaulting to `/`).

<Question
    question="Do you use react-router-dom?" defaultAnswer="Yes">
<Answer title="Yes">

<ReactRouterVersionTabs>

<ReactRouterVersionTabs.Tab value="v6">

```tsx
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "TO_AUTH") {
            return "/auth"; // return the path where you are rendering the Auth UI
        } else if (context.action === "SUCCESS" && context.newSessionCreated) {
            return "/dashboard"; // defaults to "/"
        };
    },
    disableAuthRoute: true,
    // highlight-end
    recipeList: [ /* ... */],
});

function MyAuthPage() {
    const navigate = useNavigate();
    return (
        <div>
            <Header />
            // highlight-next-line
            <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} navigate={navigate} />
            <Footer />
        </div>
    );
}
```

</ReactRouterVersionTabs.Tab>

<ReactRouterVersionTabs.Tab value="v5">

```tsx
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "TO_AUTH") {
            return "/auth"; // return the path where you are rendering the Auth UI
        } else if (context.action === "SUCCESS" && context.newSessionCreated) {
            return "/dashboard"; // defaults to "/"
        };
    },
    disableAuthRoute: true,
    // highlight-end
    recipeList: [ /* ... */],
});

function MyAuthPage() {
    const history = useHistory();
    return (
        <div>
            <Header />
            // highlight-next-line
            <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} navigate={history} />
            <Footer />
        </div>
    );
}
```

</ReactRouterVersionTabs.Tab>

</ReactRouterVersionTabs>

</Answer>
<Answer title="No">

```tsx
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "TO_AUTH") {
            return "/auth"; // return the path where you are rendering the Auth UI
        } else if (context.action === "SUCCESS" && context.newSessionCreated) {
            return "/dashboard"; // defaults to "/"
        };
    },
    disableAuthRoute: true,
    // highlight-end
    recipeList: [ /* ... */],
});

function MyAuthPage() {
    return (
        <div>
            <Header />
            // highlight-next-line
            <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} />
            <Footer />
        </div>
    )
}
```
</Answer>
</Question>

In the above code snippet:

1. Disabled the default Auth UI by setting `disableAuthRoute` to `true`.
2. Override the `getRedirectionURL` function inside the SuperTokens configuration to redirect to `/auth` when login becomes necessary and to redirect to `/dashboard` upon successful login.

Feel free to customize the redirection URLs as needed.

:::note
When the user visits the `/auth` page, they see the SignIn UI by default. To render the SignUp UI, append `show=signup` as a query parameter to the URL, like`/auth?show=signup`.
:::

--- 

## Render the form in a page with no redirection

The following example shows the scenario where you have a dedicated route, such as `/auth`, for rendering the Auth Widget. However, upon a successful login, the user sees a logged in UI instead of getting redirected.

<Question
    question="Do you use react-router-dom?" defaultAnswer="Yes">
<Answer title="Yes">

<ReactRouterVersionTabs>

<ReactRouterVersionTabs.Tab value="v6">

```tsx
// highlight-start
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    disableAuthRoute: true,
    recipeList: [ /* ... */],
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS") {
            return null; // this will not navigate the user away after successful login
        }
    },
    // highlight-end
});

// highlight-start
function LandingPage() {
    let sessionContext = Session.useSessionContext();
    const navigate = useNavigate();
    if (sessionContext.loading) {
        return null;
    }
    if (sessionContext.doesSessionExist) {
        // We wrap this with <SessionAuth /> so that
        // all claims are validated before showing the logged in UI.
        // For example, if email verification is switched on, and
        // the user's email is not verified, then <SessionAuth />
        // will redirect to the email verification page.
        return (
            <Session.SessionAuth>
                <Header />
                    You are logged in!
                <Footer />
            </Session.SessionAuth>
        )
    } else {
        return (
            <div>
                <Header />
                // highlight-next-line
                <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} navigate={navigate} />
                <Footer />
            </div>
        )
    }
}
// highlight-end
```

</ReactRouterVersionTabs.Tab>

<ReactRouterVersionTabs.Tab value="v5">

```tsx
// highlight-start
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    disableAuthRoute: true,
    recipeList: [ /* ... */],
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS") {
            return null; // this will not navigate the user away after successful login
        }
    },
    // highlight-end
});

// highlight-start
function LandingPage() {
    let sessionContext = Session.useSessionContext();
    const history = useHistory();
    if (sessionContext.loading) {
        return null;
    }
    if (sessionContext.doesSessionExist) {
        // We wrap this with <SessionAuth /> so that
        // all claims are validated before showing the logged in UI.
        // For example, if email verification is switched on, and
        // the user's email is not verified, then <SessionAuth />
        // will redirect to the email verification page.
        return (
            <Session.SessionAuth>
                <Header />
                    You are logged in!
                <Footer />
            </Session.SessionAuth>
        )
    } else {
        return (
            <div>
                <Header />
                // highlight-next-line
                <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} navigate={history} />
                <Footer />
            </div>
        )
    }
}
// highlight-end
```

</ReactRouterVersionTabs.Tab>

</ReactRouterVersionTabs>

</Answer>
<Answer title="No">

```tsx
// highlight-start
// highlight-start
// highlight-end
// @ts-ignore
// @ts-ignore

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    disableAuthRoute: true,
    recipeList: [ /* ... */],
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS") {
            return null; // this will not navigate the user away after successful login
        }
    },
    // highlight-end
});

// highlight-start
function LandingPage() {
    let sessionContext = Session.useSessionContext();
    if (sessionContext.loading) {
        return null;
    }
    if (sessionContext.doesSessionExist) {
        // We wrap this with <SessionAuth /> so that
        // all claims are validated before showing the logged in UI.
        // For example, if email verification is switched on, and
        // the user's email is not verified, then <SessionAuth />
        // will redirect to the email verification page.
        return (
            <Session.SessionAuth>
                <Header />
                    You are logged in!
                <Footer />
            </Session.SessionAuth>
        )
    } else {
        return (
            <div>
                <Header />
                // highlight-next-line
                <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} />
                <Footer />
            </div>
        )
    }
}
// highlight-end
```
</Answer>
</Question>

In the above code snippet, `Session.SessionAuth` wraps the logged-in component to validate all claims before displaying the logged-in UI. For instance, with email verification enabled, if a user's email remains unverified, `Session.SessionAuth` redirects to the email verification page.

:::note
In the above case, redirection may occur if a claim fails. For instance, in the case of an Email Verification claim, if the user's email is not verified, they redirect to the email verification page. To prevent redirection for failed claims, please contact [Discord](https://supertokens.com/discord) for assistance.
:::

--- 

## Render the form in a popup

The following example shows the scenario where you embed the Auth Widget in a popup, and upon successful login, you aim to close the popup.

<Question
    question="Do you use react-router-dom?" defaultAnswer="Yes">
<Answer title="Yes">

<ReactRouterVersionTabs>

<ReactRouterVersionTabs.Tab value="v6">

```tsx
// highlight-start
// highlight-start
// highlight-end

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    disableAuthRoute: true,
    recipeList: [ /* ... */],
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS") {
            return null; // this will not navigate the user away after successful login
        }
    },
    // highlight-end
});

function AuthPopup() {
  let sessionContext = Session.useSessionContext();
  const navigate = useNavigate();
  const [isModalOpen, setIsModalOpen] = useState(false);

  const openModal = () => setIsModalOpen(true);
  const closeModal = () => setIsModalOpen(false);

  useEffect(() => {
    if (sessionContext.loading) {
      return;
    }
    if (sessionContext.doesSessionExist) {
      closeModal();
    } else {
      openModal();
    }
  }, [sessionContext]);

  if (sessionContext.loading) {
    return null;
  }

  return (
    <div style={{ textAlign: "center" }}>
      {sessionContext.doesSessionExist && (
        // We wrap this with <SessionAuth /> so that
        // all claims are validated before showing the logged in UI.
        // For example, if email verification is switched on, and
        // the user's email is not verified, then <SessionAuth />
        // will redirect to the email verification page.
        <Session.SessionAuth>
          <h2>You are logged In! </h2>
          <h3>UserId: {sessionContext.userId}</h3>
          <button onClick={() => Session.signOut()}>Sign Out</button>
        </Session.SessionAuth>
      )}

      <Modal
        isOpen={isModalOpen}
        contentLabel="Auth Modal"
      >
        {/* highlight-next-line */}
        <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} navigate={navigate} />
      </Modal>
    </div>
  );
}
```

</ReactRouterVersionTabs.Tab>

<ReactRouterVersionTabs.Tab value="v5">

```tsx
// highlight-start
// highlight-start
// highlight-end

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    disableAuthRoute: true,
    recipeList: [ /* ... */],
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS") {
            return null; // this will not navigate the user away after successful login
        }
    },
    // highlight-end
});

function AuthPopup() {
  let sessionContext = Session.useSessionContext();
  const history = useHistory();
  const [isModalOpen, setIsModalOpen] = useState(false);

  const openModal = () => setIsModalOpen(true);
  const closeModal = () => setIsModalOpen(false);

  useEffect(() => {
    if (sessionContext.loading) {
      return;
    }
    if (sessionContext.doesSessionExist) {
      closeModal();
    } else {
      openModal();
    }
  }, [sessionContext]);

  if (sessionContext.loading) {
    return null;
  }

  return (
    <div style={{ textAlign: "center" }}>
      {sessionContext.doesSessionExist && (
        // We wrap this with <SessionAuth /> so that
        // all claims are validated before showing the logged in UI.
        // For example, if email verification is switched on, and
        // the user's email is not verified, then <SessionAuth />
        // will redirect to the email verification page.
        <Session.SessionAuth>
          <h2>You are logged In! </h2>
          <h3>UserId: {sessionContext.userId}</h3>
          <button onClick={() => Session.signOut()}>Sign Out</button>
        </Session.SessionAuth>
      )}

      <Modal
        isOpen={isModalOpen}
        contentLabel="Auth Modal"
      >
        {/* highlight-next-line */}
        <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} navigate={history} />
      </Modal>
    </div>
  );
}
```

</ReactRouterVersionTabs.Tab>

</ReactRouterVersionTabs>

</Answer>
<Answer title="No">

```tsx
// highlight-start
// highlight-start
// highlight-end

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    disableAuthRoute: true,
    recipeList: [ /* ... */],
    // highlight-start
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS") {
            return null; // this will not navigate the user away after successful login
        }
    },
    // highlight-end
});

function AuthPopup() {
  let sessionContext = Session.useSessionContext();
  const [isModalOpen, setIsModalOpen] = useState(false);

  const openModal = () => setIsModalOpen(true);
  const closeModal = () => setIsModalOpen(false);

  useEffect(() => {
    if (sessionContext.loading) {
      return;
    }
    if (sessionContext.doesSessionExist) {
      closeModal();
    } else {
      openModal();
    }
  }, [sessionContext]);

  if (sessionContext.loading) {
    return null;
  }

  return (
    <div style={{ textAlign: "center" }}>
      {sessionContext.doesSessionExist && (
        // We wrap this with <SessionAuth /> so that
        // all claims are validated before showing the logged in UI.
        // For example, if email verification is switched on, and
        // the user's email is not verified, then <SessionAuth />
        // will redirect to the email verification page.
        <Session.SessionAuth>
          <h2>You are logged In! </h2>
          <h3>UserId: {sessionContext.userId}</h3>
          <button onClick={() => Session.signOut()}>Sign Out</button>
        </Session.SessionAuth>
      )}

      <Modal
        isOpen={isModalOpen}
        contentLabel="Auth Modal"
      >
        {/* highlight-next-line */}
        <AuthPage preBuiltUIList={[EmailPasswordPreBuiltUI]} />
      </Modal>
    </div>
  );
}
```
</Answer>
</Question>

:::note
In the above case, redirection may occur if a claim fails. For instance, in the case of an Email Verification claim, if the user's email is not verified, they redirect to the email verification page. To prevent redirection for failed claims, please contact [Discord](https://supertokens.com/discord) for assistance.
:::

# References - Frontend SDKs - User Interface -  ## Overview
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/shadow-dom

SuperTokens uses [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM) to prevent CSS clashes between your CSS and the ones provided by SuperTokens.
This guarantees that all the prebuilt UI renders as expected.

However, this has a few problems:
- You cannot override the prebuilt UI CSS directly through your CSS files.
You need to use JavaScript to achieve this.
- Password managers may not work for your end user.

## Before you start

:::caution no-title
This example is relevant only if you use the prebuilt UI components.
:::

## Example

If you want to disable use of shadow dom, you can do this like:

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-next-line
    useShadowDom: false,
    recipeList: [/* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-next-line
    useShadowDom: false,
    recipeList: [/* ... */]
});
```
</Tab>
</Tabs>

:::caution
If disabled, please be sure to check that the components render correctly - because your CSS might affect the components' UI (the other way around does not happen).
:::

# References - Frontend SDKs - User Interface -  ## Overview
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/toc-privacypolicy

You can provide a Privacy policy and Terms of service link which renders the following text on the sign up page:
- Provided both links: "By signing up, you agree to the [Terms of Service](./toc-privacypolicy) and [Privacy Policy](./toc-privacypolicy)"
- Provided only Terms of service link: "By signing up, you agree to the [Terms of Service](./toc-privacypolicy)"
- Provided only Privacy policy link: "By signing up, you agree to the [Privacy Policy](./toc-privacypolicy)"

## Before you start

:::caution no-title
This feature is only applicable to React apps that use the prebuilt UI.
:::

## Example

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    termsOfServiceLink: "https://example.com/terms-of-service",
    privacyPolicyLink: "https://example.com/privacy-policy",
    // highlight-end
    recipeList: [/* ... */]
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)

supertokensUIInit({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    // highlight-start
    termsOfServiceLink: "https://example.com/terms-of-service",
    privacyPolicyLink: "https://example.com/privacy-policy",
    // highlight-end
    recipeList: [/* ... */]
});
```

</Tab>
</Tabs>

# References - Frontend SDKs - User Interface -  ## Overview
Source: https://supertokens.com/docs/references/frontend-sdks/prebuilt-ui/translations

You can translate the UI using two main methods:
1. You can override all displayed translation strings by providing translated versions for different languages (and even change the default English version).
2. You can provide a translation function to integrate SuperTokens with your preferred internationalization library.

## Before you start

:::caution no-title
This feature is only applicable to React apps that use the prebuilt UI.
:::

---

## Using translation strings

### 1. Provide translation strings

You can provide translations for each segment displayed in the user interfaces.

:::info Important
- You can find the auth page header / footer UI keys in the [GitHub repository](https://github.com/supertokens/supertokens-auth-react/blob/master/lib/ts/translation/translations.ts).
- You can find the `emailpassword` login UI keys in the [GitHub repository](https://github.com/supertokens/supertokens-auth-react/blob/master/lib/ts/recipe/emailpassword/components/themes/translations.ts).
:::

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    // highlight-start
    languageTranslations: { // This object contains all translation related options
        translations: { // These are the displayed translation strings for each language
          // The property names define the language code of the translations
          en: {
            // Here each key is a translation key and the value is the string that will be displayed
            // Setting the value to undefined will either display the translation from the default language or the translation key
            BRANDING_POWERED_BY_START: "We ❤️ ",
            // If you added a custom label or placeholder you can also provide translation for them if necessary
            // You can also use these to provide translations for your component overrides
            MY_CUSTOM_LABEL: "Age",
          },
          hu: {
            BRANDING_POWERED_BY_START: "Sok szeretettel: ",
            // This key is associated with an empty string by default, but you can override these as well.
            BRANDING_POWERED_BY_END: " 😊",
          }
        },
        /* 
         * This optional property sets the default and fallback language. 
         * It can be any string that will be used to fetch translations from the above object.
         * Defaults to "en"
         */
        defaultLanguage: "hu", 
    },
    // highlight-end
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      // ...
    ],
});
```
</Tab>

<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    // highlight-start
    languageTranslations: { // This object contains all translation related options
        translations: { // These are the displayed translation strings for each language
          // The property names define the language code of the translations
          en: {
            // Here each key is a translation key and the value is the string that will be displayed
            // Setting the value to undefined will either display the translation from the default language or the translation key
            BRANDING_POWERED_BY_START: "We ❤️ ",
            // If you added a custom label or placeholder you can also provide translation for them if necessary
            // You can also use these to provide translations for your component overrides
            MY_CUSTOM_LABEL: "Age",
          },
          hu: {
            BRANDING_POWERED_BY_START: "Sok szeretettel: ",
            // This key is associated with an empty string by default, but you can override these as well.
            BRANDING_POWERED_BY_END: " 😊",
          }
        },
        /* 
         * This optional property sets the default and fallback language. 
         * It can be any string that will be used to fetch translations from the above object.
         * Defaults to "en"
         */
        defaultLanguage: "hu", 
    },
    // highlight-end
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      // ...
    ],
});
```
</Tab>

</Tabs>

### 2. Load translations

After initialization, you can provide additional translation data by calling the `SuperTokens.loadTranslation`. This can be useful if you are loading them asynchronously.

<Tabs>
<Tab value="reactjs">

```tsx

// This method takes an object as a parameter, which is structured the same as above.
// This will be merged into the existing definitions, so any properties missing here won't remove them from the already loaded translations
SuperTokens.loadTranslation({
  en: {
    BRANDING_POWERED_BY_END: " :)",
  }
});
```
</Tab>
<Tab value="angular">

```tsx
// This method takes an object as a parameter, which is structured the same as above.
// This will be merged into the existing definitions, so any properties missing here won't remove them from the already loaded translations
supertokensUI.loadTranslation({
  en: {
    BRANDING_POWERED_BY_END: " :)",
  }
});
```
</Tab>
</Tabs>

### 3. Change the current language

You can update which translations store displays by calling the `SuperTokens.changeLanguage`.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.changeLanguage("hu");
```
</Tab>
<Tab value="angular">

```tsx
supertokensUI.changeLanguage("hu");
```
</Tab>
</Tabs>

---

## Using an internationalization library

You can integrate SuperTokens with your internationalization library of choice.
You can check out an example using i18next in the [GitHub repository](https://github.com/supertokens/supertokens-auth-react/blob/master/examples/with-i18next/src/App.js).
To do this you need to do two things:

1. Provide the translation function in `SuperTokens.init`

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    // highlight-start
    languageTranslations: {
        translationFunc: (key: string) => {
          // The string returned by this function will be displayed
          return key + "!";
        },
    },
    // highlight-end
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      // ...
    ],
});
```
</Tab>
<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    // highlight-start
    languageTranslations: {
        translationFunc: (key: string) => {
          // The string returned by this function will be displayed
          return key + "!";
        },
    },
    // highlight-end
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      // ...
    ],
});
```
</Tab>
</Tabs>

2. Call `SuperTokens.changeLanguage` or `SuperTokens.loadTranslation` to re-render the translated UI

This is necessary, because the SDK only re-renders and updates the displayed strings after calling either of the above functions.
You can do this in event handlers, when updating the language choice or while adding new translation data.

---

## Partial translations

If the SDK can't find a segment in the current language's translation store, it checks the default language store and uses the translation from there.
The raw translation key displays if it's also missing from the default store. For example, this can happen for custom error messages returned by the backend API.

---

## Save language preferences

The system stores the chosen language in a cookie, allowing it to restore the language the next time the page loads. You can customize the domain of this cookie through the `currentLanguageCookieScope` option. This can be useful if you are running the SDK in multiple applications and want to share the language choice between sub-domains.

<Tabs>
<Tab value="reactjs">

```tsx

SuperTokens.init({
    // highlight-start
    languageTranslations: {
        currentLanguageCookieScope: ".example.com",
    },
    // highlight-end
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      // ...
    ],
});
```
</Tab>
<Tab value="angular">

```tsx
// this goes in the auth route config of your frontend app (once the pre-built UI script has been loaded)
supertokensUIInit({
    // highlight-start
    languageTranslations: {
        currentLanguageCookieScope: ".example.com",
    },
    // highlight-end
    appInfo: {
        appName: "...",
        apiDomain: "...",
        websiteDomain: "...",
    },
    recipeList: [
      // ...
    ],
});
```
</Tab>
</Tabs>

---

## Translations in component overrides

The SDK also exports the `useTranslation` React hook you can use while overriding components. It returns a function that takes a translation segment key and returns it translated to the selected language. For more information on what translation keys you should use and the exact syntax, please see the original source code of the component you are overriding.

<Tabs>
<Tab value="reactjs">

```tsx

export const HeaderOverride = () => {
    const t = useTranslation();

    return (
        <div>
            <img src="octocat.jpg" />
            {t("MY_TRANSLATION_KEY") /* You can use your own custom translation keys as well as the default ones */}
        </div>
    );
};
```

</Tab>
<Tab value="angular">

:::info Caution
Not applicable for non react apps.
:::

</Tab>
</Tabs>

# References - Frontend SDKs - React SDK Reference -  SuperTokens React
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/package

## Classes

### default

Defined in: [index.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L33)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="gettranslationfunction"></a> `getTranslationFunction` | `static` | \<`T`\>(...`stores`) => (`key`, `replacements?`) => `string` | `getTranslationFunction` | [index.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L70) |
| <a id="supertokenswrapper"></a> `SuperTokensWrapper` | `static` | `any` | `SuperTokensWrapper` | [index.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L34) |
| <a id="usetranslation"></a> `useTranslation` | `static` | `any` | `useTranslation` | [index.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L68) |
| <a id="useusercontext"></a> `useUserContext` | `static` | `any` | `useUserContext` | [index.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L72) |

#### Methods

##### changeLanguage()

```ts
static changeLanguage(language): Promise<void>;
```

Defined in: [index.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L40)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `language` | `string` |

###### Returns

`Promise`\<`void`\>

##### init()

```ts
static init(config): void;
```

Defined in: [index.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L36)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensConfig`](types.mdx#supertokensconfig) |

###### Returns

`void`

##### isRecipeInitialized()

```ts
static isRecipeInitialized(recipeId): any;
```

Defined in: [index.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L62)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeId` | `string` |

###### Returns

`any`

##### loadTranslation()

```ts
static loadTranslation(store): void;
```

Defined in: [index.ts:44](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L44)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `store` | [`TranslationStore`](#translationstore) |

###### Returns

`void`

##### redirectToAuth()

```ts
static redirectToAuth(options?): Promise<any>;
```

Defined in: [index.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L48)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | \{ `navigate?`: [`Navigate`](types.mdx#navigate-1); `queryParams?`: `any`; `redirectBack?`: `boolean`; `show?`: `"signin"` \| `"signup"`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `options.navigate?` | [`Navigate`](types.mdx#navigate-1) |
| `options.queryParams?` | `any` |
| `options.redirectBack?` | `boolean` |
| `options.show?` | `"signin"` \| `"signup"` |
| `options.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`any`\>

## Type Aliases

### TranslationStore

```ts
type TranslationStore = Record<string, Record<string, string | undefined>>;
```

Defined in: [translation/translationHelpers.ts:7](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/translation/translationHelpers.ts#L7)

## Variables

### changeLanguage()

```ts
const changeLanguage: (language) => Promise<void> = SuperTokensAPIWrapper.changeLanguage;
```

Defined in: [index.ts:76](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L76)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `language` | `string` |

#### Returns

`Promise`\<`void`\>

***

### init()

```ts
const init: (config) => void = SuperTokensAPIWrapper.init;
```

Defined in: [index.ts:75](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L75)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensConfig`](types.mdx#supertokensconfig) |

#### Returns

`void`

***

### isRecipeInitialized()

```ts
const isRecipeInitialized: (recipeId) => any = SuperTokensAPIWrapper.isRecipeInitialized;
```

Defined in: [index.ts:79](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L79)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeId` | `string` |

#### Returns

`any`

***

### loadTranslation()

```ts
const loadTranslation: (store) => void = SuperTokensAPIWrapper.loadTranslation;
```

Defined in: [index.ts:77](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L77)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `store` | [`TranslationStore`](#translationstore) |

#### Returns

`void`

***

### redirectToAuth()

```ts
const redirectToAuth: (options?) => Promise<any> = SuperTokensAPIWrapper.redirectToAuth;
```

Defined in: [index.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/index.ts#L78)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | \{ `navigate?`: [`Navigate`](types.mdx#navigate-1); `queryParams?`: `any`; `redirectBack?`: `boolean`; `show?`: `"signin"` \| `"signup"`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `options.navigate?` | [`Navigate`](types.mdx#navigate-1) |
| `options.queryParams?` | `any` |
| `options.redirectBack?` | `boolean` |
| `options.show?` | `"signin"` \| `"signup"` |
| `options.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`any`\>

***

### SuperTokensWrapper

```ts
SuperTokensWrapper: any;
```

## Functions

### getTranslationFunction()

```ts
function getTranslationFunction<T>(...stores): (key, replacements?) => string;
```

Defined in: [translation/translationHelpers.ts:77](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/translation/translationHelpers.ts#L77)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `string` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`stores` | [`TranslationStore`](#translationstore)[] |

#### Returns

```ts
(key, replacements?): string;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `key` | `T` |
| `replacements?` | `Record`\<`string`, `string`\> |

##### Returns

`string`

## References

### SuperTokensConfig

Re-exports [SuperTokensConfig](types.mdx#supertokensconfig)

***

### SuperTokensPlugin

Re-exports [SuperTokensPlugin](types.mdx#supertokensplugin)

***

### SuperTokensPublicConfig

Re-exports [SuperTokensPublicConfig](types.mdx#supertokenspublicconfig)

***

### SuperTokensPublicPlugin

Re-exports [SuperTokensPublicPlugin](types.mdx#supertokenspublicplugin)

***

### useTranslation

Renames and re-exports [SuperTokensWrapper](#supertokenswrapper-1)

***

### useUserContext

Renames and re-exports [SuperTokensWrapper](#supertokenswrapper-1)

# References - Frontend SDKs - React SDK Reference -  SuperTokens React Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/types

## Type Aliases

### AllRecipeComponentOverrides

```ts
type AllRecipeComponentOverrides = object;
```

Defined in: [types.ts:509](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L509)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authrecipe"></a> `authRecipe` | `AuthRecipeComponentOverrideMap` | [types.ts:519](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L519) |
| <a id="emailpassword"></a> `emailpassword` | [`ComponentOverrideMap`](recipe-emailpassword-types.mdx#componentoverridemap) | [types.ts:510](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L510) |
| <a id="emailverification"></a> `emailverification` | [`ComponentOverrideMap`](recipe-emailverification-types.mdx#componentoverridemap) | [types.ts:511](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L511) |
| <a id="multifactorauth"></a> `multifactorauth` | [`ComponentOverrideMap`](recipe-multifactorauth-types.mdx#componentoverridemap) | [types.ts:512](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L512) |
| <a id="multitenancy"></a> `multitenancy` | [`ComponentOverrideMap`](recipe-multitenancy-types.mdx#componentoverridemap) | [types.ts:513](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L513) |
| <a id="oauth2provider"></a> `oauth2provider` | [`ComponentOverrideMap`](recipe-oauth2provider-types.mdx#componentoverridemap) | [types.ts:514](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L514) |
| <a id="passwordless"></a> `passwordless` | [`ComponentOverrideMap`](recipe-passwordless-types.mdx#componentoverridemap) | [types.ts:515](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L515) |
| <a id="session"></a> `session` | [`ComponentOverrideMap`](recipe-session-types.mdx#componentoverridemap) | [types.ts:516](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L516) |
| <a id="thirdparty"></a> `thirdparty` | [`ComponentOverrideMap`](recipe-thirdparty-types.mdx#componentoverridemap) | [types.ts:517](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L517) |
| <a id="totp"></a> `totp` | [`ComponentOverrideMap`](recipe-totp-types.mdx#componentoverridemap) | [types.ts:518](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L518) |
| <a id="webauthn"></a> `webauthn` | [`ComponentOverrideMap`](recipe-webauthn-types.mdx#componentoverridemap) | [types.ts:520](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L520) |

***

### AllRecipeConfigs

```ts
type AllRecipeConfigs = object;
```

Defined in: [types.ts:496](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L496)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailpassword-1"></a> `emailpassword` | [`Config`](recipe-emailpassword-types.mdx#config) | [types.ts:497](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L497) |
| <a id="emailverification-1"></a> `emailverification` | [`Config`](recipe-emailverification-types.mdx#config) | [types.ts:498](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L498) |
| <a id="multifactorauth-1"></a> `multifactorauth` | [`Config`](recipe-multifactorauth-types.mdx#config) | [types.ts:499](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L499) |
| <a id="multitenancy-1"></a> `multitenancy` | [`UserInput`](recipe-multitenancy-types.mdx#userinput) | [types.ts:500](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L500) |
| <a id="oauth2provider-1"></a> `oauth2provider` | [`UserInput`](recipe-oauth2provider-types.mdx#userinput) | [types.ts:501](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L501) |
| <a id="passwordless-1"></a> `passwordless` | [`Config`](recipe-passwordless-types.mdx#config) | [types.ts:502](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L502) |
| <a id="session-1"></a> `session` | [`InputType`](recipe-session-types.mdx#inputtype) | [types.ts:503](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L503) |
| <a id="thirdparty-1"></a> `thirdparty` | [`Config`](recipe-thirdparty-types.mdx#config) | [types.ts:504](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L504) |
| <a id="totp-1"></a> `totp` | [`Config`](recipe-totp-types.mdx#config) | [types.ts:505](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L505) |
| <a id="webauthn-1"></a> `webauthn` | [`Config`](recipe-webauthn-types.mdx#config) | [types.ts:506](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L506) |

***

### APIFormField

```ts
type APIFormField = object;
```

Defined in: [types.ts:340](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L340)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id"></a> `id` | `string` | [types.ts:344](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L344) |
| <a id="value"></a> `value` | `string` | [types.ts:349](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L349) |

***

### AppInfoUserInput

```ts
type AppInfoUserInput = object;
```

Defined in: [types.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L202)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="apibasepath"></a> `apiBasePath?` | `string` | - | [types.ts:222](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L222) |
| <a id="apidomain"></a> `apiDomain` | `string` | - | [types.ts:211](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L211) |
| <a id="apigatewaypath"></a> `apiGatewayPath?` | `string` | An API gateway may be used which prepends a path to the API route. That path should be specified here. | [types.ts:234](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L234) |
| <a id="appname"></a> `appName` | `string` | - | [types.ts:206](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L206) |
| <a id="websitebasepath"></a> `websiteBasePath?` | `string` | - | [types.ts:228](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L228) |
| <a id="websitedomain"></a> `websiteDomain` | `string` | - | [types.ts:216](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L216) |

***

### AuthComponent\<T\>

```ts
type AuthComponent<T> = 
  | PartialAuthComponent
| FullPageAuthComponent<T>;
```

Defined in: [types.ts:491](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L491)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `any` |

***

### AuthComponentProps

```ts
type AuthComponentProps = object;
```

Defined in: [types.ts:457](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L457)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="children"></a> `children?` | `React.ReactNode` | [types.ts:469](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L469) |
| <a id="clearerror"></a> `clearError` | () => `void` | [types.ts:467](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L467) |
| <a id="error"></a> `error` | `string` \| `undefined` | [types.ts:465](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L465) |
| <a id="navigate"></a> `navigate` | [`Navigate`](#navigate-1) \| `undefined` | [types.ts:463](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L463) |
| <a id="onauthsuccess"></a> `onAuthSuccess` | (`successContext`) => `Promise`\<`void`\> | [types.ts:462](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L462) |
| <a id="onerror"></a> `onError` | (`err`) => `void` | [types.ts:466](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L466) |
| <a id="onsigninupswitcherclick"></a> `onSignInUpSwitcherClick` | () => `void` | [types.ts:460](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L460) |
| <a id="rebuildauthpage"></a> `rebuildAuthPage` | () => `void` | [types.ts:461](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L461) |
| <a id="resetfactorlist"></a> `resetFactorList` | () => `void` | [types.ts:459](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L459) |
| <a id="setfactorlist"></a> `setFactorList` | (`factorIds`) => `void` | [types.ts:458](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L458) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [types.ts:468](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L468) |
| <a id="usercontext"></a> `userContext` | [`UserContext`](#usercontext-1) | [types.ts:464](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L464) |

***

### Awaited\<T\>

```ts
type Awaited<T> = T extends null | undefined ? T : T extends object & object ? F extends (value, ...args) => any ? V : never : T;
```

Defined in: [types.ts:432](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L432)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

***

### BaseFeatureComponentMap

```ts
type BaseFeatureComponentMap = Record<string, ComponentWithRecipeAndMatchingMethod[]>;
```

Defined in: [types.ts:299](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L299)

***

### ComponentWithRecipeAndMatchingMethod

```ts
type ComponentWithRecipeAndMatchingMethod = object;
```

Defined in: [types.ts:280](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L280)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="component"></a> `component` | [`ReactComponentClass`](#reactcomponentclass) | - | [types.ts:284](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L284) |
| <a id="matches"></a> `matches` | () => `boolean` | - | [types.ts:289](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L289) |
| <a id="recipeid"></a> `recipeID` | `string` | Recipe ID this component belongs | [types.ts:294](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L294) |

***

### CreateRecipeFunction()\<T, S, R, N\>

```ts
type CreateRecipeFunction<T, S, R, N> = (appInfo, enableDebugLogs) => BaseRecipeModule<T, S, R, N>;
```

Defined in: [types.ts:197](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L197)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `S` |
| `R` |
| `N` *extends* `NormalisedRecipeModuleConfig`\<`T`, `S`, `R`\> |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) |
| `enableDebugLogs` | `boolean` |

#### Returns

`BaseRecipeModule`\<`T`, `S`, `R`, `N`\>

***

### FeatureBaseConfig

```ts
type FeatureBaseConfig = object;
```

Defined in: [types.ts:407](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L407)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="style"></a> `style?` | `string` | [types.ts:411](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L411) |

***

### FeatureBaseProps\<T\>

```ts
type FeatureBaseProps<T> = PropsWithChildren<object & T>;
```

Defined in: [types.ts:425](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L425)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | `Record`\<`string`, `unknown`\> |

***

### FormField

```ts
type FormField = FormFieldBaseConfig & object;
```

Defined in: [types.ts:328](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L328)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `optional?` | `boolean` | [types.ts:337](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L337) |
| `validate()?` | (`value`) => `Promise`\<`string` \| `undefined`\> | [types.ts:332](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L332) |

***

### FormFieldBaseConfig

```ts
type FormFieldBaseConfig = object;
```

Defined in: [types.ts:301](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L301)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getdefaultvalue"></a> `getDefaultValue?` | () => `string` | [types.ts:320](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L320) |
| <a id="id-1"></a> `id` | `string` | [types.ts:305](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L305) |
| <a id="label"></a> `label` | `string` | [types.ts:310](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L310) |
| <a id="nonoptionalerrormsg"></a> `nonOptionalErrorMsg?` | `string` | [types.ts:325](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L325) |
| <a id="placeholder"></a> `placeholder?` | `string` | [types.ts:315](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L315) |

***

### FullPageAuthComponent\<PreloadInfoType\>

```ts
type FullPageAuthComponent<PreloadInfoType> = object;
```

Defined in: [types.ts:474](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L474)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `PreloadInfoType` | `any` |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="component-1"></a> `component` | `React.FC`\<[`FullPageAuthComponentProps`](#fullpageauthcomponentprops)\<`PreloadInfoType`\>\> | [types.ts:481](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L481) |
| <a id="preloadinfoandrunchecks"></a> `preloadInfoAndRunChecks` | (`firstFactors`, `userContext`, `isSignUp`) => `Promise`\< \| \{ `preloadInfo`: `PreloadInfoType`; `shouldDisplay`: `true`; \} \| \{ `shouldDisplay`: `false`; \}\> | [types.ts:476](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L476) |
| <a id="type"></a> `type` | `"FULL_PAGE"` | [types.ts:475](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L475) |

***

### FullPageAuthComponentProps\<PreloadInfoType\>

```ts
type FullPageAuthComponentProps<PreloadInfoType> = AuthComponentProps & object;
```

Defined in: [types.ts:472](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L472)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `preloadInfo` | `PreloadInfoType` | [types.ts:472](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L472) |

#### Type Parameters

| Type Parameter |
| ------ |
| `PreloadInfoType` |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | {
  action: "TO_AUTH";
  showSignIn?: boolean;
}
| SuccessRedirectContextInApp>;
```

Defined in: [types.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L72)

***

### Navigate

```ts
type Navigate = 
  | {
  goBack: () => void;
  push: (path) => void;
}
  | NavigateFunction;
```

Defined in: [types.ts:448](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L448)

***

### NonPublicConfigPropertiesType

```ts
type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];
```

Defined in: [types.ts:566](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L566)

***

### NormalisedAppInfo

```ts
type NormalisedAppInfo = object;
```

Defined in: [types.ts:248](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L248)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apibasepath-1"></a> `apiBasePath` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [types.ts:268](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L268) |
| <a id="apidomain-1"></a> `apiDomain` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [types.ts:257](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L257) |
| <a id="appname-1"></a> `appName` | `string` | [types.ts:252](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L252) |
| <a id="websitebasepath-1"></a> `websiteBasePath` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [types.ts:274](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L274) |
| <a id="websitedomain-1"></a> `websiteDomain` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [types.ts:262](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L262) |

***

### NormalisedBaseConfig

```ts
type NormalisedBaseConfig = object;
```

Defined in: [types.ts:414](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L414)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="style-1"></a> `style` | `string` | [types.ts:418](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L418) |

***

### NormalisedConfigWithAppInfoAndRecipeID\<NormalisedConfig\>

```ts
type NormalisedConfigWithAppInfoAndRecipeID<NormalisedConfig> = NormalisedConfig & object;
```

Defined in: [types.ts:243](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L243)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [types.ts:244](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L244) |
| `recipeId` | `string` | [types.ts:245](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L245) |

#### Type Parameters

| Type Parameter |
| ------ |
| `NormalisedConfig` |

***

### NormalisedFormField

```ts
type NormalisedFormField = object;
```

Defined in: [types.ts:352](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L352)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="autocomplete"></a> `autoComplete?` | `string` | [types.ts:386](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L386) |
| <a id="autofocus"></a> `autofocus?` | `boolean` | [types.ts:391](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L391) |
| <a id="getdefaultvalue-1"></a> `getDefaultValue?` | () => `string` | [types.ts:396](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L396) |
| <a id="hidden"></a> `hidden?` | `boolean` | [types.ts:398](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L398) |
| <a id="id-2"></a> `id` | `string` | [types.ts:356](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L356) |
| <a id="label-1"></a> `label` | `string` | [types.ts:361](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L361) |
| <a id="nonoptionalerrormsg-1"></a> `nonOptionalErrorMsg?` | `string` | [types.ts:381](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L381) |
| <a id="optional"></a> `optional` | `boolean` | [types.ts:376](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L376) |
| <a id="placeholder-1"></a> `placeholder` | `string` | [types.ts:366](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L366) |
| <a id="validate"></a> `validate` | (`value`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [types.ts:371](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L371) |

***

### NormalisedGetRedirectionURLContext\<RecipeContext\>

```ts
type NormalisedGetRedirectionURLContext<RecipeContext> = RecipeContext & object;
```

Defined in: [types.ts:492](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L492)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `tenantIdFromQueryParams` | `string` \| `undefined` | [types.ts:493](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L493) |

#### Type Parameters

| Type Parameter |
| ------ |
| `RecipeContext` |

***

### PartialAuthComponent

```ts
type PartialAuthComponent = object;
```

Defined in: [types.ts:484](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L484)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="component-2"></a> `component` | `React.FC`\<[`PartialAuthComponentProps`](#partialauthcomponentprops)\> | [types.ts:488](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L488) |
| <a id="displayorder"></a> `displayOrder` | `number` | [types.ts:487](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L487) |
| <a id="factorids"></a> `factorIds` | `string`[] | [types.ts:486](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L486) |
| <a id="type-1"></a> `type` | `"SIGN_IN_UP"` \| `"SIGN_IN"` \| `"SIGN_UP"` | [types.ts:485](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L485) |

***

### PartialAuthComponentProps

```ts
type PartialAuthComponentProps = AuthComponentProps;
```

Defined in: [types.ts:471](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L471)

***

### PluginRouteHandler

```ts
type PluginRouteHandler = object;
```

Defined in: [types.ts:529](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L529)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="handler"></a> `handler` | () => `JSX.Element` | [types.ts:531](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L531) |
| <a id="path"></a> `path` | `string` | [types.ts:530](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L530) |

***

### ReactComponentClass\<P\>

```ts
type ReactComponentClass<P> = ComponentClass<P, any> | (props) => JSX.Element;
```

Defined in: [types.ts:401](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L401)

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `P` | `any` |

***

### RecipeFeatureComponentMap

```ts
type RecipeFeatureComponentMap = Record<string, ComponentWithRecipeAndMatchingMethod>;
```

Defined in: [types.ts:297](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L297)

***

### RecipeInitResult\<T, Action, R, P\>

```ts
type RecipeInitResult<T, Action, R, P> = object;
```

Defined in: [types.ts:237](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L237)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |
| `Action` |
| `R` |
| `P` *extends* `NormalisedRecipeModuleConfig`\<`T`, `Action`, `R`\> |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authreact"></a> `authReact` | [`CreateRecipeFunction`](#createrecipefunction)\<`T`, `Action`, `R`, `P`\> | [types.ts:239](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L239) |
| <a id="recipeid-1"></a> `recipeID` | `string` | [types.ts:238](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L238) |
| <a id="webjs"></a> `webJS` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\<`Action`\> | [types.ts:240](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L240) |

***

### RecipePluginOverride\<T\>

```ts
type RecipePluginOverride<T> = object;
```

Defined in: [types.ts:523](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L523)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`AllRecipeConfigs`](#allrecipeconfigs) |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="components"></a> `components?` | [`AllRecipeComponentOverrides`](#allrecipecomponentoverrides)\[`T`\] | [types.ts:525](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L525) |
| <a id="config"></a> `config?` | (`config`) => [`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\] | [types.ts:526](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L526) |
| <a id="functions"></a> `functions?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"functions"`\] | [types.ts:524](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L524) |

***

### SessionClaimValidator

```ts
type SessionClaimValidator = SuperTokensWrapper & object;
```

Defined in: [types.ts:90](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L90)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `onFailureRedirection?` | [`ValidationFailureCallback`](#validationfailurecallback) | [types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L92) |
| `showAccessDeniedOnFailure?` | `boolean` | [types.ts:91](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L91) |

***

### SuccessRedirectContext

```ts
type SuccessRedirectContext = 
  | SuccessRedirectContextInApp
  | SuccessRedirectContextOAuth2;
```

Defined in: [types.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L70)

***

### SuccessRedirectContextInApp

```ts
type SuccessRedirectContextInApp = SuccessRedirectContextCommon & object;
```

Defined in: [types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L64)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `action` | `"SUCCESS"` | [types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L64) |
| `redirectToPath?` | `string` | [types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L64) |

***

### SuccessRedirectContextOAuth2

```ts
type SuccessRedirectContextOAuth2 = SuccessRedirectContextCommon & object;
```

Defined in: [types.ts:65](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L65)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `action` | `"SUCCESS_OAUTH2"` | [types.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L66) |
| `frontendRedirectTo` | `string` | [types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L67) |

***

### SuperTokensConfig

```ts
type SuperTokensConfig = object;
```

Defined in: [types.ts:99](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L99)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`AppInfoUserInput`](#appinfouserinput) | - | [types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L103) |
| <a id="clienttype"></a> `clientType?` | `string` | Identifier for the client, such as `web`, `ios`, etc. to be used with thirdparty, multitenancy recipes. | [types.ts:108](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L108) |
| <a id="cookiehandler"></a> `cookieHandler?` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | - | [types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L119) |
| <a id="dateprovider"></a> `dateProvider?` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | - | [types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L123) |
| <a id="defaulttosignup"></a> `defaultToSignUp?` | `boolean` | - | [types.ts:169](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L169) |
| <a id="disableauthroute"></a> `disableAuthRoute?` | `boolean` | - | [types.ts:164](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L164) |
| <a id="enabledebuglogs"></a> `enableDebugLogs?` | `boolean` | - | [types.ts:156](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L156) |
| <a id="experimental"></a> `experimental?` | `object` | Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord | [types.ts:190](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L190) |
| `experimental.plugins?` | [`SuperTokensPlugin`](#supertokensplugin)[] | - | [types.ts:191](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L191) |
| <a id="getredirectionurl"></a> `getRedirectionURL?` | (`context`, `userContext`) => `Promise`\<`string` \| `undefined` \| `null`\> | - | [types.ts:157](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L157) |
| <a id="languagetranslations"></a> `languageTranslations?` | `object` | - | [types.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L127) |
| `languageTranslations.currentLanguageCookieScope?` | `string` | - | [types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L137) |
| `languageTranslations.defaultLanguage?` | `string` | - | [types.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L131) |
| `languageTranslations.translationFunc?` | `TranslationFunc` | - | [types.ts:154](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L154) |
| `languageTranslations.translations?` | [`TranslationStore`](index.mdx#translationstore) | - | [types.ts:149](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L149) |
| <a id="privacypolicylink"></a> `privacyPolicyLink?` | `string` | - | [types.ts:174](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L174) |
| <a id="recipelist"></a> `recipeList` | `object`[] | - | [types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L113) |
| <a id="style-2"></a> `style?` | `string` | - | [types.ts:162](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L162) |
| <a id="termsofservicelink"></a> `termsOfServiceLink?` | `string` | - | [types.ts:179](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L179) |
| <a id="usesdynamicloginmethods"></a> `usesDynamicLoginMethods?` | `boolean` | - | [types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L125) |
| <a id="useshadowdom"></a> `useShadowDom?` | `boolean` | - | [types.ts:163](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L163) |
| <a id="windowhandler"></a> `windowHandler?` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | - | [types.ts:121](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L121) |

***

### SuperTokensConfigWithNormalisedAppInfo

```ts
type SuperTokensConfigWithNormalisedAppInfo = Omit<SuperTokensConfig, "appInfo"> & object;
```

Defined in: [types.ts:568](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L568)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [types.ts:569](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L569) |

***

### SuperTokensPlugin

```ts
type SuperTokensPlugin = object;
```

Defined in: [types.ts:535](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L535)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="compatibleauthreactsdkversions"></a> `compatibleAuthReactSDKVersions?` | `string` \| `string`[] | [types.ts:538](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L538) |
| <a id="compatiblewebjssdkversions"></a> `compatibleWebJSSDKVersions?` | `string` \| `string`[] | [types.ts:539](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L539) |
| <a id="config-1"></a> `config?` | (`config`) => \| `Omit`\<[`SuperTokensPublicConfig`](#supertokenspublicconfig), `"appInfo"`\> \| `undefined` | [types.ts:560](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L560) |
| <a id="dependencies"></a> `dependencies?` | (`config`, `pluginsAbove`, `sdkVersion`) => \| \{ `pluginsToAdd?`: [`SuperTokensPlugin`](#supertokensplugin)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} | [types.ts:541](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L541) |
| <a id="exports"></a> `exports?` | `Record`\<`string`, `any`\> | [types.ts:561](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L561) |
| <a id="generalauthrecipecomponentoverrides"></a> `generalAuthRecipeComponentOverrides?` | `AuthRecipeComponentOverrideMap` | [types.ts:551](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L551) |
| <a id="id-3"></a> `id` | `string` | [types.ts:536](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L536) |
| <a id="init"></a> `init?` | (`config`, `allPlugins`, `sdkVersion`) => `void` | [types.ts:540](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L540) |
| <a id="overridemap"></a> `overrideMap?` | \{ \[recipeId in keyof AllRecipeConfigs\]?: RecipePluginOverride\<recipeId\> & \{ recipeInitRequired?: boolean \| ((sdkVersion: string) =\> boolean) \} \} | [types.ts:546](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L546) |
| <a id="routehandlers"></a> `routeHandlers?` | \| (`config`, `allPlugins`, `sdkVersion`) => \| \{ `routeHandlers`: [`PluginRouteHandler`](#pluginroutehandler)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} \| [`PluginRouteHandler`](#pluginroutehandler)[] | [types.ts:552](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L552) |
| <a id="version"></a> `version?` | `string` | [types.ts:537](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L537) |

***

### SuperTokensPublicConfig

```ts
type SuperTokensPublicConfig = Omit<Omit<SuperTokensConfig, NonPublicConfigPropertiesType>, "appInfo"> & object;
```

Defined in: [types.ts:576](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L576)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [types.ts:577](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L577) |

***

### SuperTokensPublicPlugin

```ts
type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, 
  | "id"
  | "version"
  | "exports"
  | "compatibleAuthReactSDKVersions"
  | "compatibleWebJSSDKVersions"> & object;
```

Defined in: [types.ts:571](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L571)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `initialized` | `boolean` | [types.ts:574](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L574) |

***

### ThemeBaseProps

```ts
type ThemeBaseProps = object;
```

Defined in: [types.ts:421](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L421)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="stylefrominit"></a> `styleFromInit?` | `string` | [types.ts:422](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L422) |

***

### UserContext

```ts
type UserContext = Record<string, any>;
```

Defined in: [types.ts:455](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L455)

***

### ValidationFailureCallback

```ts
type ValidationFailureCallback = 
  | ({
          userContext,
          reason,
      }) => Promise<string | undefined> | string | undefined
  | undefined;
```

Defined in: [types.ts:80](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L80)

***

### WebJSRecipeInterface\<T\>

```ts
type WebJSRecipeInterface<T> = Omit<T, "default" | "init" | "signOut">;
```

Defined in: [types.ts:195](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L195)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

## Variables

### nonPublicConfigProperties

```ts
const nonPublicConfigProperties: readonly ["experimental"];
```

Defined in: [types.ts:564](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/types.ts#L564)

# References - Frontend SDKs - React SDK Reference -  EmailPassword Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-emailpassword-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/emailpassword/types.ts:43](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L43)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailpasswordresetpasswordemail_override"></a> `EmailPasswordResetPasswordEmail_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/emailpassword/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L46) |
| <a id="emailpasswordsigninform_override"></a> `EmailPasswordSignInForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/emailpassword/types.ts:44](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L44) |
| <a id="emailpasswordsignupform_override"></a> `EmailPasswordSignUpForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/emailpassword/types.ts:45](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L45) |
| <a id="emailpasswordsubmitnewpassword_override"></a> `EmailPasswordSubmitNewPassword_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/emailpassword/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L47) |

***

### Config

```ts
type Config = UserInput & AuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/emailpassword/types.ts:61](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L61)

***

### EnterEmailProps

```ts
type EnterEmailProps = NonSignUpFormThemeBaseProps & object;
```

Defined in: [recipe/emailpassword/types.ts:308](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L308)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clearError()` | () => `void` | [recipe/emailpassword/types.ts:311](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L311) |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailpassword/types.ts:313](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L313) |
| `error` | `string` \| `undefined` | [recipe/emailpassword/types.ts:310](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L310) |
| `onBackButtonClicked()` | () => `void` | [recipe/emailpassword/types.ts:314](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L314) |
| `onError()` | (`error`) => `void` | [recipe/emailpassword/types.ts:312](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L312) |
| `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailpassword/types.ts:309](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L309) |

***

### EnterEmailStatus

```ts
type EnterEmailStatus = "READY" | "SENT";
```

Defined in: [recipe/emailpassword/types.ts:327](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L327)

***

### FormBaseAPIResponse\<T\>

```ts
type FormBaseAPIResponse<T> = 
  | object & T
  | {
  formFields: FormFieldError[];
  status: "FIELD_ERROR";
};
```

Defined in: [recipe/emailpassword/types.ts:351](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L351)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

***

### FormBaseProps\<T\>

```ts
type FormBaseProps<T> = object;
```

Defined in: [recipe/emailpassword/types.ts:331](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L331)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="buttonlabel"></a> `buttonLabel` | `string` | [recipe/emailpassword/types.ts:339](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L339) |
| <a id="callapi"></a> `callAPI` | (`fields`, `setValue`) => `Promise`\<[`FormBaseAPIResponse`](#formbaseapiresponse)\<`T`\>\> | [recipe/emailpassword/types.ts:348](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L348) |
| <a id="clearerror"></a> `clearError` | () => `void` | [recipe/emailpassword/types.ts:343](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L343) |
| <a id="footer"></a> `footer?` | `JSX.Element` | [recipe/emailpassword/types.ts:333](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L333) |
| <a id="formdatasupertokens"></a> `formDataSupertokens?` | `string` | [recipe/emailpassword/types.ts:332](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L332) |
| <a id="formfields"></a> `formFields` | [`FormFieldThemeProps`](#formfieldthemeprops)[] | [recipe/emailpassword/types.ts:335](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L335) |
| <a id="onerror"></a> `onError` | (`error`) => `void` | [recipe/emailpassword/types.ts:344](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L344) |
| <a id="onfetcherror"></a> `onFetchError?` | (`err`) => `void` | [recipe/emailpassword/types.ts:345](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L345) |
| <a id="onsuccess"></a> `onSuccess?` | (`result`) => `void` | [recipe/emailpassword/types.ts:346](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L346) |
| <a id="showlabels"></a> `showLabels` | `boolean` | [recipe/emailpassword/types.ts:337](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L337) |
| <a id="validateonblur"></a> `validateOnBlur?` | `boolean` | [recipe/emailpassword/types.ts:341](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L341) |

***

### FormFieldError

```ts
type FormFieldError = object;
```

Defined in: [recipe/emailpassword/types.ts:232](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L232)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="error"></a> `error` | `string` | [recipe/emailpassword/types.ts:241](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L241) |
| <a id="id"></a> `id` | `string` | [recipe/emailpassword/types.ts:236](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L236) |

***

### FormFieldSignInConfig

```ts
type FormFieldSignInConfig = FormFieldBaseConfig;
```

Defined in: [recipe/emailpassword/types.ts:133](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L133)

***

### FormFieldThemeProps

```ts
type FormFieldThemeProps = NormalisedFormField & object;
```

Defined in: [recipe/emailpassword/types.ts:210](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L210)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clearOnSubmit?` | `boolean` | [recipe/emailpassword/types.ts:224](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L224) |
| `inputComponent()?` | (`props`) => `JSX.Element` | [recipe/emailpassword/types.ts:229](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L229) |
| `labelComponent?` | `JSX.Element` | [recipe/emailpassword/types.ts:214](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L214) |
| `showIsRequired?` | `boolean` | [recipe/emailpassword/types.ts:219](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L219) |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<{
  action: "RESET_PASSWORD";
}>;
```

Defined in: [recipe/emailpassword/types.ts:269](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L269)

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedAuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/emailpassword/types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L64)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [recipe/emailpassword/types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L67) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailpassword/types.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L68) |
| `resetPasswordUsingTokenFeature` | [`NormalisedResetPasswordUsingTokenFeatureConfig`](#normalisedresetpasswordusingtokenfeatureconfig) | [recipe/emailpassword/types.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L66) |
| `signInAndUpFeature` | [`NormalisedSignInAndUpFeatureConfig`](#normalisedsigninandupfeatureconfig) | [recipe/emailpassword/types.ts:65](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L65) |

***

### NormalisedEnterEmailForm

```ts
type NormalisedEnterEmailForm = FeatureBaseConfig & object;
```

Defined in: [recipe/emailpassword/types.ts:173](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L173)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `formFields` | [`NormalisedFormField`](types.mdx#normalisedformfield)[] | [recipe/emailpassword/types.ts:174](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L174) |

***

### NormalisedResetPasswordUsingTokenFeatureConfig

```ts
type NormalisedResetPasswordUsingTokenFeatureConfig = object;
```

Defined in: [recipe/emailpassword/types.ts:152](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L152)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="disabledefaultui"></a> `disableDefaultUI` | `boolean` | [recipe/emailpassword/types.ts:156](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L156) |
| <a id="enteremailform"></a> `enterEmailForm` | [`NormalisedEnterEmailForm`](#normalisedenteremailform) | [recipe/emailpassword/types.ts:166](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L166) |
| <a id="submitnewpasswordform"></a> `submitNewPasswordForm` | [`NormalisedSubmitNewPasswordForm`](#normalisedsubmitnewpasswordform) | [recipe/emailpassword/types.ts:161](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L161) |

***

### NormalisedSignInAndUpFeatureConfig

```ts
type NormalisedSignInAndUpFeatureConfig = object;
```

Defined in: [recipe/emailpassword/types.ts:89](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L89)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="signinform"></a> `signInForm` | [`NormalisedSignInFormFeatureConfig`](#normalisedsigninformfeatureconfig) | [recipe/emailpassword/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L98) |
| <a id="signupform"></a> `signUpForm` | [`NormalisedSignUpFormFeatureConfig`](#normalisedsignupformfeatureconfig) | [recipe/emailpassword/types.ts:93](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L93) |

***

### NormalisedSignInFormFeatureConfig

```ts
type NormalisedSignInFormFeatureConfig = NormalisedBaseConfig & object;
```

Defined in: [recipe/emailpassword/types.ts:126](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L126)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `formFields` | [`NormalisedFormField`](types.mdx#normalisedformfield)[] | [recipe/emailpassword/types.ts:130](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L130) |

***

### NormalisedSignUpFormFeatureConfig

```ts
type NormalisedSignUpFormFeatureConfig = NormalisedBaseConfig & object;
```

Defined in: [recipe/emailpassword/types.ts:110](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L110)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `formFields` | [`NormalisedFormField`](types.mdx#normalisedformfield) & `object`[] | [recipe/emailpassword/types.ts:114](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L114) |

***

### NormalisedSubmitNewPasswordForm

```ts
type NormalisedSubmitNewPasswordForm = FeatureBaseConfig & object;
```

Defined in: [recipe/emailpassword/types.ts:169](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L169)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `formFields` | [`NormalisedFormField`](types.mdx#normalisedformfield)[] | [recipe/emailpassword/types.ts:170](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L170) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = 
  | AuthRecipeModuleOnHandleEventContext
  | {
  action: "RESET_PASSWORD_EMAIL_SENT";
  email: string;
  userContext: UserContext;
}
  | {
  action: "PASSWORD_RESET_SUCCESSFUL";
  userContext: UserContext;
}
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
  userContext: UserContext;
};
```

Defined in: [recipe/emailpassword/types.ts:276](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L276)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "EMAIL_PASSWORD_SIGN_UP"
  | "EMAIL_PASSWORD_SIGN_IN"
  | "SEND_RESET_PASSWORD_EMAIL"
  | "SUBMIT_NEW_PASSWORD"
  | "EMAIL_EXISTS";
```

Defined in: [recipe/emailpassword/types.ts:244](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L244)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/emailpassword/types.ts:251](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L251)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/emailpassword/types.ts:255](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L255) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/emailpassword/types.ts:260](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L260) |
| <a id="url"></a> `url` | `string` | [recipe/emailpassword/types.ts:265](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L265) |
| <a id="usercontext"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailpassword/types.ts:266](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L266) |

***

### ResetPasswordUsingTokenThemeProps

```ts
type ResetPasswordUsingTokenThemeProps = object;
```

Defined in: [recipe/emailpassword/types.ts:301](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L301)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailpassword/types.ts:304](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L304) |
| <a id="enteremailform-1"></a> `enterEmailForm` | [`EnterEmailProps`](#enteremailprops) | [recipe/emailpassword/types.ts:302](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L302) |
| <a id="submitnewpasswordform-1"></a> `submitNewPasswordForm` | [`SubmitNewPasswordProps`](#submitnewpasswordprops) \| `undefined` | [recipe/emailpassword/types.ts:303](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L303) |
| <a id="usercontext-1"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailpassword/types.ts:305](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L305) |

***

### ResetPasswordUsingTokenUserInput

```ts
type ResetPasswordUsingTokenUserInput = object;
```

Defined in: [recipe/emailpassword/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L135)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="disabledefaultui-1"></a> `disableDefaultUI?` | `boolean` | [recipe/emailpassword/types.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L139) |
| <a id="enteremailform-2"></a> `enterEmailForm?` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/emailpassword/types.ts:149](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L149) |
| <a id="submitnewpasswordform-2"></a> `submitNewPasswordForm?` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/emailpassword/types.ts:144](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L144) |

***

### SignInAndUpFeatureUserInput

```ts
type SignInAndUpFeatureUserInput = object;
```

Defined in: [recipe/emailpassword/types.ts:75](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L75)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="signinform-1"></a> `signInForm?` | [`SignInFormFeatureUserInput`](#signinformfeatureuserinput) | [recipe/emailpassword/types.ts:86](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L86) |
| <a id="signupform-1"></a> `signUpForm?` | [`SignUpFormFeatureUserInput`](#signupformfeatureuserinput) | [recipe/emailpassword/types.ts:80](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L80) |

***

### SignInFormFeatureUserInput

```ts
type SignInFormFeatureUserInput = FeatureBaseConfig & object;
```

Defined in: [recipe/emailpassword/types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L119)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `formFields?` | [`FormFieldSignInConfig`](#formfieldsigninconfig)[] | [recipe/emailpassword/types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L123) |

***

### SignInThemeProps

```ts
type SignInThemeProps = NonSignUpFormThemeBaseProps & object;
```

Defined in: [recipe/emailpassword/types.ts:186](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L186)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clearError()` | () => `void` | [recipe/emailpassword/types.ts:188](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L188) |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailpassword/types.ts:191](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L191) |
| `onError()` | (`error`) => `void` | [recipe/emailpassword/types.ts:190](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L190) |
| `onFetchError()` | (`error`) => `void` | [recipe/emailpassword/types.ts:189](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L189) |
| `onForgotPasswordClick()` | () => `void` | [recipe/emailpassword/types.ts:192](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L192) |
| `onSuccess()` | (`result`) => `void` | [recipe/emailpassword/types.ts:193](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L193) |
| `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailpassword/types.ts:187](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L187) |
| `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailpassword/types.ts:194](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L194) |

***

### SignUpFormFeatureUserInput

```ts
type SignUpFormFeatureUserInput = FeatureBaseConfig & object;
```

Defined in: [recipe/emailpassword/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L101)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `formFields?` | [`FormField`](types.mdx#formfield) & `object`[] | [recipe/emailpassword/types.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L105) |

***

### SignUpThemeProps

```ts
type SignUpThemeProps = ThemeBaseProps & object;
```

Defined in: [recipe/emailpassword/types.ts:197](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L197)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clearError()` | () => `void` | [recipe/emailpassword/types.ts:199](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L199) |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailpassword/types.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L202) |
| `error` | `string` \| `undefined` | [recipe/emailpassword/types.ts:206](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L206) |
| `formFields` | [`FormFieldThemeProps`](#formfieldthemeprops)[] | [recipe/emailpassword/types.ts:205](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L205) |
| `onError()` | (`error`) => `void` | [recipe/emailpassword/types.ts:201](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L201) |
| `onFetchError()` | (`error`) => `void` | [recipe/emailpassword/types.ts:200](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L200) |
| `onSuccess()` | (`result`) => `void` | [recipe/emailpassword/types.ts:204](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L204) |
| `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailpassword/types.ts:198](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L198) |
| `signInClicked()?` | () => `void` | [recipe/emailpassword/types.ts:203](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L203) |
| `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailpassword/types.ts:207](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L207) |

***

### SubmitNewPasswordProps

```ts
type SubmitNewPasswordProps = NonSignUpFormThemeBaseProps & object;
```

Defined in: [recipe/emailpassword/types.ts:317](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L317)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clearError()` | () => `void` | [recipe/emailpassword/types.ts:320](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L320) |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailpassword/types.ts:322](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L322) |
| `error` | `string` \| `undefined` | [recipe/emailpassword/types.ts:319](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L319) |
| `onError()` | (`error`) => `void` | [recipe/emailpassword/types.ts:321](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L321) |
| `onSignInClicked()` | () => `void` | [recipe/emailpassword/types.ts:323](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L323) |
| `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailpassword/types.ts:318](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L318) |
| `token` | `string` | [recipe/emailpassword/types.ts:324](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L324) |

***

### SubmitNewPasswordStatus

```ts
type SubmitNewPasswordStatus = "READY" | "SUCCESS";
```

Defined in: [recipe/emailpassword/types.ts:329](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L329)

***

### UserInput

```ts
type UserInput = object & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/emailpassword/types.ts:50](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L50)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [recipe/emailpassword/types.ts:53](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L53) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailpassword/types.ts:54](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L54) |
| `resetPasswordUsingTokenFeature?` | [`ResetPasswordUsingTokenUserInput`](#resetpasswordusingtokenuserinput) | [recipe/emailpassword/types.ts:52](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L52) |
| `signInAndUpFeature?` | [`SignInAndUpFeatureUserInput`](#signinandupfeatureuserinput) | [recipe/emailpassword/types.ts:51](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/types.ts#L51) |

# References - Frontend SDKs - React SDK Reference -  EmailPassword
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-emailpassword

## Classes

### default

Defined in: [recipe/emailpassword/index.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L29)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/emailpassword/index.ts:192](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L192) |

#### Methods

##### doesEmailExist()

```ts
static doesEmailExist(input): Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [recipe/emailpassword/index.ts:170](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L170)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

##### getResetPasswordTokenFromURL()

```ts
static getResetPasswordTokenFromURL(input?): string;
```

Defined in: [recipe/emailpassword/index.ts:185](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L185)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`string`

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/emailpassword/index.ts:30](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L30)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailpassword-types.mdx#userinput) |

###### Returns

`any`

##### sendPasswordResetEmail()

```ts
static sendPasswordResetEmail(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK" | "PASSWORD_RESET_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L71)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"PASSWORD_RESET_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

##### signIn()

```ts
static signIn(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}>;
```

Defined in: [recipe/emailpassword/index.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L132)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}\>

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [recipe/emailpassword/index.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L34)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`void`\>

##### signUp()

```ts
static signUp(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}>;
```

Defined in: [recipe/emailpassword/index.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L98)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}\>

##### submitNewPassword()

```ts
static submitNewPassword(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L40)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

## Variables

### doesEmailExist()

```ts
const doesEmailExist: (input) => Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = Wrapper.doesEmailExist;
```

Defined in: [recipe/emailpassword/index.ts:201](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L201)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

***

### EmailPasswordComponentsOverrideProvider

```ts
const EmailPasswordComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/emailpassword/index.ts:203](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L203)

***

### getResetPasswordTokenFromURL()

```ts
const getResetPasswordTokenFromURL: (input?) => string = Wrapper.getResetPasswordTokenFromURL;
```

Defined in: [recipe/emailpassword/index.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L202)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`string`

***

### init()

```ts
const init: (config?) => any = Wrapper.init;
```

Defined in: [recipe/emailpassword/index.ts:195](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L195)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailpassword-types.mdx#userinput) |

#### Returns

`any`

***

### sendPasswordResetEmail()

```ts
const sendPasswordResetEmail: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK" | "PASSWORD_RESET_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}> = Wrapper.sendPasswordResetEmail;
```

Defined in: [recipe/emailpassword/index.ts:198](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L198)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"PASSWORD_RESET_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

***

### signIn()

```ts
const signIn: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}> = Wrapper.signIn;
```

Defined in: [recipe/emailpassword/index.ts:200](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L200)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}\>

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = Wrapper.signOut;
```

Defined in: [recipe/emailpassword/index.ts:196](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L196)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`void`\>

***

### signUp()

```ts
const signUp: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}> = Wrapper.signUp;
```

Defined in: [recipe/emailpassword/index.ts:199](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L199)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}\>

***

### submitNewPassword()

```ts
const submitNewPassword: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}> = Wrapper.submitNewPassword;
```

Defined in: [recipe/emailpassword/index.ts:197](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailpassword/index.ts#L197)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.formFields` | `object`[] |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

## References

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-emailpassword-types.mdx#getredirectionurlcontext)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-emailpassword-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-emailpassword-types.mdx#preapihookcontext)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-emailpassword-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  EmailVerification Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-emailverification-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/emailverification/types.ts:27](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L27)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailverificationsendverifyemail_override"></a> `EmailVerificationSendVerifyEmail_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/emailverification/types.ts:28](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L28) |
| <a id="emailverificationverifyemaillinkclicked_override"></a> `EmailVerificationVerifyEmailLinkClicked_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/emailverification/types.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L29) |

***

### Config

```ts
type Config = UserInput & RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/emailverification/types.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L48)

***

### EmailVerificationThemeProps

```ts
type EmailVerificationThemeProps = object;
```

Defined in: [recipe/emailverification/types.ts:82](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L82)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailverification/types.ts:85](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L85) |
| <a id="sendverifyemailscreen"></a> `sendVerifyEmailScreen` | [`SendVerifyEmailThemeProps`](#sendverifyemailthemeprops) | [recipe/emailverification/types.ts:83](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L83) |
| <a id="usercontext"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailverification/types.ts:86](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L86) |
| <a id="verifyemaillinkclickedscreen"></a> `verifyEmailLinkClickedScreen?` | [`VerifyEmailLinkClickedThemeProps`](#verifyemaillinkclickedthemeprops) | [recipe/emailverification/types.ts:84](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L84) |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<{
  action: "VERIFY_EMAIL";
}>;
```

Defined in: [recipe/emailverification/types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L64)

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/emailverification/types.ts:51](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L51)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/emailverification/types.ts:53](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L53) |
| `mode` | `"OPTIONAL"` \| `"REQUIRED"` | [recipe/emailverification/types.ts:52](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L52) |
| `override` | `object` | [recipe/emailverification/types.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L56) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailverification/types.ts:57](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L57) |
| `sendVerifyEmailScreen` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/emailverification/types.ts:54](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L54) |
| `verifyEmailLinkClickedScreen` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/emailverification/types.ts:55](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L55) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = object;
```

Defined in: [recipe/emailverification/types.ts:77](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L77)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | `"VERIFY_EMAIL_SENT"` \| `"EMAIL_VERIFIED_SUCCESSFUL"` | [recipe/emailverification/types.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L78) |
| <a id="usercontext-1"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailverification/types.ts:79](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L79) |

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "VERIFY_EMAIL" | "SEND_VERIFY_EMAIL" | "IS_EMAIL_VERIFIED";
```

Defined in: [recipe/emailverification/types.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L68)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/emailverification/types.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L70)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-1"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/emailverification/types.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L71) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/emailverification/types.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L72) |
| <a id="url"></a> `url` | `string` | [recipe/emailverification/types.ts:73](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L73) |
| <a id="usercontext-2"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/emailverification/types.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L74) |

***

### SendVerifyEmailThemeProps

```ts
type SendVerifyEmailThemeProps = ThemeBaseProps & object;
```

Defined in: [recipe/emailverification/types.ts:89](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L89)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailverification/types.ts:91](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L91) |
| `onEmailAlreadyVerified()` | () => `Promise`\<`void`\> | [recipe/emailverification/types.ts:93](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L93) |
| `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailverification/types.ts:90](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L90) |
| `redirectToAuth()` | () => `Promise`\<`void`\> | [recipe/emailverification/types.ts:94](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L94) |
| `signOut()` | () => `Promise`\<`void`\> | [recipe/emailverification/types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L92) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/emailverification/types.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L33)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/emailverification/types.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L35) |
| `mode?` | `"OPTIONAL"` \| `"REQUIRED"` | [recipe/emailverification/types.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L34) |
| `override?` | `object` | [recipe/emailverification/types.ts:39](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L39) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailverification/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L40) |
| `sendVerifyEmailScreen?` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/emailverification/types.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L36) |
| `verifyEmailLinkClickedScreen?` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/emailverification/types.ts:37](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L37) |

***

### VerifyEmailLinkClickedThemeProps

```ts
type VerifyEmailLinkClickedThemeProps = ThemeBaseProps & object;
```

Defined in: [recipe/emailverification/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L97)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/emailverification/types.ts:99](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L99) |
| `onSuccess()` | () => `Promise`\<`void`\> | [recipe/emailverification/types.ts:100](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L100) |
| `onTokenInvalidRedirect()` | () => `Promise`\<`void`\> | [recipe/emailverification/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L101) |
| `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/emailverification/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L98) |
| `token` | `string` | [recipe/emailverification/types.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/types.ts#L102) |

# References - Frontend SDKs - React SDK Reference -  EmailVerification
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-emailverification

## Classes

### default

Defined in: [recipe/emailverification/index.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L31)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/emailverification/index.ts:79](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L79) |
| <a id="emailverificationclaim"></a> `EmailVerificationClaim` | `static` | `any` | `EmailVerificationRecipe.EmailVerificationClaim` | [recipe/emailverification/index.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L32) |

#### Methods

##### getEmailVerificationTokenFromURL()

```ts
static getEmailVerificationTokenFromURL(input?): string;
```

Defined in: [recipe/emailverification/index.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L72)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`string`

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/emailverification/index.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L34)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailverification-types.mdx#userinput) |

###### Returns

`any`

##### isEmailVerified()

```ts
static isEmailVerified(input?): Promise<{
  fetchResponse: Response;
  isVerified: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/emailverification/index.ts:38](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L38)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `isVerified`: `boolean`;
  `status`: `"OK"`;
\}\>

##### sendVerificationEmail()

```ts
static sendVerificationEmail(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR";
}>;
```

Defined in: [recipe/emailverification/index.ts:59](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L59)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

##### verifyEmail()

```ts
static verifyEmail(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;
```

Defined in: [recipe/emailverification/index.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L49)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

## Variables

### EmailVerificationClaim

```ts
const EmailVerificationClaim: any = EmailVerificationRecipe.EmailVerificationClaim;
```

Defined in: [recipe/emailverification/index.ts:88](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L88)

***

### EmailVerificationComponentsOverrideProvider

```ts
const EmailVerificationComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/emailverification/index.ts:87](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L87)

***

### getEmailVerificationTokenFromURL()

```ts
const getEmailVerificationTokenFromURL: (input?) => string = Wrapper.getEmailVerificationTokenFromURL;
```

Defined in: [recipe/emailverification/index.ts:86](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L86)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`string`

***

### init()

```ts
const init: (config?) => any = Wrapper.init;
```

Defined in: [recipe/emailverification/index.ts:82](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L82)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailverification-types.mdx#userinput) |

#### Returns

`any`

***

### isEmailVerified()

```ts
const isEmailVerified: (input?) => Promise<{
  fetchResponse: Response;
  isVerified: boolean;
  status: "OK";
}> = Wrapper.isEmailVerified;
```

Defined in: [recipe/emailverification/index.ts:83](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L83)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `isVerified`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### sendVerificationEmail()

```ts
const sendVerificationEmail: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.sendVerificationEmail;
```

Defined in: [recipe/emailverification/index.ts:85](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L85)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

***

### verifyEmail()

```ts
const verifyEmail: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}> = Wrapper.verifyEmail;
```

Defined in: [recipe/emailverification/index.ts:84](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/emailverification/index.ts#L84)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

## References

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-emailverification-types.mdx#getredirectionurlcontext)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-emailverification-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-emailverification-types.mdx#preapihookcontext)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-emailverification-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  MFA Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-multifactorauth-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/multifactorauth/types.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L32)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="mfafactorchooserfooter_override"></a> `MFAFactorChooserFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L33) |
| <a id="mfafactorchooserheader_override"></a> `MFAFactorChooserHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L34) |
| <a id="mfafactorlist_override"></a> `MFAFactorList_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L35) |
| <a id="mfafactoroption_override"></a> `MFAFactorOption_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/multifactorauth/types.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L36) |

***

### Config

```ts
type Config = UserInput & RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/multifactorauth/types.ts:58](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L58)

***

### FactorChooserThemeProps

```ts
type FactorChooserThemeProps = object;
```

Defined in: [recipe/multifactorauth/types.ts:112](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L112)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="availablefactors"></a> `availableFactors` | [`SecondaryFactorRedirectionInfo`](#secondaryfactorredirectioninfo)[] | [recipe/multifactorauth/types.ts:114](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L114) |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/multifactorauth/types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L119) |
| <a id="mfainfo"></a> `mfaInfo` | [`LoadedMFAInfo`](#loadedmfainfo) | [recipe/multifactorauth/types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L113) |
| <a id="navigatetofactor"></a> `navigateToFactor` | (`factorId`) => `void` | [recipe/multifactorauth/types.ts:117](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L117) |
| <a id="onbackbuttonclicked"></a> `onBackButtonClicked` | () => `void` | [recipe/multifactorauth/types.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L116) |
| <a id="onlogoutclicked"></a> `onLogoutClicked` | () => `void` | [recipe/multifactorauth/types.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L118) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [recipe/multifactorauth/types.ts:115](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L115) |
| <a id="usercontext"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/multifactorauth/types.ts:120](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L120) |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | {
  action: "FACTOR_CHOOSER";
  nextFactorOptions?: string[];
  stepUp?: boolean;
}
  | {
  action: "GO_TO_FACTOR";
  factorId: string;
  forceSetup?: boolean;
  stepUp?: boolean;
}>;
```

Defined in: [recipe/multifactorauth/types.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L78)

***

### LoadedMFAInfo

```ts
type LoadedMFAInfo = object;
```

Defined in: [recipe/multifactorauth/types.ts:106](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L106)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emails"></a> `emails` | `Record`\<`string`, `string`[] \| `undefined`\> | [recipe/multifactorauth/types.ts:108](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L108) |
| <a id="factors"></a> `factors` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/multifactorauth/types.ts:107](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L107) |
| <a id="phonenumbers"></a> `phoneNumbers` | `Record`\<`string`, `string`[] \| `undefined`\> | [recipe/multifactorauth/types.ts:109](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L109) |

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/multifactorauth/types.ts:61](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L61)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/multifactorauth/types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L67) |
| `factorChooserScreen` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/multifactorauth/types.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L68) |
| `firstFactors?` | `string`[] | [recipe/multifactorauth/types.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L62) |
| `getSecondaryFactorInfo()` | (`builtInFactors`, `userContext`) => [`SecondaryFactorRedirectionInfo`](#secondaryfactorredirectioninfo)[] | [recipe/multifactorauth/types.ts:63](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L63) |
| `override` | `object` | [recipe/multifactorauth/types.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L70) |
| `override.functions()` | (`originalImplementation`, `builder?`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/multifactorauth/types.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L71) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = object;
```

Defined in: [recipe/multifactorauth/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L101)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | `"FACTOR_CHOOSEN"` | [recipe/multifactorauth/types.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L102) |
| <a id="factorid"></a> `factorId` | `string` | [recipe/multifactorauth/types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L103) |

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "GET_MFA_INFO";
```

Defined in: [recipe/multifactorauth/types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L92)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/multifactorauth/types.ts:94](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L94)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-1"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/multifactorauth/types.ts:95](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L95) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/multifactorauth/types.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L96) |
| <a id="url"></a> `url` | `string` | [recipe/multifactorauth/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L97) |
| <a id="usercontext-1"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/multifactorauth/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L98) |

***

### SecondaryFactorRedirectionInfo

```ts
type SecondaryFactorRedirectionInfo = object;
```

Defined in: [recipe/multifactorauth/types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L123)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="description"></a> `description` | `string` | [recipe/multifactorauth/types.ts:126](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L126) |
| <a id="id"></a> `id` | `string` | [recipe/multifactorauth/types.ts:124](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L124) |
| <a id="logo"></a> `logo` | `FC` | [recipe/multifactorauth/types.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L127) |
| <a id="name"></a> `name` | `string` | [recipe/multifactorauth/types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L125) |
| <a id="path"></a> `path` | `string` | [recipe/multifactorauth/types.ts:128](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L128) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/multifactorauth/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L40)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/multifactorauth/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L46) |
| `factorChooserScreen?` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/multifactorauth/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L47) |
| `firstFactors?` | `string`[] | [recipe/multifactorauth/types.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L41) |
| `getSecondaryFactorInfo()?` | (`builtInFactors`, `userContext`) => [`SecondaryFactorRedirectionInfo`](#secondaryfactorredirectioninfo)[] | [recipe/multifactorauth/types.ts:42](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L42) |
| `override?` | `object` | [recipe/multifactorauth/types.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L49) |
| `override.functions()?` | (`originalImplementation`, `builder?`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/multifactorauth/types.ts:50](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L50) |

## Variables

### FactorIds

```ts
const FactorIds: object;
```

Defined in: [recipe/multifactorauth/types.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L131)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="emailpassword"></a> `EMAILPASSWORD` | `"emailpassword"` | `"emailpassword"` | [recipe/multifactorauth/types.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L132) |
| <a id="link_email"></a> `LINK_EMAIL` | `"link-email"` | `"link-email"` | [recipe/multifactorauth/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L135) |
| <a id="link_phone"></a> `LINK_PHONE` | `"link-phone"` | `"link-phone"` | [recipe/multifactorauth/types.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L136) |
| <a id="otp_email"></a> `OTP_EMAIL` | `"otp-email"` | `"otp-email"` | [recipe/multifactorauth/types.ts:133](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L133) |
| <a id="otp_phone"></a> `OTP_PHONE` | `"otp-phone"` | `"otp-phone"` | [recipe/multifactorauth/types.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L134) |
| <a id="thirdparty"></a> `THIRDPARTY` | `"thirdparty"` | `"thirdparty"` | [recipe/multifactorauth/types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L137) |
| <a id="totp"></a> `TOTP` | `"totp"` | `"totp"` | [recipe/multifactorauth/types.ts:138](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L138) |
| <a id="webauthn"></a> `WEBAUTHN` | `"webauthn"` | `"webauthn"` | [recipe/multifactorauth/types.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L139) |

# References - Frontend SDKs - React SDK Reference -  MFA
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-multifactorauth

## Classes

### default

Defined in: [recipe/multifactorauth/index.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L32)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/multifactorauth/index.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L96) |
| <a id="factorids"></a> `FactorIds` | `static` | `object` | `FactorIds` | [recipe/multifactorauth/index.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L34) |
| `FactorIds.EMAILPASSWORD` | `readonly` | `"emailpassword"` | `"emailpassword"` | [recipe/multifactorauth/types.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L132) |
| `FactorIds.LINK_EMAIL` | `readonly` | `"link-email"` | `"link-email"` | [recipe/multifactorauth/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L135) |
| `FactorIds.LINK_PHONE` | `readonly` | `"link-phone"` | `"link-phone"` | [recipe/multifactorauth/types.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L136) |
| `FactorIds.OTP_EMAIL` | `readonly` | `"otp-email"` | `"otp-email"` | [recipe/multifactorauth/types.ts:133](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L133) |
| `FactorIds.OTP_PHONE` | `readonly` | `"otp-phone"` | `"otp-phone"` | [recipe/multifactorauth/types.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L134) |
| `FactorIds.THIRDPARTY` | `readonly` | `"thirdparty"` | `"thirdparty"` | [recipe/multifactorauth/types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L137) |
| `FactorIds.TOTP` | `readonly` | `"totp"` | `"totp"` | [recipe/multifactorauth/types.ts:138](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L138) |
| `FactorIds.WEBAUTHN` | `readonly` | `"webauthn"` | `"webauthn"` | [recipe/multifactorauth/types.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/types.ts#L139) |
| <a id="multifactorauthclaim"></a> `MultiFactorAuthClaim` | `static` | `any` | `MultiFactorAuthRecipe.MultiFactorAuthClaim` | [recipe/multifactorauth/index.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L33) |

#### Methods

##### getSecondaryFactors()

```ts
static getSecondaryFactors(input): any;
```

Defined in: [recipe/multifactorauth/index.ts:90](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L90)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/multifactorauth/index.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L36)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multifactorauth-types.mdx#userinput) |

###### Returns

`any`

##### redirectToFactor()

```ts
static redirectToFactor(input): any;
```

Defined in: [recipe/multifactorauth/index.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L56)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `factorId`: `string`; `forceSetup?`: `boolean`; `navigate?`: [`Navigate`](types.mdx#navigate-1); `redirectBack?`: `boolean`; `stepUp?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.factorId` | `string` |
| `input.forceSetup?` | `boolean` |
| `input.navigate?` | [`Navigate`](types.mdx#navigate-1) |
| `input.redirectBack?` | `boolean` |
| `input.stepUp?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### redirectToFactorChooser()

```ts
static redirectToFactorChooser(input): any;
```

Defined in: [recipe/multifactorauth/index.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L74)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `navigate?`: [`Navigate`](types.mdx#navigate-1); `nextFactorOptions?`: `string`[]; `redirectBack?`: `boolean`; `stepUp?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.navigate?` | [`Navigate`](types.mdx#navigate-1) |
| `input.nextFactorOptions?` | `string`[] |
| `input.redirectBack?` | `boolean` |
| `input.stepUp?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### resyncSessionAndFetchMFAInfo()

```ts
static resyncSessionAndFetchMFAInfo(input?): Promise<{
  emails: Record<string, string[] | undefined>;
  factors: MFAFactorInfo;
  fetchResponse: Response;
  phoneNumbers: Record<string, string[] | undefined>;
  status: "OK";
}>;
```

Defined in: [recipe/multifactorauth/index.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L40)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `emails`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `factors`: `MFAFactorInfo`;
  `fetchResponse`: `Response`;
  `phoneNumbers`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `status`: `"OK"`;
\}\>

## Variables

### getSecondaryFactors()

```ts
const getSecondaryFactors: (input) => any = Wrapper.getSecondaryFactors;
```

Defined in: [recipe/multifactorauth/index.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L103)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### init()

```ts
const init: (config?) => any = Wrapper.init;
```

Defined in: [recipe/multifactorauth/index.ts:99](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L99)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multifactorauth-types.mdx#userinput) |

#### Returns

`any`

***

### MultiFactorAuthClaim

```ts
const MultiFactorAuthClaim: any = MultiFactorAuthRecipe.MultiFactorAuthClaim;
```

Defined in: [recipe/multifactorauth/index.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L105)

***

### MultiFactorAuthComponentsOverrideProvider

```ts
const MultiFactorAuthComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/multifactorauth/index.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L104)

***

### redirectToFactor()

```ts
const redirectToFactor: (input) => any = Wrapper.redirectToFactor;
```

Defined in: [recipe/multifactorauth/index.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L101)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `factorId`: `string`; `forceSetup?`: `boolean`; `navigate?`: [`Navigate`](types.mdx#navigate-1); `redirectBack?`: `boolean`; `stepUp?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.factorId` | `string` |
| `input.forceSetup?` | `boolean` |
| `input.navigate?` | [`Navigate`](types.mdx#navigate-1) |
| `input.redirectBack?` | `boolean` |
| `input.stepUp?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### redirectToFactorChooser()

```ts
const redirectToFactorChooser: (input) => any = Wrapper.redirectToFactorChooser;
```

Defined in: [recipe/multifactorauth/index.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L102)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `navigate?`: [`Navigate`](types.mdx#navigate-1); `nextFactorOptions?`: `string`[]; `redirectBack?`: `boolean`; `stepUp?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.navigate?` | [`Navigate`](types.mdx#navigate-1) |
| `input.nextFactorOptions?` | `string`[] |
| `input.redirectBack?` | `boolean` |
| `input.stepUp?` | `boolean` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### resyncSessionAndFetchMFAInfo()

```ts
const resyncSessionAndFetchMFAInfo: (input?) => Promise<{
  emails: Record<string, string[] | undefined>;
  factors: MFAFactorInfo;
  fetchResponse: Response;
  phoneNumbers: Record<string, string[] | undefined>;
  status: "OK";
}> = Wrapper.resyncSessionAndFetchMFAInfo;
```

Defined in: [recipe/multifactorauth/index.ts:100](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multifactorauth/index.ts#L100)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `emails`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `factors`: `MFAFactorInfo`;
  `fetchResponse`: `Response`;
  `phoneNumbers`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `status`: `"OK"`;
\}\>

## References

### FactorIds

Re-exports [FactorIds](recipe-multifactorauth-types.mdx#factorids)

***

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-multifactorauth-types.mdx#getredirectionurlcontext)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-multifactorauth-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-multifactorauth-types.mdx#preapihookcontext)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-multifactorauth-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  MultiTenancy Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-multitenancy-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/multitenancy/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L40)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="multitenancydynamicloginmethodsspinnertheme_override"></a> `MultitenancyDynamicLoginMethodsSpinnerTheme_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/multitenancy/types.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L41) |

***

### GetLoginMethodsResponseNormalized

```ts
type GetLoginMethodsResponseNormalized = object;
```

Defined in: [recipe/multitenancy/types.ts:30](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L30)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="firstfactors"></a> `firstFactors` | `string`[] | [recipe/multitenancy/types.ts:37](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L37) |
| <a id="thirdparty"></a> `thirdparty` | `object` | [recipe/multitenancy/types.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L31) |
| `thirdparty.providers` | `object`[] | [recipe/multitenancy/types.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L32) |

***

### NormalisedConfig

```ts
type NormalisedConfig = NormalisedRecipeModuleConfig<any, PreAndPostAPIHookAction, any> & object;
```

Defined in: [recipe/multitenancy/types.ts:21](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L21)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [recipe/multitenancy/types.ts:22](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L22) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/multitenancy/types.ts:23](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L23) |

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "GET_LOGIN_METHODS";
```

Defined in: [recipe/multitenancy/types.ts:10](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L10)

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<any, PreAndPostAPIHookAction, any>;
```

Defined in: [recipe/multitenancy/types.ts:12](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L12)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [recipe/multitenancy/types.ts:13](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L13) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/multitenancy/types.ts:14](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/types.ts#L14) |

# References - Frontend SDKs - React SDK Reference -  MultiTenancy
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-multitenancy

## Classes

### default

Defined in: [recipe/multitenancy/index.ts:24](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/index.ts#L24)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="alloweddomainsclaim"></a> `AllowedDomainsClaim` | `static` | `any` | `AllowedDomainsClaim` | [recipe/multitenancy/index.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/index.ts#L29) |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/multitenancy/index.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/index.ts#L31) |

#### Methods

##### init()

```ts
static init(config?): RecipeInitResult<any, any, any, any>;
```

Defined in: [recipe/multitenancy/index.ts:25](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/index.ts#L25)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multitenancy-types.mdx#userinput) |

###### Returns

[`RecipeInitResult`](types.mdx#recipeinitresult)\<`any`, `any`, `any`, `any`\>

## Variables

### init()

```ts
const init: (config?) => RecipeInitResult<any, any, any, any> = Wrapper.init;
```

Defined in: [recipe/multitenancy/index.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/index.ts#L34)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multitenancy-types.mdx#userinput) |

#### Returns

[`RecipeInitResult`](types.mdx#recipeinitresult)\<`any`, `any`, `any`, `any`\>

***

### MultitenancyComponentsOverrideProvider

```ts
const MultitenancyComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/multitenancy/index.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/multitenancy/index.ts#L35)

## References

### AllowedDomainsClaim

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-multitenancy-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  OAuth Provider Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-oauth2provider-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/oauth2provider/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L97)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="oauth2logoutscreeninner_override"></a> `OAuth2LogoutScreenInner_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/oauth2provider/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L98) |

***

### ContinueOAuth2AfterRefreshRedirectContext

```ts
type ContinueOAuth2AfterRefreshRedirectContext = object;
```

Defined in: [recipe/oauth2provider/types.ts:65](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L65)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | `"CONTINUE_OAUTH2_AFTER_REFRESH"` | [recipe/oauth2provider/types.ts:67](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L67) |
| <a id="frontendredirectto"></a> `frontendRedirectTo` | `string` | [recipe/oauth2provider/types.ts:68](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L68) |
| <a id="recipeid"></a> `recipeId` | `"oauth2provider"` | [recipe/oauth2provider/types.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L66) |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | SuccessRedirectContextOAuth2
  | ContinueOAuth2AfterRefreshRedirectContext
| PostOAuth2LogoutRedirectContext>;
```

Defined in: [recipe/oauth2provider/types.ts:77](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L77)

***

### NormalisedConfig

```ts
type NormalisedConfig = NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext> & object;
```

Defined in: [recipe/oauth2provider/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L40)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/oauth2provider/types.ts:45](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L45) |
| `oauth2LogoutScreen` | [`OAuth2LogoutScreenConfig`](#oauth2logoutscreenconfig) | [recipe/oauth2provider/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L46) |
| `override` | `object` | [recipe/oauth2provider/types.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L48) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/oauth2provider/types.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L49) |
| `tryRefreshPage` | [`OAuth2TryRefreshPageConfig`](#oauth2tryrefreshpageconfig) | [recipe/oauth2provider/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L47) |

***

### OAuth2LogoutScreenConfig

```ts
type OAuth2LogoutScreenConfig = NormalisedBaseConfig & object;
```

Defined in: [recipe/oauth2provider/types.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L56)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/oauth2provider/types.ts:57](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L57) |

***

### OAuth2LogoutScreenThemeProps

```ts
type OAuth2LogoutScreenThemeProps = object;
```

Defined in: [recipe/oauth2provider/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L101)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/oauth2provider/types.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L102) |
| <a id="isloggingout"></a> `isLoggingOut` | `boolean` | [recipe/oauth2provider/types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L103) |
| <a id="onlogoutclicked"></a> `onLogoutClicked` | () => `void` | [recipe/oauth2provider/types.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L104) |
| <a id="showspinner"></a> `showSpinner` | `boolean` | [recipe/oauth2provider/types.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L105) |

***

### OAuth2TryRefreshPageConfig

```ts
type OAuth2TryRefreshPageConfig = object;
```

Defined in: [recipe/oauth2provider/types.ts:61](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L61)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="disabledefaultui"></a> `disableDefaultUI` | `boolean` | [recipe/oauth2provider/types.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L62) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = 
  | {
  action: "LOADED_LOGIN_CHALLENGE";
  loginChallenge: string;
  loginInfo: SuperTokensWrapper;
  userContext: UserContext;
}
  | {
  action: "OAUTH2_LOGOUT_SUCCESS";
  frontendRedirectTo: string;
  userContext: UserContext;
};
```

Defined in: [recipe/oauth2provider/types.ts:81](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L81)

***

### PostOAuth2LogoutRedirectContext

```ts
type PostOAuth2LogoutRedirectContext = object;
```

Defined in: [recipe/oauth2provider/types.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L71)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-1"></a> `action` | `"POST_OAUTH2_LOGOUT_REDIRECT"` | [recipe/oauth2provider/types.ts:73](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L73) |
| <a id="frontendredirectto-1"></a> `frontendRedirectTo` | `string` | [recipe/oauth2provider/types.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L74) |
| <a id="recipeid-1"></a> `recipeId` | `"oauth2provider"` | [recipe/oauth2provider/types.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L72) |

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "GET_LOGIN_CHALLENGE_INFO"
  | "GET_REDIRECT_URL_TO_CONTINUE_OAUTH_FLOW"
  | "LOG_OUT";
```

Defined in: [recipe/oauth2provider/types.ts:16](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L16)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/oauth2provider/types.ts:21](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L21)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action-2"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/oauth2provider/types.ts:22](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L22) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/oauth2provider/types.ts:23](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L23) |
| <a id="url"></a> `url` | `string` | [recipe/oauth2provider/types.ts:24](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L24) |
| <a id="usercontext"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/oauth2provider/types.ts:25](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L25) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/oauth2provider/types.ts:28](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L28)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/oauth2provider/types.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L29) |
| `oauth2LogoutScreen?` | `Partial`\<[`OAuth2LogoutScreenConfig`](#oauth2logoutscreenconfig)\> | [recipe/oauth2provider/types.ts:30](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L30) |
| `override?` | `object` | [recipe/oauth2provider/types.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L32) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/oauth2provider/types.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L33) |
| `tryRefreshPage?` | `Partial`\<[`OAuth2TryRefreshPageConfig`](#oauth2tryrefreshpageconfig)\> | [recipe/oauth2provider/types.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/types.ts#L31) |

# References - Frontend SDKs - React SDK Reference -  OAuth Provider
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-oauth2provider

## Classes

### default

Defined in: [recipe/oauth2provider/index.ts:23](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L23)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/oauth2provider/index.ts:99](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L99) |

#### Methods

##### getLoginChallengeInfo()

```ts
static getLoginChallengeInfo(input): Promise<{
  fetchResponse: Response;
  info: LoginInfo;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L41)

Returns information about an OAuth login in progress

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `info`: `LoginInfo`;
  `status`: `"OK"`;
\}\>

`{status: "OK", info: LoginInfo}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### getRedirectURLToContinueOAuthFlow()

```ts
static getRedirectURLToContinueOAuthFlow(input): Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L66)

Accepts the OAuth2 Login request and returns the redirect URL to continue the OAuth flow.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### init()

```ts
static init(config?): RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>;
```

Defined in: [recipe/oauth2provider/index.ts:24](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L24)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-oauth2provider-types.mdx#userinput) |

###### Returns

[`RecipeInitResult`](types.mdx#recipeinitresult)\<[`GetRedirectionURLContext`](recipe-oauth2provider-types.mdx#getredirectionurlcontext), [`PreAndPostAPIHookAction`](recipe-oauth2provider-types.mdx#preandpostapihookaction), [`OnHandleEventContext`](recipe-oauth2provider-types.mdx#onhandleeventcontext), [`NormalisedConfig`](recipe-oauth2provider-types.mdx#normalisedconfig)\>

##### logOut()

```ts
static logOut(input): Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:91](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L91)

Accepts the OAuth2 Logout request, clears the SuperTokens session and returns post logout redirect URL.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `logoutChallenge`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: `any`; \} |
| `input.logoutChallenge` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## Variables

### getLoginChallengeInfo()

```ts
const getLoginChallengeInfo: (input) => Promise<{
  fetchResponse: Response;
  info: LoginInfo;
  status: "OK";
}> = Wrapper.getLoginChallengeInfo;
```

Defined in: [recipe/oauth2provider/index.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L103)

Returns information about an OAuth login in progress

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `info`: `LoginInfo`;
  `status`: `"OK"`;
\}\>

`{status: "OK", info: LoginInfo}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### init()

```ts
const init: (config?) => RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig> = Wrapper.init;
```

Defined in: [recipe/oauth2provider/index.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L102)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-oauth2provider-types.mdx#userinput) |

#### Returns

[`RecipeInitResult`](types.mdx#recipeinitresult)\<[`GetRedirectionURLContext`](recipe-oauth2provider-types.mdx#getredirectionurlcontext), [`PreAndPostAPIHookAction`](recipe-oauth2provider-types.mdx#preandpostapihookaction), [`OnHandleEventContext`](recipe-oauth2provider-types.mdx#onhandleeventcontext), [`NormalisedConfig`](recipe-oauth2provider-types.mdx#normalisedconfig)\>

***

### logOut()

```ts
const logOut: (input) => Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}> = Wrapper.logOut;
```

Defined in: [recipe/oauth2provider/index.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/oauth2provider/index.ts#L104)

Accepts the OAuth2 Logout request, clears the SuperTokens session and returns post logout redirect URL.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `logoutChallenge`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: `any`; \} |
| `input.logoutChallenge` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## References

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-oauth2provider-types.mdx#getredirectionurlcontext)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-oauth2provider-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-oauth2provider-types.mdx#preapihookcontext)

***

### RecipeComponentsOverrideContextProvider

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-oauth2provider-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  Passwordless Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-passwordless-types

## Type Aliases

### AdditionalLoginAttemptInfoProperties

```ts
type AdditionalLoginAttemptInfoProperties = object;
```

Defined in: [recipe/passwordless/types.ts:231](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L231)

When calling getLoginAttemptInfo/setLoginAttemptInfo from web-js we use generics to get
access to properties in local storage that web-js does not set by default.
This allows us to strongly type the response while keeping it dynamic.

In the context of auth-react this type indicates all the additional properties we need.

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="contactinfo"></a> `contactInfo` | `string` | [recipe/passwordless/types.ts:232](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L232) |
| <a id="contactmethod"></a> `contactMethod` | `"EMAIL"` \| `"PHONE"` | [recipe/passwordless/types.ts:233](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L233) |
| <a id="lastresend"></a> `lastResend` | `number` | [recipe/passwordless/types.ts:234](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L234) |
| <a id="redirecttopath"></a> `redirectToPath?` | `string` | [recipe/passwordless/types.ts:235](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L235) |

***

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/passwordless/types.ts:445](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L445)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="passwordlesscontinuewithpasswordless_override"></a> `PasswordlessContinueWithPasswordless_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:459](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L459) |
| <a id="passwordlessemailform_override"></a> `PasswordlessEmailForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:446](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L446) |
| <a id="passwordlessemailorphoneform_override"></a> `PasswordlessEmailOrPhoneForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:448](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L448) |
| <a id="passwordlessepcomboemailform_override"></a> `PasswordlessEPComboEmailForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:449](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L449) |
| <a id="passwordlessepcomboemailorphoneform_override"></a> `PasswordlessEPComboEmailOrPhoneForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:450](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L450) |
| <a id="passwordlesslinkclickedscreen_override"></a> `PasswordlessLinkClickedScreen_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:458](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L458) |
| <a id="passwordlesslinksent_override"></a> `PasswordlessLinkSent_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:456](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L456) |
| <a id="passwordlessmfafooter_override"></a> `PasswordlessMFAFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:462](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L462) |
| <a id="passwordlessmfaheader_override"></a> `PasswordlessMFAHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:461](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L461) |
| <a id="passwordlessmfaotpfooter_override"></a> `PasswordlessMFAOTPFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:464](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L464) |
| <a id="passwordlessmfaotpheader_override"></a> `PasswordlessMFAOTPHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:463](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L463) |
| <a id="passwordlessmfaotploadingscreen_override"></a> `PasswordlessMFAOTPLoadingScreen_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:465](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L465) |
| <a id="passwordlessphoneform_override"></a> `PasswordlessPhoneForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:447](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L447) |
| <a id="passwordlessuserinputcodeform_override"></a> `PasswordlessUserInputCodeForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:454](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L454) |
| <a id="passwordlessuserinputcodeformfooter_override"></a> `PasswordlessUserInputCodeFormFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:453](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L453) |
| <a id="passwordlessuserinputcodeformheader_override"></a> `PasswordlessUserInputCodeFormHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/passwordless/types.ts:452](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L452) |

***

### Config

```ts
type Config = UserInput & AuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/passwordless/types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L125)

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = never;
```

Defined in: [recipe/passwordless/types.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L78)

***

### LinkClickedScreenProps

```ts
type LinkClickedScreenProps = object;
```

Defined in: [recipe/passwordless/types.ts:283](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L283)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:285](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L285) |
| <a id="consumecode"></a> `consumeCode` | () => `void` | [recipe/passwordless/types.ts:287](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L287) |
| <a id="onsuccess"></a> `onSuccess?` | () => `void` | [recipe/passwordless/types.ts:288](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L288) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:284](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L284) |
| <a id="requireuserinteraction"></a> `requireUserInteraction` | `boolean` | [recipe/passwordless/types.ts:286](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L286) |

***

### LinkSentChildProps

```ts
type LinkSentChildProps = LinkSentThemeProps;
```

Defined in: [recipe/passwordless/types.ts:389](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L389)

***

### LinkSentThemeProps

```ts
type LinkSentThemeProps = object;
```

Defined in: [recipe/passwordless/types.ts:392](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L392)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:393](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L393) |
| <a id="config-2"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:398](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L398) |
| <a id="error"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:395](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L395) |
| <a id="loginattemptinfo"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:396](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L396) |
| <a id="onerror"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:394](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L394) |
| <a id="recipeimplementation-1"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:397](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L397) |

***

### LoginAttemptInfo

```ts
type LoginAttemptInfo = object;
```

Defined in: [recipe/passwordless/types.ts:214](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L214)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="contactinfo-1"></a> `contactInfo` | `string` | [recipe/passwordless/types.ts:217](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L217) |
| <a id="contactmethod-1"></a> `contactMethod` | `"EMAIL"` \| `"PHONE"` | [recipe/passwordless/types.ts:218](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L218) |
| <a id="deviceid"></a> `deviceId` | `string` | [recipe/passwordless/types.ts:215](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L215) |
| <a id="flowtype"></a> `flowType` | `"USER_INPUT_CODE"` \| `"MAGIC_LINK"` \| `"USER_INPUT_CODE_AND_MAGIC_LINK"` | [recipe/passwordless/types.ts:221](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L221) |
| <a id="lastresend-1"></a> `lastResend` | `number` | [recipe/passwordless/types.ts:219](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L219) |
| <a id="preauthsessionid"></a> `preAuthSessionId` | `string` | [recipe/passwordless/types.ts:216](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L216) |
| <a id="redirecttopath-1"></a> `redirectToPath?` | `string` | [recipe/passwordless/types.ts:220](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L220) |

***

### MFAAction

```ts
type MFAAction = 
  | {
  callingCreateCode: boolean;
  canChangeEmail: boolean;
  error: string | undefined;
  loginAttemptInfo: LoginAttemptInfo | undefined;
  showAccessDenied: boolean;
  showBackButton: boolean;
  type: "load";
}
  | {
  loginAttemptInfo: LoginAttemptInfo;
  type: "startVerify";
}
  | {
  timestamp: number;
  type: "resendCode";
}
  | {
  error: string | undefined;
  type: "restartFlow";
}
  | {
  error: string | undefined;
  showAccessDenied: boolean;
  type: "setError";
};
```

Defined in: [recipe/passwordless/types.ts:335](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L335)

***

### MFAChildProps

```ts
type MFAChildProps = Omit<MFAProps, "featureState" | "dispatch">;
```

Defined in: [recipe/passwordless/types.ts:390](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L390)

***

### MFAFooterProps

```ts
type MFAFooterProps = object;
```

Defined in: [recipe/passwordless/types.ts:413](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L413)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="canchangeemail"></a> `canChangeEmail` | `boolean` | [recipe/passwordless/types.ts:414](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L414) |
| <a id="config-3"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:417](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L417) |
| <a id="onsignoutclicked"></a> `onSignOutClicked` | () => `void` | [recipe/passwordless/types.ts:415](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L415) |
| <a id="recipeimplementation-2"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:416](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L416) |

***

### MFAHeaderProps

```ts
type MFAHeaderProps = object;
```

Defined in: [recipe/passwordless/types.ts:428](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L428)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-4"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:433](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L433) |
| <a id="contactmethod-2"></a> `contactMethod` | `"EMAIL"` \| `"PHONE"` | [recipe/passwordless/types.ts:429](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L429) |
| <a id="onbackbuttonclicked"></a> `onBackButtonClicked` | () => `void` | [recipe/passwordless/types.ts:431](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L431) |
| <a id="recipeimplementation-3"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:432](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L432) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [recipe/passwordless/types.ts:430](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L430) |

***

### MFAOTPFooterProps

```ts
type MFAOTPFooterProps = object;
```

Defined in: [recipe/passwordless/types.ts:420](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L420)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="canchangeemail-1"></a> `canChangeEmail` | `boolean` | [recipe/passwordless/types.ts:421](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L421) |
| <a id="config-5"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:425](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L425) |
| <a id="loginattemptinfo-2"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:423](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L423) |
| <a id="onsignoutclicked-1"></a> `onSignOutClicked` | () => `void` | [recipe/passwordless/types.ts:422](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L422) |
| <a id="recipeimplementation-4"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:424](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L424) |

***

### MFAOTPHeaderProps

```ts
type MFAOTPHeaderProps = object;
```

Defined in: [recipe/passwordless/types.ts:436](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L436)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="canchangeemail-2"></a> `canChangeEmail` | `boolean` | [recipe/passwordless/types.ts:437](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L437) |
| <a id="config-6"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:442](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L442) |
| <a id="loginattemptinfo-3"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:440](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L440) |
| <a id="onbackbuttonclicked-1"></a> `onBackButtonClicked` | () => `void` | [recipe/passwordless/types.ts:439](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L439) |
| <a id="recipeimplementation-5"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:441](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L441) |
| <a id="showbackbutton-1"></a> `showBackButton` | `boolean` | [recipe/passwordless/types.ts:438](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L438) |

***

### MFAProps

```ts
type MFAProps = object;
```

Defined in: [recipe/passwordless/types.ts:182](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L182)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-7"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:184](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L184) |
| <a id="contactmethod-3"></a> `contactMethod` | `"EMAIL"` \| `"PHONE"` | [recipe/passwordless/types.ts:185](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L185) |
| <a id="dispatch"></a> `dispatch` | `Dispatch`\<[`MFAAction`](#mfaaction)\> | [recipe/passwordless/types.ts:190](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L190) |
| <a id="featurestate"></a> `featureState` | `object` | [recipe/passwordless/types.ts:191](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L191) |
| `featureState.canChangeEmail` | `boolean` | [recipe/passwordless/types.ts:192](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L192) |
| `featureState.error` | `string` \| `undefined` | [recipe/passwordless/types.ts:197](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L197) |
| `featureState.loaded` | `boolean` | [recipe/passwordless/types.ts:194](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L194) |
| `featureState.loginAttemptInfo?` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:193](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L193) |
| `featureState.showAccessDenied` | `boolean` | [recipe/passwordless/types.ts:196](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L196) |
| `featureState.showBackButton` | `boolean` | [recipe/passwordless/types.ts:195](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L195) |
| <a id="onbackbuttonclicked-2"></a> `onBackButtonClicked` | () => `void` | [recipe/passwordless/types.ts:186](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L186) |
| <a id="onfetcherror"></a> `onFetchError` | (`err`) => `void` | [recipe/passwordless/types.ts:189](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L189) |
| <a id="onsignoutclicked-2"></a> `onSignOutClicked` | () => `void` | [recipe/passwordless/types.ts:187](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L187) |
| <a id="onsuccess-1"></a> `onSuccess?` | () => `void` | [recipe/passwordless/types.ts:188](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L188) |
| <a id="recipeimplementation-6"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:183](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L183) |
| <a id="usercontext"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/passwordless/types.ts:200](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L200) |
| <a id="validatephonenumber"></a> `validatePhoneNumber` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:199](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L199) |

***

### MFAState

```ts
type MFAState = object;
```

Defined in: [recipe/passwordless/types.ts:363](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L363)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="canchangeemail-3"></a> `canChangeEmail` | `boolean` | [recipe/passwordless/types.ts:369](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L369) |
| <a id="error-1"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:365](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L365) |
| <a id="loaded"></a> `loaded` | `boolean` | [recipe/passwordless/types.ts:366](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L366) |
| <a id="loginattemptinfo-4"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) \| `undefined` | [recipe/passwordless/types.ts:368](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L368) |
| <a id="showaccessdenied"></a> `showAccessDenied` | `boolean` | [recipe/passwordless/types.ts:364](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L364) |
| <a id="showbackbutton-2"></a> `showBackButton` | `boolean` | [recipe/passwordless/types.ts:367](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L367) |

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedAuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/passwordless/types.ts:100](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L100)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `contactMethod` | `"PHONE"` \| `"EMAIL"` \| `"EMAIL_OR_PHONE"` | [recipe/passwordless/types.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L118) |
| `linkClickedScreenFeature` | [`PasswordlessNormalisedBaseConfig`](#passwordlessnormalisedbaseconfig) | [recipe/passwordless/types.ts:115](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L115) |
| `mfaFeature` | [`PasswordlessNormalisedBaseConfig`](#passwordlessnormalisedbaseconfig) | [recipe/passwordless/types.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L116) |
| `override` | `object` | [recipe/passwordless/types.ts:120](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L120) |
| `override.functions()` | (`originalImplementation`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/passwordless/types.ts:121](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L121) |
| `signInUpFeature` | `object` | [recipe/passwordless/types.ts:106](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L106) |
| `signInUpFeature.defaultCountry?` | `string` | [recipe/passwordless/types.ts:108](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L108) |
| `signInUpFeature.defaultToEmail` | `boolean` | [recipe/passwordless/types.ts:110](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L110) |
| `signInUpFeature.emailOrPhoneFormStyle` | `string` | [recipe/passwordless/types.ts:111](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L111) |
| `signInUpFeature.linkSentScreenStyle` | `string` | [recipe/passwordless/types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L113) |
| `signInUpFeature.resendEmailOrSMSGapInSeconds` | `number` | [recipe/passwordless/types.ts:107](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L107) |
| `signInUpFeature.userInputCodeFormStyle` | `string` | [recipe/passwordless/types.ts:112](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L112) |
| `validateEmailAddress()` | (`email`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L101) |
| `validatePhoneNumber()?` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L104) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = 
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
}
  | {
  action: "PASSWORDLESS_RESTART_FLOW";
}
  | {
  action: "PASSWORDLESS_CODE_SENT";
  isResend: boolean;
}
  | AuthRecipeModuleOnHandleEventContext;
```

Defined in: [recipe/passwordless/types.ts:80](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L80)

***

### PasswordlessFeatureBaseConfig

```ts
type PasswordlessFeatureBaseConfig = object & FeatureBaseConfig;
```

Defined in: [recipe/passwordless/types.ts:128](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L128)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/passwordless/types.ts:129](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L129) |

***

### PasswordlessNormalisedBaseConfig

```ts
type PasswordlessNormalisedBaseConfig = object & NormalisedBaseConfig;
```

Defined in: [recipe/passwordless/types.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L96)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/passwordless/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L97) |

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "PASSWORDLESS_CREATE_CODE"
  | "PASSWORDLESS_CONSUME_CODE"
  | "PASSWORDLESS_RESEND_CODE"
  | "EMAIL_EXISTS"
  | "PHONE_NUMBER_EXISTS";
```

Defined in: [recipe/passwordless/types.ts:53](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L53)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/passwordless/types.ts:60](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L60)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/passwordless/types.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L64) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/passwordless/types.ts:69](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L69) |
| <a id="url"></a> `url` | `string` | [recipe/passwordless/types.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L74) |

***

### RecipeImplementation

```ts
type RecipeImplementation = WebJSRecipeInterface<typeof SuperTokensWrapper>;
```

Defined in: [recipe/passwordless/types.ts:238](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L238)

***

### SignInUpChildProps

```ts
type SignInUpChildProps = SignInUpProps;
```

Defined in: [recipe/passwordless/types.ts:372](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L372)

***

### SignInUpEmailFormProps

```ts
type SignInUpEmailFormProps = object;
```

Defined in: [recipe/passwordless/types.ts:240](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L240)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-1"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:241](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L241) |
| <a id="config-8"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:246](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L246) |
| <a id="error-2"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:244](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L244) |
| <a id="onerror-1"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:242](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L242) |
| <a id="onfetcherror-1"></a> `onFetchError` | (`error`) => `void` | [recipe/passwordless/types.ts:243](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L243) |
| <a id="onsuccess-2"></a> `onSuccess?` | () => `void` | [recipe/passwordless/types.ts:247](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L247) |
| <a id="recipeimplementation-8"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:245](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L245) |

***

### SignInUpEmailOrPhoneFormProps

```ts
type SignInUpEmailOrPhoneFormProps = object;
```

Defined in: [recipe/passwordless/types.ts:261](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L261)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-2"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:262](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L262) |
| <a id="config-9"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:267](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L267) |
| <a id="error-3"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:265](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L265) |
| <a id="onerror-2"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:263](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L263) |
| <a id="onfetcherror-2"></a> `onFetchError` | (`error`) => `void` | [recipe/passwordless/types.ts:264](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L264) |
| <a id="onsuccess-3"></a> `onSuccess?` | () => `void` | [recipe/passwordless/types.ts:268](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L268) |
| <a id="recipeimplementation-9"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:266](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L266) |
| <a id="validatephonenumber-1"></a> `validatePhoneNumber` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:269](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L269) |

***

### SignInUpEPComboChildProps

```ts
type SignInUpEPComboChildProps = Omit<SignInUpProps, "onSuccess"> & object;
```

Defined in: [recipe/passwordless/types.ts:373](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L373)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `isPhoneNumber` | `boolean` | [recipe/passwordless/types.ts:374](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L374) |
| `navigate` | [`Navigate`](types.mdx#navigate-1) \| `undefined` | [recipe/passwordless/types.ts:387](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L387) |
| `onContactInfoSubmit()` | (`contactInfo`) => `Promise`\<[`FormBaseAPIResponse`](recipe-emailpassword-types.mdx#formbaseapiresponse)\<`unknown`\>\> | [recipe/passwordless/types.ts:378](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L378) |
| `onContinueWithPasswordlessClick()` | (`contactInfo`) => `Promise`\<`void`\> | [recipe/passwordless/types.ts:380](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L380) |
| `onPasswordSubmit()` | (`formFields`) => `Promise`\<[`FormBaseAPIResponse`](recipe-emailpassword-types.mdx#formbaseapiresponse)\<`unknown`\>\> | [recipe/passwordless/types.ts:379](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L379) |
| `onSuccess()` | (`result`) => `void` | [recipe/passwordless/types.ts:381](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L381) |
| `setIsPhoneNumber()` | (`isPhone`) => `void` | [recipe/passwordless/types.ts:375](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L375) |
| `showContinueWithPasswordlessLink` | `boolean` | [recipe/passwordless/types.ts:377](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L377) |
| `showPasswordField` | `boolean` | [recipe/passwordless/types.ts:376](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L376) |
| `validatePhoneNumber()` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:386](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L386) |

***

### SignInUpEPComboEmailFormProps

```ts
type SignInUpEPComboEmailFormProps = object;
```

Defined in: [recipe/passwordless/types.ts:314](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L314)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-3"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:317](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L317) |
| <a id="config-10"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:331](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L331) |
| <a id="error-4"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:328](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L328) |
| <a id="navigate"></a> `navigate` | [`Navigate`](types.mdx#navigate-1) \| `undefined` | [recipe/passwordless/types.ts:332](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L332) |
| <a id="oncontactinfosubmit"></a> `onContactInfoSubmit` | (`contactInfo`) => `Promise`\<[`FormBaseAPIResponse`](recipe-emailpassword-types.mdx#formbaseapiresponse)\<`unknown`\>\> | [recipe/passwordless/types.ts:318](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L318) |
| <a id="oncontinuewithpasswordlessclick"></a> `onContinueWithPasswordlessClick` | (`contactInfo`) => `Promise`\<`void`\> | [recipe/passwordless/types.ts:320](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L320) |
| <a id="onerror-3"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:326](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L326) |
| <a id="onfetcherror-3"></a> `onFetchError` | (`error`) => `void` | [recipe/passwordless/types.ts:327](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L327) |
| <a id="onpasswordsubmit"></a> `onPasswordSubmit` | (`formFields`) => `Promise`\<[`FormBaseAPIResponse`](recipe-emailpassword-types.mdx#formbaseapiresponse)\<`unknown`\>\> | [recipe/passwordless/types.ts:319](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L319) |
| <a id="onsuccess-4"></a> `onSuccess` | (`result`) => `void` | [recipe/passwordless/types.ts:321](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L321) |
| <a id="recipeimplementation-10"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:329](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L329) |
| <a id="showcontinuewithpasswordlesslink"></a> `showContinueWithPasswordlessLink` | `boolean` | [recipe/passwordless/types.ts:316](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L316) |
| <a id="showpasswordfield"></a> `showPasswordField` | `boolean` | [recipe/passwordless/types.ts:315](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L315) |
| <a id="validatephonenumber-2"></a> `validatePhoneNumber` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:330](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L330) |

***

### SignInUpEPComboEmailOrPhoneFormProps

```ts
type SignInUpEPComboEmailOrPhoneFormProps = object;
```

Defined in: [recipe/passwordless/types.ts:291](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L291)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-4"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:294](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L294) |
| <a id="config-11"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:309](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L309) |
| <a id="error-5"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:307](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L307) |
| <a id="isphonenumber"></a> `isPhoneNumber` | `boolean` | [recipe/passwordless/types.ts:295](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L295) |
| <a id="navigate-1"></a> `navigate` | [`Navigate`](types.mdx#navigate-1) \| `undefined` | [recipe/passwordless/types.ts:311](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L311) |
| <a id="oncontactinfosubmit-1"></a> `onContactInfoSubmit` | (`contactInfo`) => `Promise`\<[`FormBaseAPIResponse`](recipe-emailpassword-types.mdx#formbaseapiresponse)\<`unknown`\>\> | [recipe/passwordless/types.ts:297](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L297) |
| <a id="oncontinuewithpasswordlessclick-1"></a> `onContinueWithPasswordlessClick` | (`contactInfo`) => `Promise`\<`void`\> | [recipe/passwordless/types.ts:299](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L299) |
| <a id="onerror-4"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:305](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L305) |
| <a id="onfetcherror-4"></a> `onFetchError` | (`error`) => `void` | [recipe/passwordless/types.ts:306](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L306) |
| <a id="onpasswordsubmit-1"></a> `onPasswordSubmit` | (`formFields`) => `Promise`\<[`FormBaseAPIResponse`](recipe-emailpassword-types.mdx#formbaseapiresponse)\<`unknown`\>\> | [recipe/passwordless/types.ts:298](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L298) |
| <a id="onsuccess-5"></a> `onSuccess` | (`result`) => `void` | [recipe/passwordless/types.ts:300](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L300) |
| <a id="recipeimplementation-11"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:308](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L308) |
| <a id="setisphonenumber"></a> `setIsPhoneNumber` | (`isPhone`) => `void` | [recipe/passwordless/types.ts:296](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L296) |
| <a id="showcontinuewithpasswordlesslink-1"></a> `showContinueWithPasswordlessLink` | `boolean` | [recipe/passwordless/types.ts:293](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L293) |
| <a id="showpasswordfield-1"></a> `showPasswordField` | `boolean` | [recipe/passwordless/types.ts:292](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L292) |
| <a id="validatephonenumber-3"></a> `validatePhoneNumber` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:310](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L310) |

***

### SignInUpFeatureConfigInput

```ts
type SignInUpFeatureConfigInput = object;
```

Defined in: [recipe/passwordless/types.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L132)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailorphoneformstyle"></a> `emailOrPhoneFormStyle?` | `string` | [recipe/passwordless/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L135) |
| <a id="linksentscreenstyle"></a> `linkSentScreenStyle?` | `string` | [recipe/passwordless/types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L137) |
| <a id="resendemailorsmsgapinseconds"></a> `resendEmailOrSMSGapInSeconds?` | `number` | [recipe/passwordless/types.ts:133](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L133) |
| <a id="userinputcodeformstyle"></a> `userInputCodeFormStyle?` | `string` | [recipe/passwordless/types.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L136) |

***

### SignInUpPhoneFormProps

```ts
type SignInUpPhoneFormProps = object;
```

Defined in: [recipe/passwordless/types.ts:250](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L250)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-5"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:251](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L251) |
| <a id="config-12"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:256](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L256) |
| <a id="error-6"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:254](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L254) |
| <a id="onerror-5"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:252](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L252) |
| <a id="onfetcherror-5"></a> `onFetchError` | (`error`) => `void` | [recipe/passwordless/types.ts:253](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L253) |
| <a id="onsuccess-6"></a> `onSuccess?` | () => `void` | [recipe/passwordless/types.ts:257](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L257) |
| <a id="recipeimplementation-12"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:255](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L255) |
| <a id="validatephonenumber-4"></a> `validatePhoneNumber` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:258](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L258) |

***

### SignInUpProps

```ts
type SignInUpProps = object;
```

Defined in: [recipe/passwordless/types.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L202)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-6"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:210](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L210) |
| <a id="config-13"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:205](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L205) |
| <a id="error-7"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:209](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L209) |
| <a id="factorids"></a> `factorIds` | `string`[] | [recipe/passwordless/types.ts:204](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L204) |
| <a id="onerror-6"></a> `onError` | (`err`) => `void` | [recipe/passwordless/types.ts:208](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L208) |
| <a id="onfetcherror-6"></a> `onFetchError` | (`err`) => `void` | [recipe/passwordless/types.ts:207](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L207) |
| <a id="onsuccess-7"></a> `onSuccess?` | (`result`) => `void` | [recipe/passwordless/types.ts:206](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L206) |
| <a id="recipeimplementation-13"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:203](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L203) |
| <a id="usercontext-1"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/passwordless/types.ts:211](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L211) |
| <a id="validatephonenumber-5"></a> `validatePhoneNumber` | (`phoneNumber`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | [recipe/passwordless/types.ts:212](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L212) |

***

### SignInUpUserInputCodeFormProps

```ts
type SignInUpUserInputCodeFormProps = object;
```

Defined in: [recipe/passwordless/types.ts:272](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L272)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-7"></a> `clearError` | () => `void` | [recipe/passwordless/types.ts:273](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L273) |
| <a id="config-14"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:278](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L278) |
| <a id="error-8"></a> `error` | `string` \| `undefined` | [recipe/passwordless/types.ts:276](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L276) |
| <a id="loginattemptinfo-5"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:279](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L279) |
| <a id="onerror-7"></a> `onError` | (`error`) => `void` | [recipe/passwordless/types.ts:274](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L274) |
| <a id="onfetcherror-7"></a> `onFetchError` | (`error`) => `void` | [recipe/passwordless/types.ts:275](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L275) |
| <a id="onsuccess-8"></a> `onSuccess?` | (`result`) => `void` | [recipe/passwordless/types.ts:280](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L280) |
| <a id="recipeimplementation-14"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:277](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L277) |

***

### UserInput

```ts
type UserInput = 
  | {
  contactMethod: "EMAIL";
  signInUpFeature?: SignInUpFeatureConfigInput;
  validateEmailAddress?: (email) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "PHONE";
  signInUpFeature?: SignInUpFeatureConfigInput & object;
  validatePhoneNumber?: (phoneNumber) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "EMAIL_OR_PHONE";
  signInUpFeature?: SignInUpFeatureConfigInput & object;
  validateEmailAddress?: (email) => Promise<string | undefined> | string | undefined;
  validatePhoneNumber?: (phoneNumber) => Promise<string | undefined> | string | undefined;
} & object & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/passwordless/types.ts:140](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L140)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `linkClickedScreenFeature?` | [`PasswordlessFeatureBaseConfig`](#passwordlessfeaturebaseconfig) | [recipe/passwordless/types.ts:178](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L178) |
| `mfaFeature?` | [`PasswordlessFeatureBaseConfig`](#passwordlessfeaturebaseconfig) | [recipe/passwordless/types.ts:179](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L179) |
| `override?` | `object` | [recipe/passwordless/types.ts:175](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L175) |
| `override.functions()?` | (`originalImplementation`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/passwordless/types.ts:176](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L176) |

***

### UserInputCodeFormFooterProps

```ts
type UserInputCodeFormFooterProps = object;
```

Defined in: [recipe/passwordless/types.ts:401](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L401)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-15"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:404](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L404) |
| <a id="loginattemptinfo-6"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:402](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L402) |
| <a id="recipeimplementation-15"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:403](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L403) |

***

### UserInputCodeFormHeaderProps

```ts
type UserInputCodeFormHeaderProps = object;
```

Defined in: [recipe/passwordless/types.ts:407](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L407)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-16"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/passwordless/types.ts:410](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L410) |
| <a id="loginattemptinfo-7"></a> `loginAttemptInfo` | [`LoginAttemptInfo`](#loginattemptinfo-1) | [recipe/passwordless/types.ts:408](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L408) |
| <a id="recipeimplementation-16"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-7) | [recipe/passwordless/types.ts:409](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/types.ts#L409) |

# References - Frontend SDKs - React SDK Reference -  Passwordless
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-passwordless

## Classes

### default

Defined in: [recipe/passwordless/index.ts:30](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L30)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/passwordless/index.ts:196](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L196) |

#### Methods

##### clearLoginAttemptInfo()

```ts
static clearLoginAttemptInfo(input?): Promise<void>;
```

Defined in: [recipe/passwordless/index.ts:189](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L189)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`void`\>

##### consumeCode()

```ts
static consumeCode(input?): Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  fetchResponse: Response;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  fetchResponse: Response;
  status: "RESTART_FLOW_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [recipe/passwordless/index.ts:84](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L84)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \| \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); `userInputCode`: `string`; \} \| \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `fetchResponse`: `Response`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESTART_FLOW_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

##### createCode()

```ts
static createCode(input): Promise<
  | {
  deviceId: string;
  fetchResponse: Response;
  flowType: PasswordlessFlowType;
  preAuthSessionId: string;
  status: "OK";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [recipe/passwordless/index.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L41)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} \| \{ `options?`: `RecipeFunctionOptions`; `phoneNumber`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |

###### Returns

`Promise`\<
  \| \{
  `deviceId`: `string`;
  `fetchResponse`: `Response`;
  `flowType`: `PasswordlessFlowType`;
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

##### doesEmailExist()

```ts
static doesEmailExist(input): Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [recipe/passwordless/index.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L131)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

##### doesPhoneNumberExist()

```ts
static doesPhoneNumberExist(input): Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [recipe/passwordless/index.ts:146](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L146)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `phoneNumber`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.phoneNumber` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

##### getLinkCodeFromURL()

```ts
static getLinkCodeFromURL(input?): string;
```

Defined in: [recipe/passwordless/index.ts:117](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L117)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`string`

##### getLoginAttemptInfo()

```ts
static getLoginAttemptInfo<CustomLoginAttemptInfoProperties>(input?): Promise<object & CustomLoginAttemptInfoProperties>;
```

Defined in: [recipe/passwordless/index.ts:161](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L161)

###### Type Parameters

| Type Parameter |
| ------ |
| `CustomLoginAttemptInfoProperties` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`object` & `CustomLoginAttemptInfoProperties`\>

##### getPreAuthSessionIdFromURL()

```ts
static getPreAuthSessionIdFromURL(input?): string;
```

Defined in: [recipe/passwordless/index.ts:124](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L124)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`string`

##### init()

```ts
static init(config): any;
```

Defined in: [recipe/passwordless/index.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`UserInput`](recipe-passwordless-types.mdx#userinput) |

###### Returns

`any`

##### resendCode()

```ts
static resendCode(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "RESTART_FLOW_ERROR";
}>;
```

Defined in: [recipe/passwordless/index.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L74)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"RESTART_FLOW_ERROR"`;
\}\>

##### setLoginAttemptInfo()

```ts
static setLoginAttemptInfo<CustomStateProperties>(input): Promise<void>;
```

Defined in: [recipe/passwordless/index.ts:175](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L175)

###### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `attemptInfo`: `object` & `CustomStateProperties`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.attemptInfo` | `object` & `CustomStateProperties` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`void`\>

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [recipe/passwordless/index.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L35)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`void`\>

## Variables

### clearLoginAttemptInfo()

```ts
const clearLoginAttemptInfo: (input?) => Promise<void> = Wrapper.clearLoginAttemptInfo;
```

Defined in: [recipe/passwordless/index.ts:209](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L209)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`void`\>

***

### consumeCode()

```ts
const consumeCode: (input?) => Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  fetchResponse: Response;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  fetchResponse: Response;
  status: "RESTART_FLOW_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = Wrapper.consumeCode;
```

Defined in: [recipe/passwordless/index.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L202)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \| \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); `userInputCode`: `string`; \} \| \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |

#### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `fetchResponse`: `Response`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESTART_FLOW_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

***

### createCode()

```ts
const createCode: (input) => Promise<
  | {
  deviceId: string;
  fetchResponse: Response;
  flowType: PasswordlessFlowType;
  preAuthSessionId: string;
  status: "OK";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = Wrapper.createCode;
```

Defined in: [recipe/passwordless/index.ts:200](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L200)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} \| \{ `options?`: `RecipeFunctionOptions`; `phoneNumber`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |

#### Returns

`Promise`\<
  \| \{
  `deviceId`: `string`;
  `fetchResponse`: `Response`;
  `flowType`: `PasswordlessFlowType`;
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

***

### doesEmailExist()

```ts
const doesEmailExist: (input) => Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = Wrapper.doesEmailExist;
```

Defined in: [recipe/passwordless/index.ts:205](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L205)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

***

### doesPhoneNumberExist()

```ts
const doesPhoneNumberExist: (input) => Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = Wrapper.doesPhoneNumberExist;
```

Defined in: [recipe/passwordless/index.ts:206](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L206)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `phoneNumber`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.phoneNumber` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

***

### getLinkCodeFromURL()

```ts
const getLinkCodeFromURL: (input?) => string = Wrapper.getLinkCodeFromURL;
```

Defined in: [recipe/passwordless/index.ts:203](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L203)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`string`

***

### getLoginAttemptInfo()

```ts
const getLoginAttemptInfo: <CustomLoginAttemptInfoProperties>(input?) => Promise<object & CustomLoginAttemptInfoProperties> = Wrapper.getLoginAttemptInfo;
```

Defined in: [recipe/passwordless/index.ts:207](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L207)

#### Type Parameters

| Type Parameter |
| ------ |
| `CustomLoginAttemptInfoProperties` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`object` & `CustomLoginAttemptInfoProperties`\>

***

### getPreAuthSessionIdFromURL()

```ts
const getPreAuthSessionIdFromURL: (input?) => string = Wrapper.getPreAuthSessionIdFromURL;
```

Defined in: [recipe/passwordless/index.ts:204](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L204)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`string`

***

### init()

```ts
const init: (config) => any = Wrapper.init;
```

Defined in: [recipe/passwordless/index.ts:199](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L199)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`UserInput`](recipe-passwordless-types.mdx#userinput) |

#### Returns

`any`

***

### PasswordlessComponentsOverrideProvider

```ts
const PasswordlessComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/passwordless/index.ts:211](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L211)

***

### resendCode()

```ts
const resendCode: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "RESTART_FLOW_ERROR";
}> = Wrapper.resendCode;
```

Defined in: [recipe/passwordless/index.ts:201](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L201)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"RESTART_FLOW_ERROR"`;
\}\>

***

### setLoginAttemptInfo()

```ts
const setLoginAttemptInfo: <CustomStateProperties>(input) => Promise<void> = Wrapper.setLoginAttemptInfo;
```

Defined in: [recipe/passwordless/index.ts:208](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L208)

#### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `attemptInfo`: `object` & `CustomStateProperties`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.attemptInfo` | `object` & `CustomStateProperties` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`void`\>

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = Wrapper.signOut;
```

Defined in: [recipe/passwordless/index.ts:210](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/passwordless/index.ts#L210)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`void`\>

## References

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-passwordless-types.mdx#getredirectionurlcontext)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-passwordless-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-passwordless-types.mdx#preapihookcontext)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-passwordless-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  Session Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-session-types

## Type Aliases

### AccessDeniedThemeProps

```ts
type AccessDeniedThemeProps = object;
```

Defined in: [recipe/session/types.ts:65](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L65)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`NormalisedSessionConfig`](#normalisedsessionconfig) | [recipe/session/types.ts:72](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L72) |
| <a id="error"></a> `error?` | `string` | [recipe/session/types.ts:70](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L70) |
| <a id="navigate"></a> `navigate` | [`Navigate`](types.mdx#navigate-1) | [recipe/session/types.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L71) |
| <a id="recipe"></a> `recipe` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/session/types.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L66) |

***

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/session/types.ts:75](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L75)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="sessionaccessdenied_override"></a> `SessionAccessDenied_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/session/types.ts:76](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L76) |

***

### InputType

```ts
type InputType = SuperTokensWrapper & object;
```

Defined in: [recipe/session/types.ts:28](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L28)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `accessDeniedScreen?` | [`SessionFeatureBaseConfig`](#sessionfeaturebaseconfig) | [recipe/session/types.ts:30](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L30) |
| `onHandleEvent()?` | (`event`) => `void` | [recipe/session/types.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L31) |
| `style?` | `string` | [recipe/session/types.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L29) |

***

### LoadedSessionContext

```ts
type LoadedSessionContext = object & SessionContextUpdate;
```

Defined in: [recipe/session/types.ts:53](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L53)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `accessDeniedValidatorError?` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/session/types.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L56) |
| `invalidClaims` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)[] | [recipe/session/types.ts:55](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L55) |
| `loading` | `false` | [recipe/session/types.ts:54](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L54) |

***

### NormalisedSessionConfig

```ts
type NormalisedSessionConfig = NormalisedConfig<unknown, any, any> & object;
```

Defined in: [recipe/session/types.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L34)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `accessDeniedScreen` | [`NormalisedBaseConfig`](types.mdx#normalisedbaseconfig) | [recipe/session/types.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L36) |
| `invalidClaimStatusCode` | `number` | [recipe/session/types.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L35) |
| `override` | `object` | [recipe/session/types.ts:37](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L37) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/session/types.ts:38](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L38) |

***

### RecipeEventWithSessionContext

```ts
type RecipeEventWithSessionContext = SuperTokensWrapper & object;
```

Defined in: [recipe/session/types.ts:26](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L26)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `sessionContext` | [`SessionContextUpdate`](#sessioncontextupdate) | [recipe/session/types.ts:26](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L26) |

***

### SessionContextType

```ts
type SessionContextType = 
  | LoadedSessionContext
  | {
  loading: true;
};
```

Defined in: [recipe/session/types.ts:59](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L59)

***

### SessionContextUpdate

```ts
type SessionContextUpdate = object;
```

Defined in: [recipe/session/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L47)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="accesstokenpayload"></a> `accessTokenPayload` | `any` | [recipe/session/types.ts:50](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L50) |
| <a id="doessessionexist"></a> `doesSessionExist` | `boolean` | [recipe/session/types.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L48) |
| <a id="userid"></a> `userId` | `string` | [recipe/session/types.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L49) |

***

### SessionFeatureBaseConfig

```ts
type SessionFeatureBaseConfig = FeatureBaseConfig;
```

Defined in: [recipe/session/types.ts:45](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/types.ts#L45)

# References - Frontend SDKs - React SDK Reference -  Session
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-session

## Classes

### BooleanClaim

Defined in: [claims/booleanClaim.ts:6](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/claims/booleanClaim.ts#L6)

#### Extends

- [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)

#### Constructors

##### Constructor

```ts
new BooleanClaim(config): BooleanClaim;
```

Defined in: [claims/booleanClaim.ts:7](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/claims/booleanClaim.ts#L7)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `any` |

###### Returns

[`BooleanClaim`](#booleanclaim)

###### Overrides

```ts
BooleanClaimWebJS.constructor
```

***

### default

Defined in: [recipe/session/index.ts:34](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L34)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/session/index.ts:112](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L112) |
| `SessionAuth` | `static` | `any` | `SessionAuthWrapper` | [recipe/session/index.ts:38](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L38) |
| `useClaimValue` | `static` | \<`T`\>(`claim`) => \| \{ `loading`: `true`; \} \| \{ `doesSessionExist`: `boolean`; `loading`: `false`; `value`: `T`; \} | `useClaimValueFunc` | [recipe/session/index.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L36) |
| `useSessionContext` | `static` | () => [`SessionContextType`](recipe-session-types.mdx#sessioncontexttype) | `useSessionContextFunc` | [recipe/session/index.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L35) |

#### Methods

##### ~~addAxiosInterceptors()~~

```ts
static addAxiosInterceptors(axiosInstance, userContext?): void;
```

Defined in: [recipe/session/index.ts:75](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L75)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `axiosInstance` | `any` |
| `userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`void`

###### Deprecated

##### attemptRefreshingSession()

```ts
static attemptRefreshingSession(): Promise<boolean>;
```

Defined in: [recipe/session/index.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L62)

###### Returns

`Promise`\<`boolean`\>

##### doesSessionExist()

```ts
static doesSessionExist(input?): Promise<boolean>;
```

Defined in: [recipe/session/index.ts:66](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L66)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`boolean`\>

##### getAccessToken()

```ts
static getAccessToken(input?): Promise<string>;
```

Defined in: [recipe/session/index.ts:50](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L50)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`string`\>

##### getAccessTokenPayloadSecurely()

```ts
static getAccessTokenPayloadSecurely(input?): Promise<any>;
```

Defined in: [recipe/session/index.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L56)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`any`\>

##### getClaimValue()

```ts
static getClaimValue<T>(input): Promise<T>;
```

Defined in: [recipe/session/index.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L105)

###### Type Parameters

| Type Parameter |
| ------ |
| `T` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claim`: `SessionClaim`\<`T`\>; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.claim` | `SessionClaim`\<`T`\> |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`T`\>

##### getInvalidClaimsFromResponse()

```ts
static getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;
```

Defined in: [recipe/session/index.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L98)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `response`: \| `Response` \| \{ `data`: `any`; \}; `userContext`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.response` | \| `Response` \| \{ `data`: `any`; \} |
| `input.userContext` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`ClaimValidationError`[]\>

##### getUserId()

```ts
static getUserId(input?): Promise<string>;
```

Defined in: [recipe/session/index.ts:44](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L44)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`string`\>

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/session/index.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L40)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | `any` |

###### Returns

`any`

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [recipe/session/index.ts:79](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L79)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`void`\>

##### validateClaims()

```ts
static validateClaims(input?): ClaimValidationError[] | Promise<ClaimValidationError[]>;
```

Defined in: [recipe/session/index.ts:85](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L85)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `overrideGlobalClaimValidators?`: (`globalClaimValidators`, `userContext`) => `SessionClaimValidator`[]; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.overrideGlobalClaimValidators?` | (`globalClaimValidators`, `userContext`) => `SessionClaimValidator`[] |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`ClaimValidationError`[] \| `Promise`\<`ClaimValidationError`[]\>

***

### PrimitiveArrayClaim\<T\>

Defined in: [claims/primitiveArrayClaim.ts:6](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/claims/primitiveArrayClaim.ts#L6)

#### Extends

- [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\<`T`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Constructors

##### Constructor

```ts
new PrimitiveArrayClaim<T>(config): PrimitiveArrayClaim<T>;
```

Defined in: [claims/primitiveArrayClaim.ts:7](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/claims/primitiveArrayClaim.ts#L7)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `any` |

###### Returns

[`PrimitiveArrayClaim`](#primitivearrayclaim)\<`T`\>

###### Overrides

```ts
PrimitiveArrayClaimWebJS<T>.constructor
```

***

### PrimitiveClaim\<T\>

Defined in: [claims/primitiveClaim.ts:6](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/claims/primitiveClaim.ts#L6)

#### Extends

- [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\<`T`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Constructors

##### Constructor

```ts
new PrimitiveClaim<T>(config): PrimitiveClaim<T>;
```

Defined in: [claims/primitiveClaim.ts:7](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/claims/primitiveClaim.ts#L7)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `any` |

###### Returns

[`PrimitiveClaim`](#primitiveclaim)\<`T`\>

###### Overrides

```ts
PrimitiveClaimWebJS<T>.constructor
```

## Variables

### ~~addAxiosInterceptors()~~

```ts
const addAxiosInterceptors: (axiosInstance, userContext?) => void = SessionAPIWrapper.addAxiosInterceptors;
```

Defined in: [recipe/session/index.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L127)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `axiosInstance` | `any` |
| `userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`void`

#### Deprecated

#### Deprecated

***

### attemptRefreshingSession()

```ts
const attemptRefreshingSession: () => Promise<boolean> = SessionAPIWrapper.attemptRefreshingSession;
```

Defined in: [recipe/session/index.ts:122](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L122)

#### Returns

`Promise`\<`boolean`\>

***

### doesSessionExist()

```ts
const doesSessionExist: (input?) => Promise<boolean> = SessionAPIWrapper.doesSessionExist;
```

Defined in: [recipe/session/index.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L123)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`boolean`\>

***

### getAccessToken()

```ts
const getAccessToken: (input?) => Promise<string> = SessionAPIWrapper.getAccessToken;
```

Defined in: [recipe/session/index.ts:120](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L120)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`string`\>

***

### getAccessTokenPayloadSecurely()

```ts
const getAccessTokenPayloadSecurely: (input?) => Promise<any> = SessionAPIWrapper.getAccessTokenPayloadSecurely;
```

Defined in: [recipe/session/index.ts:121](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L121)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`any`\>

***

### getClaimValue()

```ts
const getClaimValue: <T>(input) => Promise<T> = SessionAPIWrapper.getClaimValue;
```

Defined in: [recipe/session/index.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L131)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claim`: `SessionClaim`\<`T`\>; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.claim` | `SessionClaim`\<`T`\> |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`T`\>

***

### getInvalidClaimsFromResponse()

```ts
const getInvalidClaimsFromResponse: (input) => Promise<ClaimValidationError[]> = SessionAPIWrapper.getInvalidClaimsFromResponse;
```

Defined in: [recipe/session/index.ts:130](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L130)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `response`: \| `Response` \| \{ `data`: `any`; \}; `userContext`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.response` | \| `Response` \| \{ `data`: `any`; \} |
| `input.userContext` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`ClaimValidationError`[]\>

***

### getUserId()

```ts
const getUserId: (input?) => Promise<string> = SessionAPIWrapper.getUserId;
```

Defined in: [recipe/session/index.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L119)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`string`\>

***

### init()

```ts
const init: (config?) => any = SessionAPIWrapper.init;
```

Defined in: [recipe/session/index.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L118)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | `any` |

#### Returns

`any`

***

### SessionAuth

```ts
const SessionAuth: any = SessionAPIWrapper.SessionAuth;
```

Defined in: [recipe/session/index.ts:117](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L117)

***

### SessionComponentsOverrideProvider

```ts
const SessionComponentsOverrideProvider: any = SessionAPIWrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/session/index.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L132)

***

### SessionContext

```ts
const SessionContext: any;
```

Defined in: [recipe/session/sessionContext.ts:5](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/sessionContext.ts#L5)

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = SessionAPIWrapper.signOut;
```

Defined in: [recipe/session/index.ts:128](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L128)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`void`\>

***

### useClaimValue()

```ts
const useClaimValue: <T>(claim) => 
  | {
  loading: true;
}
  | {
  doesSessionExist: boolean;
  loading: false;
  value: T;
} = SessionAPIWrapper.useClaimValue;
```

Defined in: [recipe/session/index.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L116)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `claim` | `SessionClaim`\<`T`\> |

#### Returns

  \| \{
  `loading`: `true`;
\}
  \| \{
  `doesSessionExist`: `boolean`;
  `loading`: `false`;
  `value`: `T`;
\}

***

### useSessionContext()

```ts
const useSessionContext: () => SessionContextType = SessionAPIWrapper.useSessionContext;
```

Defined in: [recipe/session/index.ts:115](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L115)

#### Returns

[`SessionContextType`](recipe-session-types.mdx#sessioncontexttype)

***

### validateClaims()

```ts
const validateClaims: (input?) => ClaimValidationError[] | Promise<ClaimValidationError[]> = SessionAPIWrapper.validateClaims;
```

Defined in: [recipe/session/index.ts:129](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/session/index.ts#L129)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `overrideGlobalClaimValidators?`: (`globalClaimValidators`, `userContext`) => `SessionClaimValidator`[]; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.overrideGlobalClaimValidators?` | (`globalClaimValidators`, `userContext`) => `SessionClaimValidator`[] |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`ClaimValidationError`[] \| `Promise`\<`ClaimValidationError`[]\>

## References

### ClaimValidationError

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### ClaimValidationResult

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### InputType

Re-exports [InputType](recipe-session-types.mdx#inputtype)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### SessionClaim

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### SessionClaimValidator

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### SessionContextType

Re-exports [SessionContextType](recipe-session-types.mdx#sessioncontexttype)

# References - Frontend SDKs - React SDK Reference -  ThirdParty Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-thirdparty-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/thirdparty/types.ts:39](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L39)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="thirdpartysigninandupcallbacktheme_override"></a> `ThirdPartySignInAndUpCallbackTheme_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/thirdparty/types.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L41) |
| <a id="thirdpartysigninandupprovidersform_override"></a> `ThirdPartySignInAndUpProvidersForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/thirdparty/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L40) |

***

### Config

```ts
type Config = UserInput & AuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/thirdparty/types.ts:55](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L55)

***

### CustomStateProperties

```ts
type CustomStateProperties = object;
```

Defined in: [recipe/thirdparty/types.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L116)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="oauth2loginchallenge"></a> `oauth2LoginChallenge?` | `string` | [recipe/thirdparty/types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L119) |
| <a id="redirecttopath"></a> `redirectToPath` | `string` | [recipe/thirdparty/types.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L118) |
| <a id="rid"></a> `rid` | `string` | [recipe/thirdparty/types.ts:117](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L117) |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = never;
```

Defined in: [recipe/thirdparty/types.ts:84](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L84)

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedAuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/thirdparty/types.ts:58](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L58)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `oAuthCallbackScreen` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/thirdparty/types.ts:60](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L60) |
| `override` | `object` | [recipe/thirdparty/types.ts:61](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L61) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/thirdparty/types.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L62) |
| `signInAndUpFeature` | [`NormalisedSignInAndUpFeatureConfig`](#normalisedsigninandupfeatureconfig) | [recipe/thirdparty/types.ts:59](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L59) |

***

### NormalisedSignInAndUpFeatureConfig

```ts
type NormalisedSignInAndUpFeatureConfig = NormalisedBaseConfig & object;
```

Defined in: [recipe/thirdparty/types.ts:76](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L76)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `providers` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)[] | [recipe/thirdparty/types.ts:80](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L80) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = 
  | AuthRecipeModuleOnHandleEventContext
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
  userContext: UserContext;
};
```

Defined in: [recipe/thirdparty/types.ts:95](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L95)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "GET_AUTHORISATION_URL" | "THIRD_PARTY_SIGN_IN_UP";
```

Defined in: [recipe/thirdparty/types.ts:86](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L86)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/thirdparty/types.ts:88](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L88)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/thirdparty/types.ts:89](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L89) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/thirdparty/types.ts:90](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L90) |
| <a id="url"></a> `url` | `string` | [recipe/thirdparty/types.ts:91](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L91) |
| <a id="usercontext"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/thirdparty/types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L92) |

***

### SignInAndUpFeatureUserInput

```ts
type SignInAndUpFeatureUserInput = FeatureBaseConfig & object;
```

Defined in: [recipe/thirdparty/types.ts:69](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L69)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `providers?` | ( \| [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) \| `CustomProviderConfig`)[] | [recipe/thirdparty/types.ts:73](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L73) |

***

### SignInAndUpThemeProps

```ts
type SignInAndUpThemeProps = PartialAuthComponentProps & object;
```

Defined in: [recipe/thirdparty/types.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L105)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/thirdparty/types.ts:108](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L108) |
| `providers` | `Pick`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"id"` \| `"getButton"`\>[] | [recipe/thirdparty/types.ts:106](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L106) |
| `recipeImplementation` | [`WebJSRecipeInterface`](types.mdx#webjsrecipeinterface)\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/thirdparty/types.ts:107](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L107) |

***

### StateObject

```ts
type StateObject = SuperTokensWrapper & object;
```

Defined in: [recipe/thirdparty/types.ts:111](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L111)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `redirectToPath?` | `string` | [recipe/thirdparty/types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L113) |
| `rid?` | `string` | [recipe/thirdparty/types.ts:112](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L112) |

***

### UserInput

```ts
type UserInput = object & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/thirdparty/types.ts:44](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L44)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `oAuthCallbackScreen?` | [`FeatureBaseConfig`](types.mdx#featurebaseconfig) | [recipe/thirdparty/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L46) |
| `override?` | `object` | [recipe/thirdparty/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L47) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/thirdparty/types.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L48) |
| `signInAndUpFeature?` | [`SignInAndUpFeatureUserInput`](#signinandupfeatureuserinput) | [recipe/thirdparty/types.ts:45](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/types.ts#L45) |

# References - Frontend SDKs - React SDK Reference -  ThirdParty
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-thirdparty

## Classes

### default

Defined in: [recipe/thirdparty/index.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L47)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="activedirectory"></a> `ActiveDirectory` | `static` | `any` | `ActiveDirectory` | [recipe/thirdparty/index.ts:143](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L143) |
| <a id="apple"></a> `Apple` | `static` | `any` | `Apple` | [recipe/thirdparty/index.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L134) |
| <a id="bitbucket"></a> `Bitbucket` | `static` | `any` | `Bitbucket` | [recipe/thirdparty/index.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L135) |
| <a id="boxysaml"></a> `BoxySAML` | `static` | `any` | `BoxySAML` | [recipe/thirdparty/index.ts:144](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L144) |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/thirdparty/index.ts:147](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L147) |
| <a id="discord"></a> `Discord` | `static` | `any` | `Discord` | [recipe/thirdparty/index.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L136) |
| <a id="facebook"></a> `Facebook` | `static` | `any` | `Facebook` | [recipe/thirdparty/index.ts:141](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L141) |
| <a id="github"></a> `Github` | `static` | `any` | `Github` | [recipe/thirdparty/index.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L137) |
| <a id="gitlab"></a> `Gitlab` | `static` | `any` | `Gitlab` | [recipe/thirdparty/index.ts:138](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L138) |
| <a id="google"></a> `Google` | `static` | `any` | `Google` | [recipe/thirdparty/index.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L139) |
| <a id="googleworkspaces"></a> `GoogleWorkspaces` | `static` | `any` | `GoogleWorkspaces` | [recipe/thirdparty/index.ts:140](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L140) |
| <a id="linkedin"></a> `LinkedIn` | `static` | `any` | `LinkedIn` | [recipe/thirdparty/index.ts:142](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L142) |
| <a id="okta"></a> `Okta` | `static` | `any` | `Okta` | [recipe/thirdparty/index.ts:145](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L145) |
| <a id="twitter"></a> `Twitter` | `static` | `any` | `Twitter` | [recipe/thirdparty/index.ts:146](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L146) |

#### Methods

##### getAuthorisationURLWithQueryParamsAndSetState()

```ts
static getAuthorisationURLWithQueryParamsAndSetState(input): Promise<string>;
```

Defined in: [recipe/thirdparty/index.ts:87](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L87)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `frontendRedirectURI`: `string`; `options?`: `RecipeFunctionOptions`; `redirectURIOnProviderDashboard?`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.frontendRedirectURI` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.redirectURIOnProviderDashboard?` | `string` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.thirdPartyId` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`string`\>

##### getProviders()

```ts
static getProviders(): object[];
```

Defined in: [recipe/thirdparty/index.ts:124](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L124)

###### Returns

`object`[]

##### getStateAndOtherInfoFromStorage()

```ts
static getStateAndOtherInfoFromStorage<CustomStateProperties>(input?): any;
```

Defined in: [recipe/thirdparty/index.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L78)

###### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/thirdparty/index.ts:52](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L52)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) |

###### Returns

`any`

##### redirectToThirdPartyLogin()

```ts
static redirectToThirdPartyLogin(input): Promise<{
  status: "OK" | "ERROR";
}>;
```

Defined in: [recipe/thirdparty/index.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L62)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.thirdPartyId` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"ERROR"`;
\}\>

##### signInAndUp()

```ts
static signInAndUp(input?): Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "NO_EMAIL_GIVEN_BY_PROVIDER";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [recipe/thirdparty/index.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L101)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"NO_EMAIL_GIVEN_BY_PROVIDER"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [recipe/thirdparty/index.ts:56](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L56)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`Promise`\<`void`\>

## Variables

### getAuthorisationURLWithQueryParamsAndSetState()

```ts
const getAuthorisationURLWithQueryParamsAndSetState: (input) => Promise<string> = Wrapper.getAuthorisationURLWithQueryParamsAndSetState;
```

Defined in: [recipe/thirdparty/index.ts:154](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L154)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `frontendRedirectURI`: `string`; `options?`: `RecipeFunctionOptions`; `redirectURIOnProviderDashboard?`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.frontendRedirectURI` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.redirectURIOnProviderDashboard?` | `string` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.thirdPartyId` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`string`\>

***

### getProviders()

```ts
const getProviders: () => object[] = Wrapper.getProviders;
```

Defined in: [recipe/thirdparty/index.ts:156](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L156)

#### Returns

`object`[]

***

### getStateAndOtherInfoFromStorage()

```ts
const getStateAndOtherInfoFromStorage: <CustomStateProperties>(input?) => any = Wrapper.getStateAndOtherInfoFromStorage;
```

Defined in: [recipe/thirdparty/index.ts:153](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L153)

#### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### init()

```ts
const init: (config?) => any = Wrapper.init;
```

Defined in: [recipe/thirdparty/index.ts:150](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L150)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) |

#### Returns

`any`

***

### redirectToThirdPartyLogin()

```ts
const redirectToThirdPartyLogin: (input) => Promise<{
  status: "OK" | "ERROR";
}> = Wrapper.redirectToThirdPartyLogin;
```

Defined in: [recipe/thirdparty/index.ts:152](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L152)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.thirdPartyId` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"ERROR"`;
\}\>

***

### signInAndUp()

```ts
const signInAndUp: (input?) => Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "NO_EMAIL_GIVEN_BY_PROVIDER";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = Wrapper.signInAndUp;
```

Defined in: [recipe/thirdparty/index.ts:155](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L155)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: `User`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"NO_EMAIL_GIVEN_BY_PROVIDER"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = Wrapper.signOut;
```

Defined in: [recipe/thirdparty/index.ts:151](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L151)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`Promise`\<`void`\>

***

### ThirdpartyComponentsOverrideProvider

```ts
const ThirdpartyComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/thirdparty/index.ts:157](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/thirdparty/index.ts#L157)

## References

### ActiveDirectory

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Apple

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Bitbucket

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### BoxySAML

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Discord

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Facebook

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-thirdparty-types.mdx#getredirectionurlcontext)

***

### Github

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Gitlab

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Google

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### GoogleWorkspaces

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### LinkedIn

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Okta

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-thirdparty-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-thirdparty-types.mdx#preapihookcontext)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### Twitter

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-thirdparty-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  TOTP Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-totp-types

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/totp/types.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L35)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="totpblockedscreen_override"></a> `TOTPBlockedScreen_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:36](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L36) |
| <a id="totpcodeform_override"></a> `TOTPCodeForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:38](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L38) |
| <a id="totpcodeverificationfooter_override"></a> `TOTPCodeVerificationFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:39](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L39) |
| <a id="totpcodeverificationheader_override"></a> `TOTPCodeVerificationHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:40](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L40) |
| <a id="totpdeviceinfosection_override"></a> `TOTPDeviceInfoSection_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:43](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L43) |
| <a id="totpdevicesetupfooter_override"></a> `TOTPDeviceSetupFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L41) |
| <a id="totpdevicesetupheader_override"></a> `TOTPDeviceSetupHeader_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:42](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L42) |
| <a id="totploadingscreen_override"></a> `TOTPLoadingScreen_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/totp/types.ts:37](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L37) |

***

### Config

```ts
type Config = UserInput & RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/totp/types.ts:142](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L142)

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = never;
```

Defined in: [recipe/totp/types.ts:157](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L157)

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/totp/types.ts:145](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L145)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [recipe/totp/types.ts:148](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L148) |
| `override.functions()` | (`originalImplementation`, `builder?`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/totp/types.ts:149](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L149) |
| `totpMFAScreen` | [`TOTPMFAScreenConfig`](#totpmfascreenconfig) | [recipe/totp/types.ts:146](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L146) |

***

### OnHandleEventContext

```ts
type OnHandleEventContext = 
  | {
  action: "TOTP_CODE_VERIFIED";
  userContext: UserContext;
}
  | {
  action: "TOTP_DEVICE_VERIFIED";
  deviceName: string;
  userContext: UserContext;
  wasAlreadyVerified: boolean;
}
  | {
  action: "TOTP_DEVICE_CREATED";
  deviceName: string;
  userContext: UserContext;
};
```

Defined in: [recipe/totp/types.ts:173](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L173)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "CREATE_DEVICE"
  | "VERIFY_CODE"
  | "VERIFY_DEVICE"
  | "REMOVE_DEVICE"
  | "LIST_DEVICES";
```

Defined in: [recipe/totp/types.ts:159](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L159)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = object;
```

Defined in: [recipe/totp/types.ts:166](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L166)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="action"></a> `action` | [`PreAndPostAPIHookAction`](#preandpostapihookaction) | [recipe/totp/types.ts:167](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L167) |
| <a id="requestinit"></a> `requestInit` | `RequestInit` | [recipe/totp/types.ts:168](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L168) |
| <a id="url"></a> `url` | `string` | [recipe/totp/types.ts:169](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L169) |
| <a id="usercontext"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/totp/types.ts:170](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L170) |

***

### TOTPDeviceInfo

```ts
type TOTPDeviceInfo = object;
```

Defined in: [recipe/totp/types.ts:46](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L46)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="devicename"></a> `deviceName` | `string` | [recipe/totp/types.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L47) |
| <a id="qrcodestring"></a> `qrCodeString` | `string` | [recipe/totp/types.ts:49](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L49) |
| <a id="secret"></a> `secret` | `string` | [recipe/totp/types.ts:48](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L48) |
| <a id="useridentifier"></a> `userIdentifier?` | `string` | [recipe/totp/types.ts:50](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L50) |

***

### TOTPMFAAction

```ts
type TOTPMFAAction = 
  | {
  callingCreateDevice: boolean;
  deviceInfo: TOTPDeviceInfo | undefined;
  error: string | undefined;
  showAccessDenied: boolean;
  showBackButton: boolean;
  type: "load";
}
  | {
  deviceInfo: TOTPDeviceInfo;
  type: "createDevice";
}
  | {
  error: string | undefined;
  nextRetryAt: number;
  type: "setBlocked";
}
  | {
  currAttemptCount?: number;
  error: string | undefined;
  maxAttemptCount?: number;
  showAccessDenied: boolean;
  type: "setError";
}
  | {
  error: string | undefined;
  type: "restartFlow";
}
  | {
  type: "success";
}
  | {
  type: "showSecret";
};
```

Defined in: [recipe/totp/types.ts:53](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L53)

***

### TOTPMFAChildProps

```ts
type TOTPMFAChildProps = Omit<TOTPMFAProps, "featureState" | "dispatch">;
```

Defined in: [recipe/totp/types.ts:121](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L121)

***

### TOTPMFACommonProps

```ts
type TOTPMFACommonProps = object;
```

Defined in: [recipe/totp/types.ts:102](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L102)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/totp/types.ts:105](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L105) |
| <a id="featurestate"></a> `featureState` | [`TOTPMFAState`](#totpmfastate) | [recipe/totp/types.ts:103](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L103) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/totp/types.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L104) |
| <a id="usercontext-1"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/totp/types.ts:106](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L106) |

***

### TOTPMFAProps

```ts
type TOTPMFAProps = object;
```

Defined in: [recipe/totp/types.ts:109](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L109)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-2"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/totp/types.ts:111](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L111) |
| <a id="dispatch"></a> `dispatch` | `Dispatch`\<[`TOTPMFAAction`](#totpmfaaction)\> | [recipe/totp/types.ts:117](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L117) |
| <a id="featurestate-1"></a> `featureState` | [`TOTPMFAState`](#totpmfastate) | [recipe/totp/types.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L118) |
| <a id="onbackbuttonclicked"></a> `onBackButtonClicked` | () => `void` | [recipe/totp/types.ts:114](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L114) |
| <a id="onretryclicked"></a> `onRetryClicked` | () => `void` | [recipe/totp/types.ts:115](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L115) |
| <a id="onshowsecretclicked"></a> `onShowSecretClicked` | () => `void` | [recipe/totp/types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L113) |
| <a id="onsignoutclicked"></a> `onSignOutClicked` | () => `void` | [recipe/totp/types.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L116) |
| <a id="onsuccess"></a> `onSuccess` | () => `void` | [recipe/totp/types.ts:112](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L112) |
| <a id="recipeimplementation-1"></a> `recipeImplementation` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/totp/types.ts:110](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L110) |
| <a id="usercontext-2"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/totp/types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L119) |

***

### TOTPMFAScreenConfig

```ts
type TOTPMFAScreenConfig = object;
```

Defined in: [recipe/totp/types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L123)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="blockedscreenstyle"></a> `blockedScreenStyle` | `string` | [recipe/totp/types.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L127) |
| <a id="disabledefaultui"></a> `disableDefaultUI` | `boolean` | [recipe/totp/types.ts:124](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L124) |
| <a id="loadingscreenstyle"></a> `loadingScreenStyle` | `string` | [recipe/totp/types.ts:128](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L128) |
| <a id="setupscreenstyle"></a> `setupScreenStyle` | `string` | [recipe/totp/types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L125) |
| <a id="verificationscreenstyle"></a> `verificationScreenStyle` | `string` | [recipe/totp/types.ts:126](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L126) |

***

### TOTPMFAState

```ts
type TOTPMFAState = object;
```

Defined in: [recipe/totp/types.ts:89](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L89)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="currattemptcount"></a> `currAttemptCount?` | `number` | [recipe/totp/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L98) |
| <a id="deviceinfo"></a> `deviceInfo?` | [`TOTPDeviceInfo`](#totpdeviceinfo) | [recipe/totp/types.ts:90](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L90) |
| <a id="error"></a> `error` | `string` \| `undefined` | [recipe/totp/types.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L96) |
| <a id="isblocked"></a> `isBlocked` | `boolean` | [recipe/totp/types.ts:93](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L93) |
| <a id="loaded"></a> `loaded` | `boolean` | [recipe/totp/types.ts:95](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L95) |
| <a id="maxattemptcount"></a> `maxAttemptCount?` | `number` | [recipe/totp/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L97) |
| <a id="nextretryat"></a> `nextRetryAt?` | `number` | [recipe/totp/types.ts:92](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L92) |
| <a id="showaccessdenied"></a> `showAccessDenied` | `boolean` | [recipe/totp/types.ts:99](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L99) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [recipe/totp/types.ts:94](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L94) |
| <a id="showsecret"></a> `showSecret` | `boolean` | [recipe/totp/types.ts:91](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L91) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/totp/types.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L131)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [recipe/totp/types.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L134) |
| `override.functions()?` | (`originalImplementation`, `builder?`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/totp/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L135) |
| `totpMFAScreen?` | `Partial`\<[`TOTPMFAScreenConfig`](#totpmfascreenconfig)\> | [recipe/totp/types.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/types.ts#L132) |

# References - Frontend SDKs - React SDK Reference -  TOTP
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-totp

## Classes

### default

Defined in: [recipe/totp/index.ts:31](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L31)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/totp/index.ts:71](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L71) |

#### Methods

##### createDevice()

```ts
static createDevice(input?): any;
```

Defined in: [recipe/totp/index.ts:35](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L35)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `deviceName?`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.deviceName?` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/totp/index.ts:32](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L32)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-totp-types.mdx#userinput) |

###### Returns

`any`

##### listDevices()

```ts
static listDevices(input?): any;
```

Defined in: [recipe/totp/index.ts:64](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L64)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### removeDevice()

```ts
static removeDevice(input): any;
```

Defined in: [recipe/totp/index.ts:58](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L58)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.deviceName` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### verifyCode()

```ts
static verifyCode(input): any;
```

Defined in: [recipe/totp/index.ts:41](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L41)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `totp`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.totp` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

##### verifyDevice()

```ts
static verifyDevice(input): any;
```

Defined in: [recipe/totp/index.ts:47](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L47)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: `any`; `totp`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.deviceName` | `string` |
| `input.options?` | `any` |
| `input.totp` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

###### Returns

`any`

## Variables

### createDevice()

```ts
const createDevice: (input?) => any = Wrapper.createDevice;
```

Defined in: [recipe/totp/index.ts:75](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L75)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `deviceName?`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.deviceName?` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### init()

```ts
const init: (config?) => any = Wrapper.init;
```

Defined in: [recipe/totp/index.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L74)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-totp-types.mdx#userinput) |

#### Returns

`any`

***

### listDevices()

```ts
const listDevices: (input?) => any = Wrapper.listDevices;
```

Defined in: [recipe/totp/index.ts:79](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L79)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### removeDevice()

```ts
const removeDevice: (input) => any = Wrapper.removeDevice;
```

Defined in: [recipe/totp/index.ts:78](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L78)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: `RecipeFunctionOptions`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.deviceName` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### TOTPComponentsOverrideProvider

```ts
const TOTPComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/totp/index.ts:80](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L80)

***

### verifyCode()

```ts
const verifyCode: (input) => any = Wrapper.verifyCode;
```

Defined in: [recipe/totp/index.ts:76](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L76)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `totp`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.totp` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

***

### verifyDevice()

```ts
const verifyDevice: (input) => any = Wrapper.verifyDevice;
```

Defined in: [recipe/totp/index.ts:77](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/totp/index.ts#L77)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: `any`; `totp`: `string`; `userContext?`: [`UserContext`](types.mdx#usercontext-1); \} |
| `input.deviceName` | `string` |
| `input.options?` | `any` |
| `input.totp` | `string` |
| `input.userContext?` | [`UserContext`](types.mdx#usercontext-1) |

#### Returns

`any`

## References

### GetRedirectionURLContext

Re-exports [GetRedirectionURLContext](recipe-totp-types.mdx#getredirectionurlcontext)

***

### OnHandleEventContext

Re-exports [OnHandleEventContext](recipe-totp-types.mdx#onhandleeventcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-totp-types.mdx#preapihookcontext)

***

### RecipeInterface

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserInput

Re-exports [UserInput](recipe-totp-types.mdx#userinput)

# References - Frontend SDKs - React SDK Reference -  UserRoles
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-userroles

## Classes

### default

Defined in: [recipe/userroles/index.ts:5](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/userroles/index.ts#L5)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="permissionclaim"></a> `PermissionClaim` | `static` | `PrimitiveArrayClaim`\<`string`\> | `PermissionClaim` | [recipe/userroles/index.ts:6](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/userroles/index.ts#L6) |
| <a id="userroleclaim"></a> `UserRoleClaim` | `static` | `PrimitiveArrayClaim`\<`string`\> | `UserRoleClaim` | [recipe/userroles/index.ts:7](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/userroles/index.ts#L7) |

## References

### PermissionClaim

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

***

### UserRoleClaim

Renames and re-exports [SuperTokensWrapper](index.mdx#supertokenswrapper-1)

# References - Frontend SDKs - React SDK Reference -  WebAuthn Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-webauthn-types

## Enumerations

### RecoverAccountScreen

Defined in: [recipe/webauthn/types.ts:190](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L190)

#### Enumeration Members

| Enumeration Member | Value | Defined in |
| ------ | ------ | ------ |
| <a id="continuewithpasskey"></a> `ContinueWithPasskey` | `0` | [recipe/webauthn/types.ts:191](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L191) |
| <a id="success"></a> `Success` | `1` | [recipe/webauthn/types.ts:192](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L192) |

***

### SendRecoveryEmailScreen

Defined in: [recipe/webauthn/types.ts:217](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L217)

#### Enumeration Members

| Enumeration Member | Value | Defined in |
| ------ | ------ | ------ |
| <a id="recoveraccount"></a> `RecoverAccount` | `0` | [recipe/webauthn/types.ts:218](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L218) |
| <a id="recoveremailsent"></a> `RecoverEmailSent` | `1` | [recipe/webauthn/types.ts:219](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L219) |

## Type Aliases

### ComponentOverrideMap

```ts
type ComponentOverrideMap = object;
```

Defined in: [recipe/webauthn/types.ts:125](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L125)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="webauthncontinuewithoutpasskey_override"></a> `WebauthnContinueWithoutPasskey_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:133](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L133) |
| <a id="webauthncontinuewithpasskey_override"></a> `WebauthnContinueWithPasskey_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:126](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L126) |
| <a id="webauthnmfafooter_override"></a> `WebauthnMFAFooter_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:140](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L140) |
| <a id="webauthnmfaloadingscreen_override"></a> `WebauthnMFALoadingScreen_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:137](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L137) |
| <a id="webauthnmfasignin_override"></a> `WebauthnMFASignIn_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:136](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L136) |
| <a id="webauthnmfasignup_override"></a> `WebauthnMFASignUp_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:138](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L138) |
| <a id="webauthnmfasignupconfirmation_override"></a> `WebauthnMFASignUpConfirmation_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:139](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L139) |
| <a id="webauthnpasskeyconfirmation_override"></a> `WebauthnPasskeyConfirmation_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:131](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L131) |
| <a id="webauthnpasskeyfeatureblock_override"></a> `WebauthnPasskeyFeatureBlock_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:132](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L132) |
| <a id="webauthnpasskeynotsupportederror_override"></a> `WebauthnPasskeyNotSupportedError_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:127](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L127) |
| <a id="webauthnpasskeyrecoveryemailsent_override"></a> `WebauthnPasskeyRecoveryEmailSent_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:128](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L128) |
| <a id="webauthnpasskeysignupform_override"></a> `WebauthnPasskeySignUpForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:134](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L134) |
| <a id="webauthnpasskeysignupsomethingwentwrong_override"></a> `WebauthnPasskeySignUpSomethingWentWrong_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:135](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L135) |
| <a id="webauthnrecoveraccount_override"></a> `WebauthnRecoverAccount_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:130](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L130) |
| <a id="webauthnrecoveraccountform_override"></a> `WebauthnRecoverAccountForm_Override?` | `ComponentOverride`\<*typeof* [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1)\> | [recipe/webauthn/types.ts:129](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L129) |

***

### Config

```ts
type Config = UserInput & AuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/webauthn/types.ts:104](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L104)

***

### ContinueOnSuccessParams

```ts
type ContinueOnSuccessParams = object;
```

Defined in: [recipe/webauthn/types.ts:237](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L237)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email"></a> `email` | `string` | [recipe/webauthn/types.ts:238](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L238) |

***

### ContinueWithPasskeyProps

```ts
type ContinueWithPasskeyProps = object;
```

Defined in: [recipe/webauthn/types.ts:253](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L253)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="continueto"></a> `continueTo` | `"SIGN_UP"` \| `"SIGN_IN"` | [recipe/webauthn/types.ts:255](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L255) |
| <a id="continuewithpasskeyclicked"></a> `continueWithPasskeyClicked` | () => `void` | [recipe/webauthn/types.ts:256](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L256) |
| <a id="isloading"></a> `isLoading` | `boolean` | [recipe/webauthn/types.ts:257](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L257) |
| <a id="ispasskeysupported"></a> `isPasskeySupported` | `boolean` | [recipe/webauthn/types.ts:259](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L259) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:258](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L258) |

***

### EmailSentProps

```ts
type EmailSentProps = object;
```

Defined in: [recipe/webauthn/types.ts:262](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L262)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email-1"></a> `email` | `string` | [recipe/webauthn/types.ts:263](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L263) |
| <a id="onemailchangeclick"></a> `onEmailChangeClick` | () => `void` | [recipe/webauthn/types.ts:264](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L264) |

***

### FeatureBlockDetailProps

```ts
type FeatureBlockDetailProps = object;
```

Defined in: [recipe/webauthn/types.ts:241](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L241)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="icon"></a> `icon` | `JSX.Element` | [recipe/webauthn/types.ts:244](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L244) |
| <a id="subtext"></a> `subText` | `string` | [recipe/webauthn/types.ts:243](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L243) |
| <a id="title"></a> `title` | `string` | [recipe/webauthn/types.ts:242](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L242) |

***

### GetRedirectionURLContext

```ts
type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<{
  action: "SEND_RECOVERY_EMAIL";
}>;
```

Defined in: [recipe/webauthn/types.ts:55](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L55)

***

### NormalisedConfig

```ts
type NormalisedConfig = object & NormalisedAuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/webauthn/types.ts:113](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L113)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI?` | `boolean` | [recipe/webauthn/types.ts:116](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L116) |
| `override` | `object` | [recipe/webauthn/types.ts:118](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L118) |
| `override.functions()` | (`originalImplementation`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/webauthn/types.ts:119](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L119) |
| `recoveryFeature` | [`NormalisedRecoveryFeatureConfig`](#normalisedrecoveryfeatureconfig) | [recipe/webauthn/types.ts:115](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L115) |
| `signInAndUpFeature` | [`NormalisedSignInAndUpFormFeatureConfig`](#normalisedsigninandupformfeatureconfig) | [recipe/webauthn/types.ts:114](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L114) |

***

### NormalisedRecoveryFeatureConfig

```ts
type NormalisedRecoveryFeatureConfig = NormalisedBaseConfig & object;
```

Defined in: [recipe/webauthn/types.ts:109](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L109)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `disableDefaultUI` | `boolean` | [recipe/webauthn/types.ts:110](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L110) |

***

### NormalisedSignInAndUpFormFeatureConfig

```ts
type NormalisedSignInAndUpFormFeatureConfig = NormalisedBaseConfig;
```

Defined in: [recipe/webauthn/types.ts:107](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L107)

***

### OnHandleEventContext

```ts
type OnHandleEventContext = 
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
}
  | {
  action: "GET_EMAIL_EXISTS";
  exists: boolean;
}
  | {
  action: "REGISTER_CREDENTIAL_OK";
}
  | {
  action: "AUTHENTICATE_CREDENTIAL_OK";
}
  | {
  action: "FAILED_TO_REGISTER_USER";
}
  | AuthRecipeModuleOnHandleEventContext;
```

Defined in: [recipe/webauthn/types.ts:74](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L74)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "REGISTER_OPTIONS"
  | "SIGN_IN_OPTIONS"
  | "SIGN_UP"
  | "SIGN_IN"
  | "EMAIL_EXISTS"
  | "GENERATE_RECOVER_ACCOUNT_TOKEN"
  | "RECOVER_ACCOUNT"
  | "REGISTER_CREDENTIAL"
  | "REMOVE_CREDENTIAL"
  | "LIST_CREDENTIALS";
```

Defined in: [recipe/webauthn/types.ts:62](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L62)

***

### RecipeImplementation

```ts
type RecipeImplementation = WebJSRecipeInterface<typeof SuperTokensWrapper>;
```

Defined in: [recipe/webauthn/types.ts:123](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L123)

***

### RecoverAccountWithTokenProps

```ts
type RecoverAccountWithTokenProps = object;
```

Defined in: [recipe/webauthn/types.ts:178](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L178)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="children"></a> `children?` | `React.ReactNode` | [recipe/webauthn/types.ts:182](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L182) |
| <a id="recipe"></a> `recipe` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/webauthn/types.ts:180](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L180) |
| <a id="usecomponentoverrides"></a> `useComponentOverrides` | () => [`ComponentOverrideMap`](#componentoverridemap) | [recipe/webauthn/types.ts:181](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L181) |
| <a id="usercontext"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/webauthn/types.ts:179](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L179) |

***

### RecoverAccountWithTokenThemeProps

```ts
type RecoverAccountWithTokenThemeProps = object;
```

Defined in: [recipe/webauthn/types.ts:195](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L195)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="activescreen"></a> `activeScreen` | [`RecoverAccountScreen`](#recoveraccountscreen) | [recipe/webauthn/types.ts:206](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L206) |
| <a id="clearerror"></a> `clearError` | () => `void` | [recipe/webauthn/types.ts:200](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L200) |
| <a id="config-1"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/webauthn/types.ts:196](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L196) |
| <a id="error"></a> `error` | `string` \| `undefined` | [recipe/webauthn/types.ts:199](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L199) |
| <a id="errormessagelabel"></a> `errorMessageLabel` | `string` \| `null` | [recipe/webauthn/types.ts:204](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L204) |
| <a id="isloading-1"></a> `isLoading` | `boolean` | [recipe/webauthn/types.ts:205](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L205) |
| <a id="oncontinueclick"></a> `onContinueClick` | () => `void` | [recipe/webauthn/types.ts:207](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L207) |
| <a id="onerror"></a> `onError` | (`error`) => `void` | [recipe/webauthn/types.ts:201](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L201) |
| <a id="recipeimplementation-2"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:198](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L198) |
| <a id="registeroptions"></a> `registerOptions` | [`RegisterOptions`](#registeroptions-1) \| `null` | [recipe/webauthn/types.ts:203](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L203) |
| <a id="token"></a> `token` | `string` \| `null` | [recipe/webauthn/types.ts:202](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L202) |
| <a id="usercontext-1"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/webauthn/types.ts:197](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L197) |

***

### RecoverFormProps

```ts
type RecoverFormProps = object;
```

Defined in: [recipe/webauthn/types.ts:247](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L247)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="onbackclick"></a> `onBackClick` | () => `void` | [recipe/webauthn/types.ts:249](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L249) |
| <a id="onsuccess"></a> `onSuccess` | (`result`) => `void` | [recipe/webauthn/types.ts:248](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L248) |
| <a id="recipeimplementation-3"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:250](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L250) |

***

### RegisterOptions

```ts
type RegisterOptions = Extract<Awaited<ReturnType<RecipeImplementation["getRegisterOptions"]>>, {
  status: "OK";
}>;
```

Defined in: [recipe/webauthn/types.ts:185](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L185)

***

### SendRecoveryEmailFormProps

```ts
type SendRecoveryEmailFormProps = object;
```

Defined in: [recipe/webauthn/types.ts:210](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L210)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="children-1"></a> `children?` | `React.ReactNode` | [recipe/webauthn/types.ts:214](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L214) |
| <a id="recipe-1"></a> `recipe` | [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/webauthn/types.ts:212](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L212) |
| <a id="usecomponentoverrides-1"></a> `useComponentOverrides` | () => [`ComponentOverrideMap`](#componentoverridemap) | [recipe/webauthn/types.ts:213](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L213) |
| <a id="usercontext-2"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/webauthn/types.ts:211](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L211) |

***

### SendRecoveryEmailFormThemeProps

```ts
type SendRecoveryEmailFormThemeProps = object;
```

Defined in: [recipe/webauthn/types.ts:222](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L222)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="activescreen-1"></a> `activeScreen` | [`SendRecoveryEmailScreen`](#sendrecoveryemailscreen) | [recipe/webauthn/types.ts:230](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L230) |
| <a id="clearerror-1"></a> `clearError` | () => `void` | [recipe/webauthn/types.ts:227](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L227) |
| <a id="config-2"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/webauthn/types.ts:223](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L223) |
| <a id="error-1"></a> `error` | `string` \| `undefined` | [recipe/webauthn/types.ts:226](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L226) |
| <a id="onemailchangeclick-1"></a> `onEmailChangeClick` | () => `void` | [recipe/webauthn/types.ts:234](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L234) |
| <a id="onerror-1"></a> `onError` | (`error`) => `void` | [recipe/webauthn/types.ts:228](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L228) |
| <a id="onrecoveraccountbackclick"></a> `onRecoverAccountBackClick` | () => `void` | [recipe/webauthn/types.ts:233](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L233) |
| <a id="onrecoveraccountformsuccess"></a> `onRecoverAccountFormSuccess` | (`result`) => `void` | [recipe/webauthn/types.ts:232](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L232) |
| <a id="recipeimplementation-4"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:225](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L225) |
| <a id="recoveraccountemail"></a> `recoverAccountEmail` | `string` | [recipe/webauthn/types.ts:229](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L229) |
| <a id="setactivescreen"></a> `setActiveScreen` | `React.Dispatch`\<`React.SetStateAction`\<[`SendRecoveryEmailScreen`](#sendrecoveryemailscreen)\>\> | [recipe/webauthn/types.ts:231](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L231) |
| <a id="usercontext-3"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/webauthn/types.ts:224](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L224) |

***

### SignInThemeProps

```ts
type SignInThemeProps = SignUpThemeBaseProps & object;
```

Defined in: [recipe/webauthn/types.ts:162](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L162)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `isPasskeySupported` | `boolean` | [recipe/webauthn/types.ts:163](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L163) |

***

### SignUpFormProps

```ts
type SignUpFormProps = object;
```

Defined in: [recipe/webauthn/types.ts:166](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L166)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-2"></a> `clearError` | () => `void` | [recipe/webauthn/types.ts:167](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L167) |
| <a id="config-3"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/webauthn/types.ts:172](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L172) |
| <a id="error-2"></a> `error` | `string` \| `undefined` | [recipe/webauthn/types.ts:170](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L170) |
| <a id="onerror-2"></a> `onError` | (`error`) => `void` | [recipe/webauthn/types.ts:168](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L168) |
| <a id="onfetcherror"></a> `onFetchError?` | (`error`) => `void` | [recipe/webauthn/types.ts:169](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L169) |
| <a id="onsuccess-1"></a> `onSuccess?` | (`result`) => `void` | [recipe/webauthn/types.ts:173](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L173) |
| <a id="recipeimplementation-5"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:171](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L171) |
| <a id="resetfactorlist"></a> `resetFactorList?` | () => `void` | [recipe/webauthn/types.ts:174](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L174) |
| <a id="showbackbutton"></a> `showBackButton` | `boolean` | [recipe/webauthn/types.ts:175](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L175) |

***

### SignUpThemeBaseProps

```ts
type SignUpThemeBaseProps = object;
```

Defined in: [recipe/webauthn/types.ts:143](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L143)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clearerror-3"></a> `clearError` | () => `void` | [recipe/webauthn/types.ts:144](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L144) |
| <a id="config-4"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/webauthn/types.ts:147](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L147) |
| <a id="error-3"></a> `error` | `string` \| `undefined` | [recipe/webauthn/types.ts:151](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L151) |
| <a id="factorids"></a> `factorIds` | `string`[] | [recipe/webauthn/types.ts:146](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L146) |
| <a id="onerror-3"></a> `onError` | (`err`) => `void` | [recipe/webauthn/types.ts:150](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L150) |
| <a id="onfetcherror-1"></a> `onFetchError` | (`err`) => `void` | [recipe/webauthn/types.ts:149](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L149) |
| <a id="onsigninupswitcherclick"></a> `onSignInUpSwitcherClick` | () => `void` | [recipe/webauthn/types.ts:154](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L154) |
| <a id="onsuccess-2"></a> `onSuccess` | (`result`) => `void` | [recipe/webauthn/types.ts:148](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L148) |
| <a id="recipeimplementation-6"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:145](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L145) |
| <a id="resetfactorlist-1"></a> `resetFactorList` | () => `void` | [recipe/webauthn/types.ts:153](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L153) |
| <a id="showbackbutton-1"></a> `showBackButton` | `boolean` | [recipe/webauthn/types.ts:155](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L155) |
| <a id="usercontext-4"></a> `userContext` | [`UserContext`](types.mdx#usercontext-1) | [recipe/webauthn/types.ts:152](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L152) |

***

### SignUpThemeProps

```ts
type SignUpThemeProps = SignUpThemeBaseProps & object;
```

Defined in: [recipe/webauthn/types.ts:158](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L158)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `onRecoverAccountClick()` | () => `void` | [recipe/webauthn/types.ts:159](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L159) |

***

### UserInput

```ts
type UserInput = Record<string, unknown> & object & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
```

Defined in: [recipe/webauthn/types.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L96)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [recipe/webauthn/types.ts:97](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L97) |
| `override.functions()?` | (`originalImplementation`) => [`SuperTokensWrapper`](index.mdx#supertokenswrapper-1) | [recipe/webauthn/types.ts:98](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L98) |
| `recoveryFeature?` | [`NormalisedRecoveryFeatureConfig`](#normalisedrecoveryfeatureconfig) | [recipe/webauthn/types.ts:101](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L101) |
| `signInAndUpFeature?` | [`NormalisedSignInAndUpFormFeatureConfig`](#normalisedsigninandupformfeatureconfig) | [recipe/webauthn/types.ts:100](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L100) |

***

### WebAuthnMFAAction

```ts
type WebAuthnMFAAction = 
  | {
  accessDenied?: boolean;
  error: string | undefined;
  type: "setError";
}
  | {
  canRegisterPasskey: boolean;
  deviceSupported: boolean;
  email: string | undefined;
  error: string | undefined;
  hasRegisteredPassKey: boolean;
  showBackButton: boolean;
  type: "load";
};
```

Defined in: [recipe/webauthn/types.ts:267](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L267)

***

### WebAuthnMFAProps

```ts
type WebAuthnMFAProps = object;
```

Defined in: [recipe/webauthn/types.ts:307](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L307)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-5"></a> `config` | [`NormalisedConfig`](#normalisedconfig) | [recipe/webauthn/types.ts:309](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L309) |
| <a id="dispatch"></a> `dispatch` | `Dispatch`\<[`WebAuthnMFAAction`](#webauthnmfaaction)\> | [recipe/webauthn/types.ts:317](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L317) |
| <a id="featurestate"></a> `featureState` | [`WebAuthnMFAState`](#webauthnmfastate) | [recipe/webauthn/types.ts:316](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L316) |
| <a id="onbackbuttonclicked"></a> `onBackButtonClicked` | () => `void` | [recipe/webauthn/types.ts:310](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L310) |
| <a id="onrecoveraccountclick"></a> `onRecoverAccountClick` | () => `void` | [recipe/webauthn/types.ts:314](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L314) |
| <a id="onsignin"></a> `onSignIn` | () => `Promise`\<`void`\> | [recipe/webauthn/types.ts:312](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L312) |
| <a id="onsignoutclicked"></a> `onSignOutClicked` | () => `void` | [recipe/webauthn/types.ts:311](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L311) |
| <a id="onsignup"></a> `onSignUp` | (`email`) => `Promise`\<`void`\> | [recipe/webauthn/types.ts:313](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L313) |
| <a id="recipeimplementation-7"></a> `recipeImplementation` | [`RecipeImplementation`](#recipeimplementation-1) | [recipe/webauthn/types.ts:308](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L308) |
| <a id="usercontext-5"></a> `userContext?` | [`UserContext`](types.mdx#usercontext-1) | [recipe/webauthn/types.ts:315](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L315) |

***

### WebAuthnMFAState

```ts
type WebAuthnMFAState = WebAuthnMFAInitialState | WebAuthnMFALoadedState;
```

Defined in: [recipe/webauthn/types.ts:305](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/types.ts#L305)

# References - Frontend SDKs - React SDK Reference -  WebAuthn
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-auth-react/recipe-webauthn

## Classes

### default

Defined in: [recipe/webauthn/index.ts:28](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L28)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="componentsoverrideprovider"></a> `ComponentsOverrideProvider` | `static` | `any` | `RecipeComponentsOverrideContextProvider` | [recipe/webauthn/index.ts:526](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L526) |

#### Methods

##### authenticateCredential()

```ts
static authenticateCredential(input): Promise<
  | {
  authenticationResponse: AuthenticationResponseJSON;
  status: "OK";
}
  | {
  error: any;
  status: "FAILED_TO_AUTHENTICATE_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [recipe/webauthn/index.ts:275](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L275)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `authenticationOptions`: `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.authenticationOptions` | `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| \{
  `authenticationResponse`: `AuthenticationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_AUTHENTICATE_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

##### authenticateCredentialWithSignIn()

```ts
static authenticateCredentialWithSignIn(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:357](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L357)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### createAndRegisterCredentialForSessionUser()

```ts
static createAndRegisterCredentialForSessionUser(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:473](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L473)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `recipeUserId`: `string`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### createCredential()

```ts
static createCredential(input): Promise<
  | {
  registrationResponse: RegistrationResponseJSON;
  status: "OK";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [recipe/webauthn/index.ts:252](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L252)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `registrationOptions`: `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.registrationOptions` | `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| \{
  `registrationResponse`: `RegistrationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

##### doesBrowserSupportWebAuthn()

```ts
static doesBrowserSupportWebAuthn(input): Promise<
  | {
  browserSupportsWebauthn: boolean;
  platformAuthenticatorIsAvailable: boolean;
  status: "OK";
}
  | {
  error: any;
  status: "ERROR";
}>;
```

Defined in: [recipe/webauthn/index.ts:512](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L512)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: `any`; \} |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| \{
  `browserSupportsWebauthn`: `boolean`;
  `platformAuthenticatorIsAvailable`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"ERROR"`;
\}\>

##### generateRecoverAccountToken()

```ts
static generateRecoverAccountToken(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:194](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L194)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### getEmailExists()

```ts
static getEmailExists(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:183](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L183)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### getRegisterOptions()

```ts
static getRegisterOptions(input): Promise<
  | {
  attestation: "none" | "indirect" | "direct" | "enterprise";
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: string;
  excludeCredentials: object[];
  expiresAt: string;
  fetchResponse: Response;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  err: string;
  fetchResponse: Response;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}>;
```

Defined in: [recipe/webauthn/index.ts:33](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L33)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `email`: `string`; \} \| \{ `recoverAccountToken`: `string`; \} |

###### Returns

`Promise`\<
  \| \{
  `attestation`: `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"`;
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: `ResidentKey`;
     `userVerification`: `UserVerification`;
  \};
  `challenge`: `string`;
  `createdAt`: `string`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `string`;
  `fetchResponse`: `Response`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `err`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}\>

##### getSignInOptions()

```ts
static getSignInOptions(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:96](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L96)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### init()

```ts
static init(config?): any;
```

Defined in: [recipe/webauthn/index.ts:29](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L29)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-webauthn-types.mdx#userinput) |

###### Returns

`any`

##### listCredentials()

```ts
static listCredentials(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:449](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L449)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### recoverAccount()

```ts
static recoverAccount(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:213](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L213)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: `RecipeFunctionOptions`; `token`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.token` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<`any`\>

##### registerCredential()

```ts
static registerCredential(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:494](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L494)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: `RecipeFunctionOptions`; `recipeUserId`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<`any`\>

##### registerCredentialWithRecoverAccount()

```ts
static registerCredentialWithRecoverAccount(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:393](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L393)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `recoverAccountToken`: `string`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.recoverAccountToken` | `string` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### registerCredentialWithSignUp()

```ts
static registerCredentialWithSignUp(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:295](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L295)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<`any`\>

##### removeCredential()

```ts
static removeCredential(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:464](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L464)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: `any`; `webauthnCredentialId`: `string`; \} |
| `input.userContext` | `any` |
| `input.webauthnCredentialId` | `string` |

###### Returns

`Promise`\<`any`\>

##### signIn()

```ts
static signIn(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:157](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L157)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `AuthenticationResponseJSON`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `AuthenticationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<`any`\>

##### signUp()

```ts
static signUp(input): Promise<any>;
```

Defined in: [recipe/webauthn/index.ts:114](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L114)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<`any`\>

## Variables

### authenticateCredential()

```ts
const authenticateCredential: (input) => Promise<
  | {
  authenticationResponse: AuthenticationResponseJSON;
  status: "OK";
}
  | {
  error: any;
  status: "FAILED_TO_AUTHENTICATE_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = Wrapper.authenticateCredential;
```

Defined in: [recipe/webauthn/index.ts:538](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L538)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `authenticationOptions`: `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.authenticationOptions` | `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| \{
  `authenticationResponse`: `AuthenticationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_AUTHENTICATE_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

***

### authenticateCredentialWithSignIn()

```ts
const authenticateCredentialWithSignIn: (input) => Promise<any> = Wrapper.authenticateCredentialWithSignIn;
```

Defined in: [recipe/webauthn/index.ts:540](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L540)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### createAndRegisterCredentialForSessionUser()

```ts
const createAndRegisterCredentialForSessionUser: (input) => Promise<any> = Wrapper.createAndRegisterCredentialForSessionUser;
```

Defined in: [recipe/webauthn/index.ts:542](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L542)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `recipeUserId`: `string`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### createCredential()

```ts
const createCredential: (input) => Promise<
  | {
  registrationResponse: RegistrationResponseJSON;
  status: "OK";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = Wrapper.createCredential;
```

Defined in: [recipe/webauthn/index.ts:537](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L537)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `registrationOptions`: `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.registrationOptions` | `Omit`\<[`SuperTokensWrapper`](index.mdx#supertokenswrapper-1), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| \{
  `registrationResponse`: `RegistrationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

***

### doesBrowserSupportWebAuthn()

```ts
const doesBrowserSupportWebAuthn: (input) => Promise<
  | {
  browserSupportsWebauthn: boolean;
  platformAuthenticatorIsAvailable: boolean;
  status: "OK";
}
  | {
  error: any;
  status: "ERROR";
}> = Wrapper.doesBrowserSupportWebAuthn;
```

Defined in: [recipe/webauthn/index.ts:546](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L546)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: `any`; \} |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| \{
  `browserSupportsWebauthn`: `boolean`;
  `platformAuthenticatorIsAvailable`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"ERROR"`;
\}\>

***

### generateRecoverAccountToken()

```ts
const generateRecoverAccountToken: (input) => Promise<any> = Wrapper.generateRecoverAccountToken;
```

Defined in: [recipe/webauthn/index.ts:535](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L535)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### getEmailExists()

```ts
const getEmailExists: (input) => Promise<any> = Wrapper.getEmailExists;
```

Defined in: [recipe/webauthn/index.ts:534](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L534)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### getRegisterOptions()

```ts
const getRegisterOptions: (input) => Promise<
  | {
  attestation: "none" | "indirect" | "direct" | "enterprise";
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: string;
  excludeCredentials: object[];
  expiresAt: string;
  fetchResponse: Response;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  err: string;
  fetchResponse: Response;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}> = Wrapper.getRegisterOptions;
```

Defined in: [recipe/webauthn/index.ts:530](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L530)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `email`: `string`; \} \| \{ `recoverAccountToken`: `string`; \} |

#### Returns

`Promise`\<
  \| \{
  `attestation`: `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"`;
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: `ResidentKey`;
     `userVerification`: `UserVerification`;
  \};
  `challenge`: `string`;
  `createdAt`: `string`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `string`;
  `fetchResponse`: `Response`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `err`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}\>

***

### getSignInOptions()

```ts
const getSignInOptions: (input) => Promise<any> = Wrapper.getSignInOptions;
```

Defined in: [recipe/webauthn/index.ts:531](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L531)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### init()

```ts
const init: (config?) => any = Wrapper.init;
```

Defined in: [recipe/webauthn/index.ts:529](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L529)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-webauthn-types.mdx#userinput) |

#### Returns

`any`

***

### listCredentials()

```ts
const listCredentials: (input) => Promise<any> = Wrapper.listCredentials;
```

Defined in: [recipe/webauthn/index.ts:543](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L543)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### recoverAccount()

```ts
const recoverAccount: (input) => Promise<any> = Wrapper.recoverAccount;
```

Defined in: [recipe/webauthn/index.ts:536](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L536)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: `RecipeFunctionOptions`; `token`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.token` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<`any`\>

***

### registerCredential()

```ts
const registerCredential: (input) => Promise<any> = Wrapper.registerCredential;
```

Defined in: [recipe/webauthn/index.ts:545](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L545)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: `RecipeFunctionOptions`; `recipeUserId`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<`any`\>

***

### registerCredentialWithRecoverAccount()

```ts
const registerCredentialWithRecoverAccount: (input) => Promise<any> = Wrapper.registerCredentialWithRecoverAccount;
```

Defined in: [recipe/webauthn/index.ts:541](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L541)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: `RecipeFunctionOptions`; `recoverAccountToken`: `string`; `userContext`: `any`; \} |
| `input.options?` | `RecipeFunctionOptions` |
| `input.recoverAccountToken` | `string` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### registerCredentialWithSignUp()

```ts
const registerCredentialWithSignUp: (input) => Promise<any> = Wrapper.registerCredentialWithSignUp;
```

Defined in: [recipe/webauthn/index.ts:539](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L539)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<`any`\>

***

### removeCredential()

```ts
const removeCredential: (input) => Promise<any> = Wrapper.removeCredential;
```

Defined in: [recipe/webauthn/index.ts:544](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L544)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: `any`; `webauthnCredentialId`: `string`; \} |
| `input.userContext` | `any` |
| `input.webauthnCredentialId` | `string` |

#### Returns

`Promise`\<`any`\>

***

### signIn()

```ts
const signIn: (input) => Promise<any> = Wrapper.signIn;
```

Defined in: [recipe/webauthn/index.ts:533](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L533)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `AuthenticationResponseJSON`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `AuthenticationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<`any`\>

***

### signUp()

```ts
const signUp: (input) => Promise<any> = Wrapper.signUp;
```

Defined in: [recipe/webauthn/index.ts:532](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L532)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: `RecipeFunctionOptions`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | `RecipeFunctionOptions` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<`any`\>

***

### WebauthnComponentsOverrideProvider

```ts
const WebauthnComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;
```

Defined in: [recipe/webauthn/index.ts:547](https://github.com/supertokens/supertokens-auth-react/blob/b337b23722adfbe2906b193ea5fcf98f9c98c8b0/lib/ts/recipe/webauthn/index.ts#L547)

# References - Frontend SDKs - Javascript SDK Reference -  SuperTokens Web JS
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/package

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/index.ts:20](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/index.ts#L20)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### init()

```ts
static init(config): void;
```

Defined in: [tmp/supertokens-web-js/lib/ts/index.ts:21](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/index.ts#L21)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensConfig`](types.mdx#supertokensconfig) |

###### Returns

`void`

## Variables

### init()

```ts
const init: (config) => void = SuperTokensAPIWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/index.ts:26](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/index.ts#L26)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`SuperTokensConfig`](types.mdx#supertokensconfig) |

#### Returns

`void`

## References

### SuperTokensConfig

Re-exports [SuperTokensConfig](types.mdx#supertokensconfig)

***

### SuperTokensPlugin

Re-exports [SuperTokensPlugin](types.mdx#supertokensplugin)

***

### SuperTokensPublicConfig

Re-exports [SuperTokensPublicConfig](types.mdx#supertokenspublicconfig)

***

### SuperTokensPublicPlugin

Re-exports [SuperTokensPublicPlugin](types.mdx#supertokenspublicplugin)

# References - Frontend SDKs - Javascript SDK Reference -  SuperTokens Web JS Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/types

## Type Aliases

### AllRecipeConfigs

```ts
type AllRecipeConfigs = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:207](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L207)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailpassword"></a> `emailpassword` | [`UserInput`](recipe-emailpassword-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:208](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L208) |
| <a id="emailverification"></a> `emailverification` | [`UserInput`](recipe-emailverification-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:209](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L209) |
| <a id="multifactorauth"></a> `multifactorauth` | [`UserInput`](recipe-multifactorauth-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:210](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L210) |
| <a id="multitenancy"></a> `multitenancy` | [`UserInput`](recipe-multitenancy-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:211](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L211) |
| <a id="oauth2provider"></a> `oauth2provider` | [`UserInput`](recipe-oauth2provider-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:212](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L212) |
| <a id="passwordless"></a> `passwordless` | [`UserInput`](recipe-passwordless-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:213](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L213) |
| <a id="session"></a> `session` | [`UserInput`](recipe-session-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:214](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L214) |
| <a id="thirdparty"></a> `thirdparty` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:215](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L215) |
| <a id="totp"></a> `totp` | [`UserInput`](recipe-totp-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:216](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L216) |
| <a id="webauthn"></a> `webauthn` | [`UserInput`](recipe-webauthn-types.mdx#userinput) | [tmp/supertokens-web-js/lib/ts/types.ts:217](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L217) |

***

### AppInfoUserInput

```ts
type AppInfoUserInput = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L113)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="apibasepath"></a> `apiBasePath?` | `string` | The path at which the SuperTokens APIs are exposed by your backend. Defaults to `/auth`. This value must match the one set in the backend SDKs for SuperTokens to work correctly | [tmp/supertokens-web-js/lib/ts/types.ts:134](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L134) |
| <a id="apidomain"></a> `apiDomain` | `string` | The domain at which you host your backend SDKs. This is used by the SDK when making network requests. For example if your API server is running on http://localhost:8080 then when calling SuperTokens.init the value for `apiDomain` should be set to `http://localhost:8080` This value must match the one set in the backend SDKs for SuperTokens to work correctly | [tmp/supertokens-web-js/lib/ts/types.ts:127](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L127) |
| <a id="apigatewaypath"></a> `apiGatewayPath?` | `string` | An API gateway may be used which prepends a path to the API route. That path should be specified here. | [tmp/supertokens-web-js/lib/ts/types.ts:140](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L140) |
| <a id="appname"></a> `appName` | `string` | The name of your application | [tmp/supertokens-web-js/lib/ts/types.ts:117](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L117) |

***

### CreateRecipeFunction()\<Action\>

```ts
type CreateRecipeFunction<Action> = (appInfo, clientType, enableDebugLogs, overrideMaps) => RecipeModule<Action, NormalisedRecipeConfig<Action>>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:106](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L106)

#### Type Parameters

| Type Parameter |
| ------ |
| `Action` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) |
| `clientType` | `string` \| `undefined` |
| `enableDebugLogs` | `boolean` |
| `overrideMaps` | `NonNullable`\<[`SuperTokensPlugin`](#supertokensplugin)\[`"overrideMap"`\]\>[] |

#### Returns

`RecipeModule`\<`Action`, `NormalisedRecipeConfig`\<`Action`\>\>

***

### GeneralErrorResponse

```ts
type GeneralErrorResponse = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:201](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L201)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="fetchresponse"></a> `fetchResponse` | `Response` | [tmp/supertokens-web-js/lib/ts/types.ts:204](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L204) |
| <a id="message"></a> `message` | `string` | [tmp/supertokens-web-js/lib/ts/types.ts:203](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L203) |
| <a id="status"></a> `status` | `"GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/types.ts:202](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L202) |

***

### NonPublicConfigPropertiesType

```ts
type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:246](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L246)

***

### NormalisedAppInfo

```ts
type NormalisedAppInfo = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:146](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L146)

Normalised version of the config passed to SuperTokens.init

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="apibasepath-1"></a> `apiBasePath` | `NormalisedURLPath` | The path at which the SuperTokens APIs are exposed by your backend. Defaults to `/auth`. This value must match the one set in the backend SDKs for SuperTokens to work correctly | [tmp/supertokens-web-js/lib/ts/types.ts:167](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L167) |
| <a id="apidomain-1"></a> `apiDomain` | `NormalisedURLDomain` | The domain at which you host your backend SDKs. This is used by the SDK when making network requests. For example if your API server is running on http://localhost:8080 then when calling SuperTokens.init the value for `apiDomain` should be set to `http://localhost:8080` This value must match the one set in the backend SDKs for SuperTokens to work correctly | [tmp/supertokens-web-js/lib/ts/types.ts:160](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L160) |
| <a id="appname-1"></a> `appName` | `string` | The name of your application | [tmp/supertokens-web-js/lib/ts/types.ts:150](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L150) |

***

### RecipePluginOverride\<T\>

```ts
type RecipePluginOverride<T> = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:220](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L220)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`AllRecipeConfigs`](#allrecipeconfigs) |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config?` | (`config`) => [`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\] | [tmp/supertokens-web-js/lib/ts/types.ts:222](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L222) |
| <a id="functions"></a> `functions?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"functions"`\] | [tmp/supertokens-web-js/lib/ts/types.ts:221](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L221) |

***

### SuperTokensConfig

```ts
type SuperTokensConfig = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:35](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L35)

The configuration object to be passed when calling SuperTokens.init

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`AppInfoUserInput`](#appinfouserinput) | The information specific to your application, this helps the SDK understand how SuperTokens is setup in your system | [tmp/supertokens-web-js/lib/ts/types.ts:40](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L40) |
| <a id="clienttype"></a> `clientType?` | `string` | Identifier for the client, such as `web`, `ios`, etc. to be used with thirdparty, multitenancy recipes. | [tmp/supertokens-web-js/lib/ts/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L45) |
| <a id="cookiehandler"></a> `cookieHandler?` | `CookieHandlerInput` | Custom handlers that the SDK should use when trying to read or write to document.cookie In most cases you should not need to provide these. When provided, the SDK will rely on these functions instead of using document.cookie directly When using this feature, take extra care to use the correct function version (async/async). The interface by default uses async versions of the functions when possible but specific parts of the SDK may rely on using the sync versions instead. | [tmp/supertokens-web-js/lib/ts/types.ts:63](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L63) |
| <a id="dateprovider"></a> `dateProvider?` | `DateProviderInput` | Custom provider for SDK timing calculations relative to server time. The default implementation automatically adjusts for client-server time deviation. Typically, you won't need to provide these. If provided, the SDK uses your implementation instead of the default one. | [tmp/supertokens-web-js/lib/ts/types.ts:85](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L85) |
| <a id="enabledebuglogs"></a> `enableDebugLogs?` | `boolean` | Enabled logging for the SuperTokens SDK. The SDK will log information in different stages. | [tmp/supertokens-web-js/lib/ts/types.ts:90](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L90) |
| <a id="experimental"></a> `experimental?` | `object` | Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord | [tmp/supertokens-web-js/lib/ts/types.ts:101](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L101) |
| `experimental.plugins?` | [`SuperTokensPlugin`](#supertokensplugin)[] | - | [tmp/supertokens-web-js/lib/ts/types.ts:102](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L102) |
| <a id="recipelist"></a> `recipeList` | [`CreateRecipeFunction`](#createrecipefunction)\<`any`\>[] | List of recipes that you want to use. Refer to the documentation for the recipe that you want to use to know how this property should be set. | [tmp/supertokens-web-js/lib/ts/types.ts:51](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L51) |
| <a id="windowhandler"></a> `windowHandler?` | `WindowHandlerInput` | Custom handlers that the SDK should use when trying to access Window APIs In most cases you should not need to provide these. When provided, the SDK will rely on these functions instead of using any Window APIs directly When using this feature, take extra care to use the correct function version (async/async). The interface by default uses async versions of the functions when possible but specific parts of the SDK may rely on using the sync versions instead. | [tmp/supertokens-web-js/lib/ts/types.ts:75](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L75) |

***

### SuperTokensConfigWithNormalisedAppInfo

```ts
type SuperTokensConfigWithNormalisedAppInfo = Omit<SuperTokensConfig, "appInfo"> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:253](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L253)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [tmp/supertokens-web-js/lib/ts/types.ts:254](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L254) |

***

### SuperTokensPlugin

```ts
type SuperTokensPlugin = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:225](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L225)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="compatiblewebjssdkversions"></a> `compatibleWebJSSDKVersions?` | `string` \| `string`[] | [tmp/supertokens-web-js/lib/ts/types.ts:228](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L228) |
| <a id="config-1"></a> `config?` | (`config`) => \| `Omit`\<[`SuperTokensPublicConfig`](#supertokenspublicconfig), `"appInfo"`\> \| `undefined` | [tmp/supertokens-web-js/lib/ts/types.ts:241](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L241) |
| <a id="dependencies"></a> `dependencies?` | (`config`, `pluginsAbove`, `sdkVersion`) => \| \{ `pluginsToAdd?`: [`SuperTokensPlugin`](#supertokensplugin)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} | [tmp/supertokens-web-js/lib/ts/types.ts:229](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L229) |
| <a id="exports"></a> `exports?` | `Record`\<`string`, `any`\> | [tmp/supertokens-web-js/lib/ts/types.ts:240](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L240) |
| <a id="id"></a> `id` | `string` | [tmp/supertokens-web-js/lib/ts/types.ts:226](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L226) |
| <a id="init"></a> `init?` | (`config`, `plugins`, `sdkVersion`) => `void` | [tmp/supertokens-web-js/lib/ts/types.ts:239](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L239) |
| <a id="overridemap"></a> `overrideMap?` | \{ \[recipeId in keyof AllRecipeConfigs\]?: RecipePluginOverride\<recipeId\> & \{ recipeInitRequired?: boolean \| ((sdkVersion: string) =\> boolean) \} \} | [tmp/supertokens-web-js/lib/ts/types.ts:234](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L234) |
| <a id="version"></a> `version?` | `string` | [tmp/supertokens-web-js/lib/ts/types.ts:227](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L227) |

***

### SuperTokensPublicConfig

```ts
type SuperTokensPublicConfig = Omit<Omit<SuperTokensConfig, NonPublicConfigPropertiesType>, "appInfo"> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:257](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L257)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](#normalisedappinfo) | [tmp/supertokens-web-js/lib/ts/types.ts:258](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L258) |

***

### SuperTokensPublicPlugin

```ts
type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, "id" | "version" | "exports" | "compatibleWebJSSDKVersions"> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:248](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L248)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `initialized` | `boolean` | [tmp/supertokens-web-js/lib/ts/types.ts:251](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L251) |

***

### User

```ts
type User = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:170](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L170)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emails"></a> `emails` | `string`[] | [tmp/supertokens-web-js/lib/ts/types.ts:175](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L175) |
| <a id="id-1"></a> `id` | `string` | [tmp/supertokens-web-js/lib/ts/types.ts:171](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L171) |
| <a id="isprimaryuser"></a> `isPrimaryUser` | `boolean` | [tmp/supertokens-web-js/lib/ts/types.ts:173](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L173) |
| <a id="loginmethods"></a> `loginMethods` | `object`[] | [tmp/supertokens-web-js/lib/ts/types.ts:184](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L184) |
| <a id="phonenumbers"></a> `phoneNumbers` | `string`[] | [tmp/supertokens-web-js/lib/ts/types.ts:176](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L176) |
| <a id="tenantids"></a> `tenantIds` | `string`[] | [tmp/supertokens-web-js/lib/ts/types.ts:174](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L174) |
| <a id="thirdparty-1"></a> `thirdParty` | `object`[] | [tmp/supertokens-web-js/lib/ts/types.ts:177](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L177) |
| <a id="timejoined"></a> `timeJoined` | `number` | [tmp/supertokens-web-js/lib/ts/types.ts:172](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L172) |
| <a id="webauthn-1"></a> `webauthn?` | `object` | [tmp/supertokens-web-js/lib/ts/types.ts:181](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L181) |
| `webauthn.credentialIds` | `string`[] | [tmp/supertokens-web-js/lib/ts/types.ts:182](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L182) |

## Variables

### nonPublicConfigProperties

```ts
const nonPublicConfigProperties: readonly ["experimental"];
```

Defined in: [tmp/supertokens-web-js/lib/ts/types.ts:244](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/types.ts#L244)

# References - Frontend SDKs - Javascript SDK Reference -  EmailPassword Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-emailpassword-types

## Type Aliases

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:51](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L51)

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:53](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L53)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:54](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L54) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:55](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L55) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:37](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L37)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "EMAIL_PASSWORD_SIGN_UP"
  | "EMAIL_PASSWORD_SIGN_IN"
  | "SEND_RESET_PASSWORD_EMAIL"
  | "SUBMIT_NEW_PASSWORD"
  | "EMAIL_EXISTS";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L29)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:36](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L36)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:62](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L62)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="doesemailexist"></a> `doesEmailExist` | (`input`) => `Promise`\<\{ `doesExist`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; \}\> | Check if an email exists **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:259](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L259) |
| <a id="getresetpasswordtokenfromurl"></a> `getResetPasswordTokenFromURL` | (`input`) => `string` | Reads and returns the reset password token from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:272](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L272) |
| <a id="gettenantidfromurl"></a> `getTenantIdFromURL` | (`input`) => `string` \| `undefined` | Reads and returns the tenant id from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:281](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L281) |
| <a id="sendpasswordresetemail"></a> `sendPasswordResetEmail` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"PASSWORD_RESET_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `formFields`: `object`[]; `status`: `"FIELD_ERROR"`; \}\> | Send an email to the user for password reset **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:121](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L121) |
| <a id="signin"></a> `signIn` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `fetchResponse`: `Response`; `formFields`: `object`[]; `status`: `"FIELD_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"WRONG_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_NOT_ALLOWED"`; \}\> | Sign in a user with email and password **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:213](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L213) |
| <a id="signup"></a> `signUp` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `fetchResponse`: `Response`; `formFields`: `object`[]; `status`: `"FIELD_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_UP_NOT_ALLOWED"`; \}\> | Sign up a user with email and password **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:165](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L165) |
| <a id="submitnewpassword"></a> `submitNewPassword` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `formFields`: `object`[]; `status`: `"FIELD_ERROR"`; \}\> | Submit a new password for the user **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:80](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L80) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:39](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L39)

#### Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `override?` | `object` | Refer to [the documentation](https://supertokens.com/docs/emailpassword/advanced-customizations/frontend-functions-override/about) | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L43) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | - | [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/types.ts:44](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/types.ts#L44) |

# References - Frontend SDKs - Javascript SDK Reference -  EmailPassword
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-emailpassword

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:21](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L21)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### doesEmailExist()

```ts
static doesEmailExist(input): Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:254](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L254)

Check if an email exists

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{status: "OK", doesExist: boolean}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### getResetPasswordTokenFromURL()

```ts
static getResetPasswordTokenFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:272](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L272)

Reads and returns the reset password token from the current URL

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

The "token" query parameter from the current location

##### getTenantIdFromURL()

```ts
static getTenantIdFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:286](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L286)

Reads and returns the tenant id from the current URL

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

The "tenantId" query parameter from the current location

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L22)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailpassword-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-emailpassword-types.mdx#preandpostapihookaction)\>

##### sendPasswordResetEmail()

```ts
static sendPasswordResetEmail(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "PASSWORD_RESET_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:95](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L95)

Send an email to the user for password reset

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"PASSWORD_RESET_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

`{status: "OK"}` if successfull

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### signIn()

```ts
static signIn(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:202](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L202)

Sign in a user with email and password

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}\>

`{status: "OK"}` if successfull

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:26](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L26)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

##### signUp()

```ts
static signUp(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:146](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L146)

Sign up a user with email and password

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}\>

`{status: "OK"}` if successfull

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### submitNewPassword()

```ts
static submitNewPassword(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L49)

Submit a new password for the user

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

`{status: "OK"}` if successfull

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## Type Aliases

### RecipeFunctionOptions

```ts
type RecipeFunctionOptions = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/recipeModule/types.ts:120](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/recipeModule/types.ts#L120)

For the options object passed to recipe functions, we do not need a postAPIHook.

This is because these functions will be called manually, so the user always knows which API is called (making the
postAPIHook redundant). They can consume the networkResponse returned by recipe functions as a way to handle post
API logic

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="preapihook"></a> `preAPIHook?` | (`input`) => `Promise`\<\{ `requestInit`: `RequestInit`; `url`: `string`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/recipeModule/types.ts:121](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/recipeModule/types.ts#L121) |

## Variables

### doesEmailExist()

```ts
const doesEmailExist: (input) => Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = RecipeWrapper.doesEmailExist;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:299](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L299)

Check if an email exists

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{status: "OK", doesExist: boolean}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### getResetPasswordTokenFromURL()

```ts
const getResetPasswordTokenFromURL: (input?) => string = RecipeWrapper.getResetPasswordTokenFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:301](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L301)

Reads and returns the reset password token from the current URL

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

The "token" query parameter from the current location

***

### getTenantIdFromURL()

```ts
const getTenantIdFromURL: (input?) => string = RecipeWrapper.getTenantIdFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:302](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L302)

Reads and returns the tenant id from the current URL

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

The "tenantId" query parameter from the current location

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:294](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L294)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailpassword-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-emailpassword-types.mdx#preandpostapihookaction)\>

***

### sendPasswordResetEmail()

```ts
const sendPasswordResetEmail: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "PASSWORD_RESET_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}> = RecipeWrapper.sendPasswordResetEmail;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:296](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L296)

Send an email to the user for password reset

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"PASSWORD_RESET_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

`{status: "OK"}` if successfull

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### signIn()

```ts
const signIn: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}> = RecipeWrapper.signIn;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:298](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L298)

Sign in a user with email and password

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}\>

`{status: "OK"}` if successfull

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = RecipeWrapper.signOut;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:300](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L300)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

***

### signUp()

```ts
const signUp: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}> = RecipeWrapper.signUp;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:297](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L297)

Sign up a user with email and password

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}\>

`{status: "OK"}` if successfull

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### submitNewPassword()

```ts
const submitNewPassword: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}
  | {
  fetchResponse: Response;
  formFields: object[];
  status: "FIELD_ERROR";
}> = RecipeWrapper.submitNewPassword;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailpassword/index.ts:295](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailpassword/index.ts#L295)

Submit a new password for the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `formFields`: `object`[]; `options?`: [`RecipeFunctionOptions`](#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.formFields` | `object`[] |
| `input.options?` | [`RecipeFunctionOptions`](#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `formFields`: `object`[];
  `status`: `"FIELD_ERROR"`;
\}\>

`{status: "OK"}` if successfull

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## References

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-emailpassword-types.mdx#postapihookcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-emailpassword-types.mdx#preapihookcontext)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-emailpassword-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-emailpassword-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  EmailVerification Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-emailverification-types

## Type Aliases

### InputType

```ts
type InputType = RecipeConfig<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L43)

***

### InputTypeOverride

```ts
type InputTypeOverride = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="functions"></a> `functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L30) |

***

### NormalisedInputType

```ts
type NormalisedInputType = NormalisedRecipeConfig<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L45)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L46) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:47](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L47) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L27)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "VERIFY_EMAIL" | "SEND_VERIFY_EMAIL" | "IS_EMAIL_VERIFIED";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:24](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L24)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:26](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L26)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:54](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L54)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="getemailverificationtokenfromurl"></a> `getEmailVerificationTokenFromURL` | (`input`) => `string` | Reads and returns the email verification token from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L113) |
| <a id="gettenantidfromurl"></a> `getTenantIdFromURL` | (`input`) => `string` \| `undefined` | Reads and returns the tenant id from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:122](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L122) |
| <a id="isemailverified"></a> `isEmailVerified` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `isVerified`: `boolean`; `status`: `"OK"`; \}\> | Check if an email has been verified **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:100](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L100) |
| <a id="sendverificationemail"></a> `sendVerificationEmail` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"` \| `"OK"`; \}\> | Send an email to the user for verification. **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:84](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L84) |
| <a id="verifyemail"></a> `verifyEmail` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `status`: `"OK"` \| `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`; \}\> | Verify an email **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:67](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L67) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:36](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L36)

#### Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `override?` | [`InputTypeOverride`](#inputtypeoverride) | Refer to [the documentation](https://supertokens.com/docs/emailpassword/advanced-customizations/frontend-functions-override/about) | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/types.ts:40](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/types.ts#L40) |

# References - Frontend SDKs - Javascript SDK Reference -  EmailVerification
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-emailverification

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:21](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L21)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="emailverificationclaim"></a> `EmailVerificationClaim` | `static` | [`EmailVerificationClaimClass`](#emailverificationclaimclass) | `Recipe.EmailVerificationClaim` | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L22) |

#### Methods

##### getEmailVerificationTokenFromURL()

```ts
static getEmailVerificationTokenFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:94](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L94)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

##### getTenantIdFromURL()

```ts
static getTenantIdFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:108](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L108)

Reads and returns the tenant id from the current URL

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

The "tenantId" query parameter from the current location

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:24](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L24)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailverification-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-emailverification-types.mdx#preandpostapihookaction)\>

##### isEmailVerified()

```ts
static isEmailVerified(input?): Promise<{
  fetchResponse: Response;
  isVerified: boolean;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:83](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L83)

Check if an email has been verified

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `isVerified`: `boolean`;
  `status`: `"OK"`;
\}\>

`{status: "OK", isVerified: boolean}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### sendVerificationEmail()

```ts
static sendVerificationEmail(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:62](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L62)

Send an email to the user for verification.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

`{status: "OK"}` if successfull

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### verifyEmail()

```ts
static verifyEmail(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:40](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L40)

Verify an email

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

`{status: "OK"}` if successfull

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### EmailVerificationClaimClass

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/emailVerificationClaim.ts:13](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/emailVerificationClaim.ts#L13)

We include "Class" in the class name, because it makes it easier to import/use the right thing (the instance exported by the recipe) instead of this.

#### Extends

- [`BooleanClaim`](recipe-session.mdx#booleanclaim)

#### Constructors

##### Constructor

```ts
new EmailVerificationClaimClass(getRecipeImpl): EmailVerificationClaimClass;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/emailVerificationClaim.ts:14](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/emailVerificationClaim.ts#L14)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `getRecipeImpl` | () => [`RecipeInterface`](recipe-emailverification-types.mdx#recipeinterface) |

###### Returns

[`EmailVerificationClaimClass`](#emailverificationclaimclass)

###### Overrides

[`BooleanClaim`](recipe-session.mdx#booleanclaim).[`constructor`](recipe-session.mdx#constructor)

#### Properties

| Property | Modifier | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | - | [`PrimitiveClaim`](recipe-session.mdx#primitiveclaim).[`defaultMaxAgeInSeconds`](recipe-session.mdx#defaultmaxageinseconds-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:10 |
| <a id="id"></a> `id` | `readonly` | `string` | - | [`PrimitiveClaim`](recipe-session.mdx#primitiveclaim).[`id`](recipe-session.mdx#id-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:8 |
| <a id="refresh"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | - | [`BooleanClaim`](recipe-session.mdx#booleanclaim).[`refresh`](recipe-session.mdx#refresh) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:9 |
| <a id="validators"></a> `validators` | `public` | `object` & `BooleanValidators` & `object` | [`BooleanClaim`](recipe-session.mdx#booleanclaim).[`validators`](recipe-session.mdx#validators) | - | [tmp/supertokens-web-js/lib/ts/recipe/emailverification/emailVerificationClaim.ts:82](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/emailVerificationClaim.ts#L82) |

#### Methods

##### getLastFetchedTime()

```ts
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

###### Inherited from

[`BooleanClaim`](recipe-session.mdx#booleanclaim).[`getLastFetchedTime`](recipe-session.mdx#getlastfetchedtime)

##### getValueFromPayload()

```ts
getValueFromPayload(payload, _userContext?): boolean;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`boolean`

###### Inherited from

[`BooleanClaim`](recipe-session.mdx#booleanclaim).[`getValueFromPayload`](recipe-session.mdx#getvaluefrompayload)

## Variables

### EmailVerificationClaim

```ts
const EmailVerificationClaim: EmailVerificationClaimClass = RecipeWrapper.EmailVerificationClaim;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:122](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L122)

***

### getEmailVerificationTokenFromURL()

```ts
const getEmailVerificationTokenFromURL: (input?) => string = RecipeWrapper.getEmailVerificationTokenFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:120](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L120)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

***

### getTenantIdFromURL()

```ts
const getTenantIdFromURL: (input?) => string = RecipeWrapper.getTenantIdFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:121](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L121)

Reads and returns the tenant id from the current URL

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

The "tenantId" query parameter from the current location

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:116](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L116)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-emailverification-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-emailverification-types.mdx#preandpostapihookaction)\>

***

### isEmailVerified()

```ts
const isEmailVerified: (input?) => Promise<{
  fetchResponse: Response;
  isVerified: boolean;
  status: "OK";
}> = RecipeWrapper.isEmailVerified;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:119](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L119)

Check if an email has been verified

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `isVerified`: `boolean`;
  `status`: `"OK"`;
\}\>

`{status: "OK", isVerified: boolean}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### sendVerificationEmail()

```ts
const sendVerificationEmail: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR";
}> = RecipeWrapper.sendVerificationEmail;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:118](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L118)

Send an email to the user for verification.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

`{status: "OK"}` if successfull

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### verifyEmail()

```ts
const verifyEmail: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}> = RecipeWrapper.verifyEmail;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/emailverification/index.ts:117](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/emailverification/index.ts#L117)

Verify an email

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

`{status: "OK"}` if successfull

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## References

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-emailverification-types.mdx#postapihookcontext)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-emailverification-types.mdx#preapihookcontext)

***

### RecipeFunctionOptions

Re-exports [RecipeFunctionOptions](recipe-emailpassword.mdx#recipefunctionoptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-emailverification-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-emailverification-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  MFA Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-multifactorauth-types

## Type Aliases

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:41](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L41)

***

### MFAClaimValue

```ts
type MFAClaimValue = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:80](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L80)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="c"></a> `c` | `Record`\<`string`, `number` \| `undefined`\> | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:81](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L81) |
| <a id="v"></a> `v` | `boolean` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:82](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L82) |

***

### MFAFactorInfo

```ts
type MFAFactorInfo = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:52](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L52)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="allowedtosetup"></a> `allowedToSetup` | `string`[] | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:54](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L54) |
| <a id="alreadysetup"></a> `alreadySetup` | `string`[] | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:53](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L53) |
| <a id="next"></a> `next` | `string`[] | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:55](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L55) |

***

### MFARequirement

```ts
type MFARequirement = string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:68](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L68)

***

### MFARequirementList

```ts
type MFARequirementList = (
  | {
  oneOf: MFARequirement[];
}
  | {
  allOfInAnyOrder: MFARequirement[];
}
  | MFARequirement)[];
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:70](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L70)

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L43)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:44](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L44) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L45) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L30)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "GET_MFA_INFO";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L27)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L29)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:58](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L58)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="resyncsessionandfetchmfainfo"></a> `resyncSessionAndFetchMFAInfo` | (`input`) => `Promise`\<\{ `emails`: `Record`\<`string`, `string`[] \| `undefined`\>; `factors`: [`MFAFactorInfo`](#mfafactorinfo); `fetchResponse`: `Response`; `phoneNumbers`: `Record`\<`string`, `string`[] \| `undefined`\>; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L59) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:32](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L32)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L33) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts:34](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/types.ts#L34) |

# References - Frontend SDKs - Javascript SDK Reference -  MFA
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-multifactorauth

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L22)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="multifactorauthclaim"></a> `MultiFactorAuthClaim` | `static` | [`MultiFactorAuthClaimClass`](#multifactorauthclaimclass) | `Recipe.MultiFactorAuthClaim` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L43) |

#### Methods

##### init()

```ts
static init(config?): CreateRecipeFunction<"GET_MFA_INFO">;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:23](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L23)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multifactorauth-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<`"GET_MFA_INFO"`\>

##### resyncSessionAndFetchMFAInfo()

```ts
static resyncSessionAndFetchMFAInfo(input?): Promise<{
  emails: Record<string, string[] | undefined>;
  factors: MFAFactorInfo;
  fetchResponse: Response;
  phoneNumbers: Record<string, string[] | undefined>;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:36](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L36)

Loads information about what factors the current session can set up/complete and updates the requirements in the session payload

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `emails`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `factors`: [`MFAFactorInfo`](recipe-multifactorauth-types.mdx#mfafactorinfo);
  `fetchResponse`: `Response`;
  `phoneNumbers`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful

***

### MultiFactorAuthClaimClass

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:8](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L8)

We include "Class" in the class name, because it makes it easier to import/use the right thing (the instance exported by the recipe) instead of this.

#### Implements

- [`SessionClaim`](recipe-session.mdx#sessionclaim)\<[`MFAClaimValue`](recipe-multifactorauth-types.mdx#mfaclaimvalue)\>

#### Constructors

##### Constructor

```ts
new MultiFactorAuthClaimClass(getRecipeImpl): MultiFactorAuthClaimClass;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:15](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L15)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `getRecipeImpl` | () => [`RecipeInterface`](recipe-multifactorauth-types.mdx#recipeinterface) |

###### Returns

[`MultiFactorAuthClaimClass`](#multifactorauthclaimclass)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="getrecipeimpl"></a> `getRecipeImpl` | `protected` | () => [`RecipeInterface`](recipe-multifactorauth-types.mdx#recipeinterface) | `undefined` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:15](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L15) |
| <a id="id"></a> `id` | `public` | `string` | `"st-mfa"` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:9](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L9) |
| <a id="validators"></a> `validators` | `public` | `object` | `undefined` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:10](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L10) |
| `validators.hasCompletedFactors` | `public` | (`requirements`) => [`SessionClaimValidator`](recipe-session.mdx#sessionclaimvalidator) | `undefined` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:12](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L12) |
| `validators.hasCompletedMFARequirementsForAuth` | `public` | () => [`SessionClaimValidator`](recipe-session.mdx#sessionclaimvalidator) | `undefined` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:11](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L11) |

#### Methods

##### getLastFetchedTime()

```ts
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:138](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L138)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

###### Implementation of

[`SessionClaim`](recipe-session.mdx#sessionclaim).[`getLastFetchedTime`](recipe-session.mdx#getlastfetchedtime-6)

##### getValueFromPayload()

```ts
getValueFromPayload(payload, _userContext?): object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:124](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L124)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`object`

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `c` | `Record`\<`string`, `number` \| `undefined`\> | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:127](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L127) |
| `v` | `boolean` | [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:127](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L127) |

###### Implementation of

[`SessionClaim`](recipe-session.mdx#sessionclaim).[`getValueFromPayload`](recipe-session.mdx#getvaluefrompayload-6)

##### refresh()

```ts
refresh(userContext): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:120](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L120)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | `any` |

###### Returns

`Promise`\<`void`\>

###### Implementation of

[`SessionClaim`](recipe-session.mdx#sessionclaim).[`refresh`](recipe-session.mdx#refresh-5)

## Variables

### init()

```ts
const init: (config?) => CreateRecipeFunction<"GET_MFA_INFO"> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L46)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multifactorauth-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<`"GET_MFA_INFO"`\>

***

### MultiFactorAuthClaim

```ts
const MultiFactorAuthClaim: MultiFactorAuthClaimClass = RecipeWrapper.MultiFactorAuthClaim;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L48)

***

### resyncSessionAndFetchMFAInfo()

```ts
const resyncSessionAndFetchMFAInfo: (input?) => Promise<{
  emails: Record<string, string[] | undefined>;
  factors: MFAFactorInfo;
  fetchResponse: Response;
  phoneNumbers: Record<string, string[] | undefined>;
  status: "OK";
}> = RecipeWrapper.resyncSessionAndFetchMFAInfo;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/index.ts:47](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multifactorauth/index.ts#L47)

Loads information about what factors the current session can set up/complete and updates the requirements in the session payload

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `emails`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `factors`: [`MFAFactorInfo`](recipe-multifactorauth-types.mdx#mfafactorinfo);
  `fetchResponse`: `Response`;
  `phoneNumbers`: `Record`\<`string`, `string`[] \| `undefined`\>;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful

## References

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-multifactorauth-types.mdx#postapihookcontext)

***

### PreAndPostAPIHookAction

Re-exports [PreAndPostAPIHookAction](recipe-multifactorauth-types.mdx#preandpostapihookaction)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-multifactorauth-types.mdx#preapihookcontext)

***

### RecipeFunctionOptions

Re-exports [RecipeFunctionOptions](recipe-emailpassword.mdx#recipefunctionoptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-multifactorauth-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-multifactorauth-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  MultiTenancy Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-multitenancy-types

## Type Aliases

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:41](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L41)

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L43)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:44](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L44) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L45) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L30)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "GET_LOGIN_METHODS";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L27)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L29)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:52](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L52)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="getloginmethods"></a> `getLoginMethods` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `firstFactors`: `string`[]; `status`: `"OK"`; `thirdParty`: \{ `providers`: `object`[]; \}; \}\> | Gets enabled login methods and their configuration **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:68](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L68) |
| <a id="gettenantid"></a> `getTenantId` | (`input`) => `Promise`\<`string` \| `undefined`\> \| `string` \| `undefined` | - | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:53](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L53) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:32](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L32)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L33) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/types.ts:34](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/types.ts#L34) |

# References - Frontend SDKs - Javascript SDK Reference -  MultiTenancy
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-multitenancy

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L22)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="alloweddomainsclaim"></a> `AllowedDomainsClaim` | `static` | `AllowedDomainsClaimClass` | `AllowedDomainsClaim` | [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:70](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L70) |

#### Methods

##### getLoginMethods()

```ts
static getLoginMethods(input?): Promise<{
  fetchResponse: Response;
  firstFactors: string[];
  status: "OK";
  thirdParty: {
     providers: object[];
  };
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:40](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L40)

Gets enabled login methods and their configuration from the backend

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `tenantId?`: `string`; `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.tenantId?` | `string` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `firstFactors`: `string`[];
  `status`: `"OK"`;
  `thirdParty`: \{
     `providers`: `object`[];
  \};
\}\>

`{status: OK, emailpassword, passwordless, thirdParty}` if successful

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### getTenantId()

```ts
static getTenantId(input?): string | Promise<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:64](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L64)

Gets enabled login methods and their configuration from the backend

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string` \| `Promise`\<`string`\>

`Promise<string | undefined> | string | undefined`

##### init()

```ts
static init(config?): CreateRecipeFunction<"GET_LOGIN_METHODS">;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:23](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L23)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multitenancy-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<`"GET_LOGIN_METHODS"`\>

## Variables

### AllowedDomainsClaim

```ts
const AllowedDomainsClaim: AllowedDomainsClaimClass;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/allowedDomainsClaim.ts:40](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/allowedDomainsClaim.ts#L40)

***

### getLoginMethods()

```ts
const getLoginMethods: (input?) => Promise<{
  fetchResponse: Response;
  firstFactors: string[];
  status: "OK";
  thirdParty: {
     providers: object[];
  };
}> = RecipeWrapper.getLoginMethods;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L74)

Gets enabled login methods and their configuration from the backend

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `tenantId?`: `string`; `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.tenantId?` | `string` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `firstFactors`: `string`[];
  `status`: `"OK"`;
  `thirdParty`: \{
     `providers`: `object`[];
  \};
\}\>

`{status: OK, emailpassword, passwordless, thirdParty}` if successful

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### getTenantId()

```ts
const getTenantId: (input?) => string | Promise<string> = RecipeWrapper.getTenantId;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:75](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L75)

Gets enabled login methods and their configuration from the backend

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string` \| `Promise`\<`string`\>

`Promise<string | undefined> | string | undefined`

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<"GET_LOGIN_METHODS"> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/multitenancy/index.ts:73](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/multitenancy/index.ts#L73)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-multitenancy-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<`"GET_LOGIN_METHODS"`\>

## References

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-multitenancy-types.mdx#postapihookcontext)

***

### PreAndPostAPIHookAction

Re-exports [PreAndPostAPIHookAction](recipe-multitenancy-types.mdx#preandpostapihookaction)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-multitenancy-types.mdx#preapihookcontext)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-multitenancy-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-multitenancy-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  OAuth Provider Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-oauth2provider-types

## Type Aliases

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:44](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L44)

***

### LoginInfo

```ts
type LoginInfo = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:73](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L73)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clientid"></a> `clientId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L74) |
| <a id="clientname"></a> `clientName` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:76](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L76) |
| <a id="clienturi"></a> `clientUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:84](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L84) |
| <a id="logouri"></a> `logoUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:82](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L82) |
| <a id="metadata"></a> `metadata?` | `Record`\<`string`, `any`\> \| `null` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:86](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L86) |
| <a id="policyuri"></a> `policyUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:80](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L80) |
| <a id="tosuri"></a> `tosUri?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:78](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L78) |

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L46)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:47](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L47) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L48) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L33)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "GET_LOGIN_CHALLENGE_INFO"
  | "GET_REDIRECT_URL_TO_CONTINUE_OAUTH_FLOW"
  | "LOG_OUT";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L27)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:32](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L32)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:55](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L55)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getloginchallengeinfo"></a> `getLoginChallengeInfo` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `info`: [`LoginInfo`](#logininfo); `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:56](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L56) |
| <a id="getredirecturltocontinueoauthflow"></a> `getRedirectURLToContinueOAuthFlow` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `frontendRedirectTo`: `string`; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:61](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L61) |
| <a id="logout"></a> `logOut` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `frontendRedirectTo`: `string`; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:66](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L66) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:35](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L35)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:36](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L36) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/types.ts:37](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/types.ts#L37) |

# References - Frontend SDKs - Javascript SDK Reference -  OAuth Provider
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-oauth2provider

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:28](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L28)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### getLoginChallengeInfo()

```ts
static getLoginChallengeInfo(input): Promise<{
  fetchResponse: Response;
  info: LoginInfo;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L46)

Returns information about an OAuth login in progress

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `info`: [`LoginInfo`](recipe-oauth2provider-types.mdx#logininfo);
  `status`: `"OK"`;
\}\>

`{status: "OK", info: LoginInfo}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### getRedirectURLToContinueOAuthFlow()

```ts
static getRedirectURLToContinueOAuthFlow(input): Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L74)

Accepts the OAuth2 Login request and returns the redirect URL to continue the OAuth flow.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L29)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-oauth2provider-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-oauth2provider-types.mdx#preandpostapihookaction)\>

##### logOut()

```ts
static logOut(input): Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:102](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L102)

Accepts the OAuth2 Logout request, clears the SuperTokens session and returns post logout redirect URL.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `logoutChallenge`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.logoutChallenge` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## Variables

### getLoginChallengeInfo()

```ts
const getLoginChallengeInfo: (input) => Promise<{
  fetchResponse: Response;
  info: LoginInfo;
  status: "OK";
}> = RecipeWrapper.getLoginChallengeInfo;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:115](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L115)

Returns information about an OAuth login in progress

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `info`: [`LoginInfo`](recipe-oauth2provider-types.mdx#logininfo);
  `status`: `"OK"`;
\}\>

`{status: "OK", info: LoginInfo}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### getRedirectURLToContinueOAuthFlow()

```ts
const getRedirectURLToContinueOAuthFlow: (input) => Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}> = RecipeWrapper.getRedirectURLToContinueOAuthFlow;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:116](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L116)

Accepts the OAuth2 Login request and returns the redirect URL to continue the OAuth flow.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `loginChallenge`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.loginChallenge` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:114](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L114)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-oauth2provider-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-oauth2provider-types.mdx#preandpostapihookaction)\>

***

### logOut()

```ts
const logOut: (input) => Promise<{
  fetchResponse: Response;
  frontendRedirectTo: string;
  status: "OK";
}> = RecipeWrapper.logOut;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/oauth2provider/index.ts:117](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/oauth2provider/index.ts#L117)

Accepts the OAuth2 Logout request, clears the SuperTokens session and returns post logout redirect URL.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `logoutChallenge`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.logoutChallenge` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `frontendRedirectTo`: `string`;
  `status`: `"OK"`;
\}\>

`{status: "OK", frontendRedirectTo: string}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

## References

### LoginInfo

Re-exports [LoginInfo](recipe-oauth2provider-types.mdx#logininfo)

***

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-oauth2provider-types.mdx#postapihookcontext)

***

### PreAndPostAPIHookAction

Re-exports [PreAndPostAPIHookAction](recipe-oauth2provider-types.mdx#preandpostapihookaction)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-oauth2provider-types.mdx#preapihookcontext)

***

### RecipeFunctionOptions

Re-exports [RecipeFunctionOptions](recipe-emailpassword.mdx#recipefunctionoptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-oauth2provider-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-oauth2provider-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  Passwordless Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-passwordless-types

## Type Aliases

### InputType

```ts
type InputType = RecipeConfig<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L49)

***

### NormalisedInputType

```ts
type NormalisedInputType = NormalisedRecipeConfig<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:51](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L51)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:52](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L52) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:53](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L53) |

***

### PasswordlessFlowType

```ts
type PasswordlessFlowType = "USER_INPUT_CODE" | "MAGIC_LINK" | "USER_INPUT_CODE_AND_MAGIC_LINK";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:60](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L60)

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:35](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L35)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "PASSWORDLESS_CREATE_CODE"
  | "PASSWORDLESS_CONSUME_CODE"
  | "PASSWORDLESS_RESEND_CODE"
  | "EMAIL_EXISTS"
  | "PHONE_NUMBER_EXISTS";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L27)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:34](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L34)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:62](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L62)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="clearloginattemptinfo"></a> `clearLoginAttemptInfo` | (`input`) => `Promise`\<`void`\> | Clear any information about login attempts from storage | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:312](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L312) |
| <a id="consumecode"></a> `consumeCode` | (`input`) => `Promise`\< \| \{ `createdNewRecipeUser`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `failedCodeInputAttemptCount`: `number`; `fetchResponse`: `Response`; `maximumCodeInputAttempts`: `number`; `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"RESTART_FLOW_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_UP_NOT_ALLOWED"`; \}\> | Log the user in using the input code or link code **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:168](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L168) |
| <a id="createcode"></a> `createCode` | (`input`) => `Promise`\< \| \{ `deviceId`: `string`; `fetchResponse`: `Response`; `flowType`: [`PasswordlessFlowType`](#passwordlessflowtype); `preAuthSessionId`: `string`; `status`: `"OK"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_UP_NOT_ALLOWED"`; \}\> | Create and send a code to the user for passwordless auth **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:80](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L80) |
| <a id="doesemailexist"></a> `doesEmailExist` | (`input`) => `Promise`\<\{ `doesExist`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; \}\> | Check if a user with the given email exists **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:244](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L244) |
| <a id="doesphonenumberexist"></a> `doesPhoneNumberExist` | (`input`) => `Promise`\<\{ `doesExist`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; \}\> | Check if a user with the given phone number exists **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:263](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L263) |
| <a id="getlinkcodefromurl"></a> `getLinkCodeFromURL` | (`input`) => `string` | Reads and returns the link code from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:211](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L211) |
| <a id="getloginattemptinfo"></a> `getLoginAttemptInfo` | \<`CustomLoginAttemptInfoProperties`\>(`input`) => `Promise`\<`undefined` \| `object` & `CustomLoginAttemptInfoProperties`\> | Get information about the current login attempt from storage | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:280](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L280) |
| <a id="getpreauthsessionidfromurl"></a> `getPreAuthSessionIdFromURL` | (`input`) => `string` | Reads and returns the pre auth session id from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:229](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L229) |
| <a id="gettenantidfromurl"></a> `getTenantIdFromURL` | (`input`) => `string` \| `undefined` | Reads and returns the tenant id from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:220](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L220) |
| <a id="resendcode"></a> `resendCode` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `status`: `"OK"` \| `"RESTART_FLOW_ERROR"`; \}\> | Resend the code to the user **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:128](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L128) |
| <a id="setloginattemptinfo"></a> `setLoginAttemptInfo` | \<`CustomStateProperties`\>(`input`) => `Promise`\<`void`\> | Set information about the current login attempt to storage | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:296](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L296) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:37](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L37)

#### Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `override?` | `object` | Refer to [the documentation](https://supertokens.com/docs/passwordless/advanced-customizations/frontend-functions-override/about) | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:41](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L41) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | - | [tmp/supertokens-web-js/lib/ts/recipe/passwordless/types.ts:42](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/types.ts#L42) |

# References - Frontend SDKs - Javascript SDK Reference -  Passwordless
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-passwordless

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L30)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### clearLoginAttemptInfo()

```ts
static clearLoginAttemptInfo(input?): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:432](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L432)

Clear any information about login attempts from storage

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

##### consumeCode()

```ts
static consumeCode(input?): Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  fetchResponse: Response;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  fetchResponse: Response;
  status: "RESTART_FLOW_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:181](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L181)

Log the user in using the input code or link code

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \| \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; `userInputCode`: `string`; \} \| \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `fetchResponse`: `Response`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESTART_FLOW_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

`{status: "OK", user, createdNewRecipeUser: bool}` if succesful

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### createCode()

```ts
static createCode(input): Promise<
  | {
  deviceId: string;
  fetchResponse: Response;
  flowType: PasswordlessFlowType;
  preAuthSessionId: string;
  status: "OK";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:52](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L52)

Create and send a code to the user for passwordless auth

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} \| \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `phoneNumber`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} |

###### Returns

`Promise`\<
  \| \{
  `deviceId`: `string`;
  `fetchResponse`: `Response`;
  `flowType`: [`PasswordlessFlowType`](recipe-passwordless-types.mdx#passwordlessflowtype);
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

`{status: "OK", deviceId, preAuthSessionId, flowType}` If successful

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### doesEmailExist()

```ts
static doesEmailExist(input): Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:338](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L338)

Check if a user with the given email exists

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{status: "OK", doesExist: boolean}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### doesPhoneNumberExist()

```ts
static doesPhoneNumberExist(input): Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:362](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L362)

Check if a user with the given phone number exists

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `phoneNumber`: `string`; `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.phoneNumber` | `string` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{status: "OK", doesExist: boolean}`

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### getLinkCodeFromURL()

```ts
static getLinkCodeFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:290](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L290)

Reads and returns the link code from the current URL

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

The hash (#) property of the current URL

##### getLoginAttemptInfo()

```ts
static getLoginAttemptInfo<CustomLoginAttemptInfoProperties>(input?): Promise<object & CustomLoginAttemptInfoProperties>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:384](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L384)

Get information about the current login attempt from storage

###### Type Parameters

| Type Parameter |
| ------ |
| `CustomLoginAttemptInfoProperties` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`object` & `CustomLoginAttemptInfoProperties`\>

`{deviceId, preAuthSessionId, flowType}` if present, returns undefined otherwise

##### getPreAuthSessionIdFromURL()

```ts
static getPreAuthSessionIdFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:304](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L304)

Reads and returns the pre auth session id from the current URL

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

The "preAuthSessionId" query parameter from the current URL

##### getTenantIdFromURL()

```ts
static getTenantIdFromURL(input?): string;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:318](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L318)

Reads and returns the tenant id from the current URL

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`string`

The "tenantId" query parameter from the current location

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:31](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-passwordless-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-passwordless-types.mdx#preandpostapihookaction)\>

##### resendCode()

```ts
static resendCode(input?): Promise<{
  fetchResponse: Response;
  status: "OK" | "RESTART_FLOW_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:127](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L127)

Resend the code to the user

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"RESTART_FLOW_ERROR"`;
\}\>

`{status: "OK"}` if succesful

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### setLoginAttemptInfo()

```ts
static setLoginAttemptInfo<CustomStateProperties>(input): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:405](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L405)

Set information about the current login attempt to storage

###### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `attemptInfo`: `object` & `CustomStateProperties`; `userContext?`: `any`; \} |
| `input.attemptInfo` | `object` & `CustomStateProperties` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:439](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L439)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

## Variables

### clearLoginAttemptInfo()

```ts
const clearLoginAttemptInfo: (input?) => Promise<void> = RecipeWrapper.clearLoginAttemptInfo;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:458](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L458)

Clear any information about login attempts from storage

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

***

### consumeCode()

```ts
const consumeCode: (input?) => Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  fetchResponse: Response;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  fetchResponse: Response;
  status: "RESTART_FLOW_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = RecipeWrapper.consumeCode;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:449](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L449)

Log the user in using the input code or link code

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \| \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; `userInputCode`: `string`; \} \| \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |

#### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `fetchResponse`: `Response`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RESTART_FLOW_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

`{status: "OK", user, createdNewRecipeUser: bool}` if succesful

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### createCode()

```ts
const createCode: (input) => Promise<
  | {
  deviceId: string;
  fetchResponse: Response;
  flowType: PasswordlessFlowType;
  preAuthSessionId: string;
  status: "OK";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = RecipeWrapper.createCode;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:447](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L447)

Create and send a code to the user for passwordless auth

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} \| \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `phoneNumber`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext?`: `any`; \} |

#### Returns

`Promise`\<
  \| \{
  `deviceId`: `string`;
  `fetchResponse`: `Response`;
  `flowType`: [`PasswordlessFlowType`](recipe-passwordless-types.mdx#passwordlessflowtype);
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

`{status: "OK", deviceId, preAuthSessionId, flowType}` If successful

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### doesEmailExist()

```ts
const doesEmailExist: (input) => Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = RecipeWrapper.doesEmailExist;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:450](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L450)

Check if a user with the given email exists

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{status: "OK", doesExist: boolean}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### doesPhoneNumberExist()

```ts
const doesPhoneNumberExist: (input) => Promise<{
  doesExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = RecipeWrapper.doesPhoneNumberExist;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:451](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L451)

Check if a user with the given phone number exists

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `phoneNumber`: `string`; `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.phoneNumber` | `string` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `doesExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{status: "OK", doesExist: boolean}`

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### getLinkCodeFromURL()

```ts
const getLinkCodeFromURL: (input?) => string = RecipeWrapper.getLinkCodeFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:453](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L453)

Reads and returns the link code from the current URL

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

The hash (#) property of the current URL

***

### getLoginAttemptInfo()

```ts
const getLoginAttemptInfo: <CustomLoginAttemptInfoProperties>(input?) => Promise<object & CustomLoginAttemptInfoProperties> = RecipeWrapper.getLoginAttemptInfo;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:456](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L456)

Get information about the current login attempt from storage

#### Type Parameters

| Type Parameter |
| ------ |
| `CustomLoginAttemptInfoProperties` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`object` & `CustomLoginAttemptInfoProperties`\>

`{deviceId, preAuthSessionId, flowType}` if present, returns undefined otherwise

***

### getPreAuthSessionIdFromURL()

```ts
const getPreAuthSessionIdFromURL: (input?) => string = RecipeWrapper.getPreAuthSessionIdFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:454](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L454)

Reads and returns the pre auth session id from the current URL

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

The "preAuthSessionId" query parameter from the current URL

***

### getTenantIdFromURL()

```ts
const getTenantIdFromURL: (input?) => string = RecipeWrapper.getTenantIdFromURL;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:455](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L455)

Reads and returns the tenant id from the current URL

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`string`

The "tenantId" query parameter from the current location

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:446](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L446)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-passwordless-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-passwordless-types.mdx#preandpostapihookaction)\>

***

### resendCode()

```ts
const resendCode: (input?) => Promise<{
  fetchResponse: Response;
  status: "OK" | "RESTART_FLOW_ERROR";
}> = RecipeWrapper.resendCode;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:448](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L448)

Resend the code to the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `fetchResponse`: `Response`;
  `status`: `"OK"` \| `"RESTART_FLOW_ERROR"`;
\}\>

`{status: "OK"}` if succesful

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### setLoginAttemptInfo()

```ts
const setLoginAttemptInfo: <CustomStateProperties>(input) => Promise<void> = RecipeWrapper.setLoginAttemptInfo;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:457](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L457)

Set information about the current login attempt to storage

#### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `attemptInfo`: `object` & `CustomStateProperties`; `userContext?`: `any`; \} |
| `input.attemptInfo` | `object` & `CustomStateProperties` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = RecipeWrapper.signOut;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/passwordless/index.ts:452](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/passwordless/index.ts#L452)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

## References

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-passwordless-types.mdx#postapihookcontext)

***

### PreAndPostAPIHookAction

Re-exports [PreAndPostAPIHookAction](recipe-passwordless-types.mdx#preandpostapihookaction)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-passwordless-types.mdx#preapihookcontext)

***

### RecipeFunctionOptions

Re-exports [RecipeFunctionOptions](recipe-emailpassword.mdx#recipefunctionoptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-passwordless-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-passwordless-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  Session Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-session-types

## Type Aliases

### InputType

```ts
type InputType = object & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:50](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L50)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppInfo`](types.mdx#normalisedappinfo) | [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:52](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L52) |
| `enableDebugLogs` | `boolean` | [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:53](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L53) |
| `recipeId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:51](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L51) |

***

### RecipeEvent

```ts
type RecipeEvent = 
  | {
  action:   | "SIGN_OUT"
     | "REFRESH_SESSION"
     | "SESSION_CREATED"
     | "ACCESS_TOKEN_PAYLOAD_UPDATED"
     | "SESSION_ALREADY_EXISTS";
  userContext: any;
}
  | {
  action: "API_INVALID_CLAIM";
  claimValidationErrors: ClaimValidationError[];
  userContext: any;
}
  | {
  action: "UNAUTHORISED";
  sessionExpiredOrRevoked: boolean;
  userContext: any;
};
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L22)

***

### RecipeInterface

```ts
type RecipeInterface = RecipeInterface;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L48)

***

### UserInput

```ts
type UserInput = Omit<WebsiteInputType, 
  | "apiDomain"
  | "apiBasePath"
  | "enableDebugLogs"
  | "cookieHandler"
| "windowHandler">;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/types.ts#L43)

# References - Frontend SDKs - Javascript SDK Reference -  Session
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-session

## Classes

### BooleanClaim

Defined in: node\_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts:7

#### Extends

- [`PrimitiveClaim`](#primitiveclaim)\<`boolean`\>

#### Extended by

- [`EmailVerificationClaimClass`](recipe-emailverification.mdx#emailverificationclaimclass)

#### Constructors

##### Constructor

```ts
new BooleanClaim(config): BooleanClaim;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts:8

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`PrimitiveClaimConfig`](#primitiveclaimconfig) |

###### Returns

[`BooleanClaim`](#booleanclaim)

###### Overrides

[`PrimitiveClaim`](#primitiveclaim).[`constructor`](#constructor-3)

#### Properties

| Property | Modifier | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | - | [`PrimitiveClaim`](#primitiveclaim).[`defaultMaxAgeInSeconds`](#defaultmaxageinseconds-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:10 |
| <a id="id"></a> `id` | `readonly` | `string` | - | [`PrimitiveClaim`](#primitiveclaim).[`id`](#id-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:8 |
| <a id="refresh"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | - | [`PrimitiveClaim`](#primitiveclaim).[`refresh`](#refresh-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:9 |
| <a id="validators"></a> `validators` | `public` | `object` & `BooleanValidators` | [`PrimitiveClaim`](#primitiveclaim).[`validators`](#validators-2) | - | node\_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts:9 |

#### Methods

##### getLastFetchedTime()

```ts
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

###### Inherited from

[`PrimitiveClaim`](#primitiveclaim).[`getLastFetchedTime`](#getlastfetchedtime-4)

##### getValueFromPayload()

```ts
getValueFromPayload(payload, _userContext?): boolean;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`boolean`

###### Inherited from

[`PrimitiveClaim`](#primitiveclaim).[`getValueFromPayload`](#getvaluefrompayload-4)

***

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L22)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### ~~addAxiosInterceptors()~~

```ts
static addAxiosInterceptors(axiosInstance, userContext?): void;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L59)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `axiosInstance` | `any` |
| `userContext?` | `any` |

###### Returns

`void`

###### Deprecated

##### attemptRefreshingSession()

```ts
static attemptRefreshingSession(): Promise<boolean>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L45)

###### Returns

`Promise`\<`boolean`\>

##### doesSessionExist()

```ts
static doesSessionExist(input?): Promise<boolean>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L49)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`boolean`\>

##### getAccessToken()

```ts
static getAccessToken(input?): Promise<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L33)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`string`\>

##### getAccessTokenPayloadSecurely()

```ts
static getAccessTokenPayloadSecurely(input?): Promise<any>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:39](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L39)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`any`\>

##### getClaimValue()

```ts
static getClaimValue<T>(input): Promise<T>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:69](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L69)

###### Type Parameters

| Type Parameter |
| ------ |
| `T` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claim`: [`SessionClaim`](#sessionclaim)\<`T`\>; `userContext?`: `any`; \} |
| `input.claim` | [`SessionClaim`](#sessionclaim)\<`T`\> |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`T`\>

##### getInvalidClaimsFromResponse()

```ts
static getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:90](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L90)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `response`: \| `Response` \| \{ `data`: `any`; \}; `userContext?`: `any`; \} |
| `input.response` | \| `Response` \| \{ `data`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

##### getUserId()

```ts
static getUserId(input?): Promise<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L27)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`string`\>

##### init()

```ts
static init(config?): CreateRecipeFunction<unknown>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:23](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L23)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-session-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<`unknown`\>

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:63](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L63)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

##### validateClaims()

```ts
static validateClaims(input?): 
  | ClaimValidationError[]
| Promise<ClaimValidationError[]>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:76](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L76)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `overrideGlobalClaimValidators?`: (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[]; `userContext?`: `any`; \} |
| `input.overrideGlobalClaimValidators?` | (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[] |
| `input.userContext?` | `any` |

###### Returns

  \| [`ClaimValidationError`](#claimvalidationerror)[]
  \| `Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

***

### PrimitiveArrayClaim\<ValueType\>

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:7

#### Type Parameters

| Type Parameter |
| ------ |
| `ValueType` |

#### Constructors

##### Constructor

```ts
new PrimitiveArrayClaim<ValueType>(config): PrimitiveArrayClaim<ValueType>;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:11

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`PrimitiveArrayClaimConfig`](#primitivearrayclaimconfig) |

###### Returns

[`PrimitiveArrayClaim`](#primitivearrayclaim)\<`ValueType`\>

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-1"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:10 |
| <a id="id-1"></a> `id` | `readonly` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:8 |
| <a id="refresh-1"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:9 |
| <a id="validators-1"></a> `validators` | `public` | `object` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:14 |
| `validators.excludes` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:16 |
| `validators.excludesAll` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:19 |
| `validators.includes` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:15 |
| `validators.includesAll` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:17 |
| `validators.includesAny` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:18 |

#### Methods

##### getLastFetchedTime()

```ts
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

##### getValueFromPayload()

```ts
getValueFromPayload(payload, _userContext?): ValueType[];
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`ValueType`[]

***

### PrimitiveClaim\<ValueType\>

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:7

#### Extended by

- [`BooleanClaim`](#booleanclaim)

#### Type Parameters

| Type Parameter |
| ------ |
| `ValueType` |

#### Constructors

##### Constructor

```ts
new PrimitiveClaim<ValueType>(config): PrimitiveClaim<ValueType>;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:11

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`PrimitiveClaimConfig`](#primitiveclaimconfig) |

###### Returns

[`PrimitiveClaim`](#primitiveclaim)\<`ValueType`\>

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-2"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:10 |
| <a id="id-2"></a> `id` | `readonly` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:8 |
| <a id="refresh-2"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:9 |
| <a id="validators-2"></a> `validators` | `public` | `object` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:14 |
| `validators.hasValue` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:15 |

#### Methods

##### getLastFetchedTime()

```ts
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

##### getValueFromPayload()

```ts
getValueFromPayload(payload, _userContext?): ValueType;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`ValueType`

## Type Aliases

### ClaimValidationError

```ts
type ClaimValidationError = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:147

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id-3"></a> `id` | `string` | node\_modules/supertokens-website/lib/build/types.d.ts:148 |
| <a id="reason"></a> `reason?` | `any` | node\_modules/supertokens-website/lib/build/types.d.ts:149 |

***

### ClaimValidationResult

```ts
type ClaimValidationResult = 
  | {
  isValid: true;
}
  | {
  isValid: false;
  reason?: any;
};
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:141

***

### PrimitiveArrayClaimConfig

```ts
type PrimitiveArrayClaimConfig = object;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:2

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-3"></a> `defaultMaxAgeInSeconds?` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:5 |
| <a id="id-4"></a> `id` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:3 |
| <a id="refresh-3"></a> `refresh` | (`userContext?`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:4 |

***

### PrimitiveClaimConfig

```ts
type PrimitiveClaimConfig = object;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:2

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-4"></a> `defaultMaxAgeInSeconds?` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:5 |
| <a id="id-5"></a> `id` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:3 |
| <a id="refresh-4"></a> `refresh` | (`userContext?`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:4 |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:97

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="addaxiosinterceptors-2"></a> `addAxiosInterceptors` | (`input`) => `void` | node\_modules/supertokens-website/lib/build/types.d.ts:105 |
| <a id="addfetchinterceptorsandreturnmodifiedfetch"></a> `addFetchInterceptorsAndReturnModifiedFetch` | (`input`) => *typeof* `fetch` | node\_modules/supertokens-website/lib/build/types.d.ts:98 |
| <a id="addxmlhttprequestinterceptor"></a> `addXMLHttpRequestInterceptor` | (`input`) => `void` | node\_modules/supertokens-website/lib/build/types.d.ts:102 |
| <a id="doessessionexist-2"></a> `doesSessionExist` | (`input`) => `Promise`\<`boolean`\> | node\_modules/supertokens-website/lib/build/types.d.ts:115 |
| <a id="getaccesstokenpayloadsecurely-2"></a> `getAccessTokenPayloadSecurely` | (`input`) => `Promise`\<`any`\> | node\_modules/supertokens-website/lib/build/types.d.ts:112 |
| <a id="getuserid-2"></a> `getUserId` | (`input`) => `Promise`\<`string`\> | node\_modules/supertokens-website/lib/build/types.d.ts:109 |
| <a id="signout-2"></a> `signOut` | (`input`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/types.d.ts:118 |
| <a id="validateclaims-2"></a> `validateClaims` | (`input`) => `Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\> | node\_modules/supertokens-website/lib/build/types.d.ts:127 |

#### Methods

##### calculateClockSkewInMillis()

```ts
calculateClockSkewInMillis(params): number;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:136

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | \{ `accessTokenPayload`: `any`; `responseHeaders`: `Headers`; \} |
| `params.accessTokenPayload` | `any` |
| `params.responseHeaders` | `Headers` |

###### Returns

`number`

##### getGlobalClaimValidators()

```ts
getGlobalClaimValidators(input): SessionClaimValidator[];
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:131

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claimValidatorsAddedByOtherRecipes`: [`SessionClaimValidator`](#sessionclaimvalidator)[]; `userContext`: `any`; \} |
| `input.claimValidatorsAddedByOtherRecipes` | [`SessionClaimValidator`](#sessionclaimvalidator)[] |
| `input.userContext` | `any` |

###### Returns

[`SessionClaimValidator`](#sessionclaimvalidator)[]

##### getInvalidClaimsFromResponse()

```ts
getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:121

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `response`: \| \{ `data`: `any`; \} \| `Response`; `userContext`: `any`; \} |
| `input.response` | \| \{ `data`: `any`; \} \| `Response` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

##### shouldDoInterceptionBasedOnUrl()

```ts
shouldDoInterceptionBasedOnUrl(
   toCheckUrl, 
   apiDomain, 
   sessionTokenBackendDomain): boolean;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:135

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `toCheckUrl` | `string` |
| `apiDomain` | `string` |
| `sessionTokenBackendDomain` | `string` |

###### Returns

`boolean`

***

### SessionClaim\<ValueType\>

```ts
type SessionClaim<ValueType> = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:167

#### Type Parameters

| Type Parameter |
| ------ |
| `ValueType` |

#### Methods

##### getLastFetchedTime()

```ts
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:170

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

##### getValueFromPayload()

```ts
getValueFromPayload(payload, _userContext?): ValueType;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:169

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`ValueType`

##### refresh()

```ts
refresh(userContext): Promise<void>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:168

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | `any` |

###### Returns

`Promise`\<`void`\>

***

### SessionClaimValidator

```ts
type SessionClaimValidator = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:151

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="id-6"></a> `id` | `readonly` | `string` | node\_modules/supertokens-website/lib/build/types.d.ts:152 |

#### Methods

##### refresh()

```ts
refresh(userContext): Promise<void>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:156

Makes an API call that will refresh the claim in the token.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | `any` |

###### Returns

`Promise`\<`void`\>

##### shouldRefresh()

```ts
shouldRefresh(accessTokenPayload, userContext): boolean | Promise<boolean>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:161

Decides if we need to refresh the claim value before checking the payload with `validate`.
E.g.: if the information in the payload is expired, or is not sufficient for this validator.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `accessTokenPayload` | `any` |
| `userContext` | `any` |

###### Returns

`boolean` \| `Promise`\<`boolean`\>

##### validate()

```ts
validate(accessTokenPayload, userContext): 
  | ClaimValidationResult
| Promise<ClaimValidationResult>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:165

Decides if the claim is valid based on the accessTokenPayload object (and not checking DB or anything else)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `accessTokenPayload` | `any` |
| `userContext` | `any` |

###### Returns

  \| [`ClaimValidationResult`](#claimvalidationresult)
  \| `Promise`\<[`ClaimValidationResult`](#claimvalidationresult)\>

## Variables

### ~~addAxiosInterceptors()~~

```ts
const addAxiosInterceptors: (axiosInstance, userContext?) => void = RecipeWrapper.addAxiosInterceptors;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:110](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L110)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `axiosInstance` | `any` |
| `userContext?` | `any` |

#### Returns

`void`

#### Deprecated

#### Deprecated

***

### attemptRefreshingSession()

```ts
const attemptRefreshingSession: () => Promise<boolean> = RecipeWrapper.attemptRefreshingSession;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:105](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L105)

#### Returns

`Promise`\<`boolean`\>

***

### doesSessionExist()

```ts
const doesSessionExist: (input?) => Promise<boolean> = RecipeWrapper.doesSessionExist;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:106](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L106)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`boolean`\>

***

### getAccessToken()

```ts
const getAccessToken: (input?) => Promise<string> = RecipeWrapper.getAccessToken;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:104](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L104)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`string`\>

***

### getAccessTokenPayloadSecurely()

```ts
const getAccessTokenPayloadSecurely: (input?) => Promise<any> = RecipeWrapper.getAccessTokenPayloadSecurely;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:103](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L103)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`any`\>

***

### getClaimValue()

```ts
const getClaimValue: <T>(input) => Promise<T> = RecipeWrapper.getClaimValue;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L113)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claim`: [`SessionClaim`](#sessionclaim)\<`T`\>; `userContext?`: `any`; \} |
| `input.claim` | [`SessionClaim`](#sessionclaim)\<`T`\> |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`T`\>

***

### getInvalidClaimsFromResponse()

```ts
const getInvalidClaimsFromResponse: (input) => Promise<ClaimValidationError[]> = RecipeWrapper.getInvalidClaimsFromResponse;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:114](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L114)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `response`: \| `Response` \| \{ `data`: `any`; \}; `userContext?`: `any`; \} |
| `input.response` | \| `Response` \| \{ `data`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

***

### getUserId()

```ts
const getUserId: (input?) => Promise<string> = RecipeWrapper.getUserId;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:102](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L102)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`string`\>

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<unknown> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:101](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L101)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-session-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<`unknown`\>

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = RecipeWrapper.signOut;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:111](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L111)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

***

### validateClaims()

```ts
const validateClaims: (input?) => 
  | ClaimValidationError[]
  | Promise<ClaimValidationError[]> = RecipeWrapper.validateClaims;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:112](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L112)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `overrideGlobalClaimValidators?`: (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[]; `userContext?`: `any`; \} |
| `input.overrideGlobalClaimValidators?` | (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[] |
| `input.userContext?` | `any` |

#### Returns

  \| [`ClaimValidationError`](#claimvalidationerror)[]
  \| `Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

## References

### UserInput

Re-exports [UserInput](recipe-session-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  ThirdParty Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-thirdparty-types

## Type Aliases

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L45)

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:47](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L47)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L48) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L49) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:31](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L31)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = "GET_AUTHORISATION_URL" | "THIRD_PARTY_SIGN_IN_UP";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:28](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L28)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L30)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:66](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L66)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="generatestatetosendtooauthprovider"></a> `generateStateToSendToOAuthProvider` | (`input?`) => `string` | Generate a new state that will be sent to the third party provider | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:193](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L193) |
| <a id="getautherrorfromurl"></a> `getAuthErrorFromURL` | (`input`) => `string` \| `undefined` | Returns the error from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:217](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L217) |
| <a id="getauthorisationurlfrombackend"></a> `getAuthorisationURLFromBackend` | (`input`) => `Promise`\<\{ `fetchResponse`: `Response`; `pkceCodeVerifier?`: `string`; `status`: `"OK"`; `urlWithQueryParams`: `string`; \}\> | Get the URL to be used by the third party provider for redirecting after the auth flow. Also returns PKCE Code Verifier if using PKCE. **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:138](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L138) |
| <a id="getauthorisationurlwithqueryparamsandsetstate"></a> `getAuthorisationURLWithQueryParamsAndSetState` | (`input`) => `Promise`\<`string`\> | Get the URL that should be opened for third party authentication **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:111](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L111) |
| <a id="getauthstatefromurl"></a> `getAuthStateFromURL` | (`input`) => `string` | Returns the auth state from the current URL | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:226](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L226) |
| <a id="getstateandotherinfofromstorage"></a> `getStateAndOtherInfoFromStorage` | \<`CustomStateProperties`\>(`input`) => [`StateObject`](#stateobject) & `CustomStateProperties` \| `undefined` | Get the current login state from storage, this is also used when calling signInUp | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L74) |
| <a id="setstateandotherinfotostorage"></a> `setStateAndOtherInfoToStorage` | \<`CustomStateProperties`\>(`input`) => `Promise`\<`void`\> | Set the login state to storage | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:85](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L85) |
| <a id="signinandup"></a> `signInAndUp` | (`input`) => `Promise`\< \| \{ `createdNewRecipeUser`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; `tenantId?`: `string`; `user`: [`User`](types.mdx#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"NO_EMAIL_GIVEN_BY_PROVIDER"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_UP_NOT_ALLOWED"`; \}\> | Sign up/Sign in the user, this method uses the login attempt information from storage **Throws** STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:165](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L165) |
| <a id="verifyandgetstateorthrowerror"></a> `verifyAndGetStateOrThrowError` | \<`CustomStateProperties`\>(`input`) => `Promise`\<[`StateObject`](#stateobject) & `CustomStateProperties`\> | Verify that the state recieved from the third party provider matches the one in storage | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:204](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L204) |

***

### StateObject

```ts
type StateObject = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:56](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L56)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="expiresat"></a> `expiresAt` | `number` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:60](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L60) |
| <a id="pkcecodeverifier"></a> `pkceCodeVerifier?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:63](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L63) |
| <a id="redirecturionproviderdashboard"></a> `redirectURIOnProviderDashboard` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:61](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L61) |
| <a id="shouldtrylinkingwithsessionuser"></a> `shouldTryLinkingWithSessionUser?` | `boolean` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:62](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L62) |
| <a id="stateforauthprovider"></a> `stateForAuthProvider` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:57](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L57) |
| <a id="tenantid"></a> `tenantId?` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L59) |
| <a id="thirdpartyid"></a> `thirdPartyId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:58](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L58) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L33)

#### Type Declaration

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `override?` | `object` | Refer to [the documentation](https://supertokens.com/docs/thirdparty/advanced-customizations/frontend-functions-override/about) | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:37](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L37) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | - | [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:38](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/types.ts#L38) |

# References - Frontend SDKs - Javascript SDK Reference -  ThirdParty
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-thirdparty

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L30)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### getAuthorisationURLWithQueryParamsAndSetState()

```ts
static getAuthorisationURLWithQueryParamsAndSetState(input): Promise<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:76](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L76)

Get the URL that should be opened for third party authentication

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `frontendRedirectURI`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `redirectURIOnProviderDashboard?`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: `any`; \} |
| `input.frontendRedirectURI` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.redirectURIOnProviderDashboard?` | `string` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.thirdPartyId` | `string` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`string`\>

URL string

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### getStateAndOtherInfoFromStorage()

```ts
static getStateAndOtherInfoFromStorage<CustomStateProperties>(input?): StateObject & CustomStateProperties;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L48)

Get the current login state from storage, this is also used when calling signInUp

###### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

[`StateObject`](recipe-thirdparty-types.mdx#stateobject) & `CustomStateProperties`

State object from storage

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:31](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-thirdparty-types.mdx#preandpostapihookaction)\>

##### signInAndUp()

```ts
static signInAndUp(input?): Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "NO_EMAIL_GIVEN_BY_PROVIDER";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:109](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L109)

Sign up/Sign in the user, this method uses the login attempt information from storage

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"NO_EMAIL_GIVEN_BY_PROVIDER"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

`{status: OK, user, createdNewRecipeUser: boolean}` if successful

###### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

##### signOut()

```ts
static signOut(input?): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:35](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L35)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

## Variables

### getAuthorisationURLWithQueryParamsAndSetState()

```ts
const getAuthorisationURLWithQueryParamsAndSetState: (input) => Promise<string> = RecipeWrapper.getAuthorisationURLWithQueryParamsAndSetState;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:134](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L134)

Get the URL that should be opened for third party authentication

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `frontendRedirectURI`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `redirectURIOnProviderDashboard?`: `string`; `shouldTryLinkingWithSessionUser?`: `boolean`; `thirdPartyId`: `string`; `userContext?`: `any`; \} |
| `input.frontendRedirectURI` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.redirectURIOnProviderDashboard?` | `string` |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.thirdPartyId` | `string` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`string`\>

URL string

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### getStateAndOtherInfoFromStorage()

```ts
const getStateAndOtherInfoFromStorage: <CustomStateProperties>(input?) => StateObject & CustomStateProperties = RecipeWrapper.getStateAndOtherInfoFromStorage;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:135](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L135)

Get the current login state from storage, this is also used when calling signInUp

#### Type Parameters

| Type Parameter |
| ------ |
| `CustomStateProperties` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

[`StateObject`](recipe-thirdparty-types.mdx#stateobject) & `CustomStateProperties`

State object from storage

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:133](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L133)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-thirdparty-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-thirdparty-types.mdx#preandpostapihookaction)\>

***

### signInAndUp()

```ts
const signInAndUp: (input?) => Promise<
  | {
  createdNewRecipeUser: boolean;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "NO_EMAIL_GIVEN_BY_PROVIDER";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}> = RecipeWrapper.signInAndUp;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:136](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L136)

Sign up/Sign in the user, this method uses the login attempt information from storage

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"NO_EMAIL_GIVEN_BY_PROVIDER"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

`{status: OK, user, createdNewRecipeUser: boolean}` if successful

#### Throws

STGeneralError if the API exposed by the backend SDKs returns `status: "GENERAL_ERROR"`

***

### signOut()

```ts
const signOut: (input?) => Promise<void> = RecipeWrapper.signOut;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/thirdparty/index.ts:137](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/thirdparty/index.ts#L137)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

## References

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-thirdparty-types.mdx#postapihookcontext)

***

### PreAndPostAPIHookAction

Re-exports [PreAndPostAPIHookAction](recipe-thirdparty-types.mdx#preandpostapihookaction)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-thirdparty-types.mdx#preapihookcontext)

***

### RecipeFunctionOptions

Re-exports [RecipeFunctionOptions](recipe-emailpassword.mdx#recipefunctionoptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-thirdparty-types.mdx#recipeinterface)

***

### StateObject

Re-exports [StateObject](recipe-thirdparty-types.mdx#stateobject)

***

### UserInput

Re-exports [UserInput](recipe-thirdparty-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  TOTP Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-totp-types

## Type Aliases

### DeviceInfo

```ts
type DeviceInfo = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:57](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L57)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="devicename"></a> `deviceName` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:58](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L58) |
| <a id="qrcodestring"></a> `qrCodeString` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:60](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L60) |
| <a id="secret"></a> `secret` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L59) |

***

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L46)

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L48)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L49) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:50](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L50) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:35](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L35)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "CREATE_DEVICE"
  | "VERIFY_CODE"
  | "VERIFY_DEVICE"
  | "REMOVE_DEVICE"
  | "LIST_DEVICES";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L27)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:34](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L34)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:63](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L63)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="createdevice"></a> `createDevice` | (`input`) => `Promise`\< \| \{ `deviceName`: `string`; `fetchResponse`: `Response`; `qrCodeString`: `string`; `secret`: `string`; `status`: `"OK"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:64](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L64) |
| <a id="listdevices"></a> `listDevices` | (`input`) => `Promise`\<\{ `devices`: `object`[]; `fetchResponse`: `Response`; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:110](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L110) |
| <a id="removedevice"></a> `removeDevice` | (`input`) => `Promise`\<\{ `didDeviceExist`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:105](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L105) |
| <a id="verifycode"></a> `verifyCode` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| \{ `currentNumberOfFailedAttempts`: `number`; `fetchResponse`: `Response`; `maxNumberOfFailedAttempts`: `number`; `status`: `"INVALID_TOTP_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `retryAfterMs`: `number`; `status`: `"LIMIT_REACHED_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:79](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L79) |
| <a id="verifydevice"></a> `verifyDevice` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `wasAlreadyVerified`: `boolean`; \} \| \{ `currentNumberOfFailedAttempts`: `number`; `fetchResponse`: `Response`; `maxNumberOfFailedAttempts`: `number`; `status`: `"INVALID_TOTP_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"UNKNOWN_DEVICE_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `retryAfterMs`: `number`; `status`: `"LIMIT_REACHED_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:89](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L89) |

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:37](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L37)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:38](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L38) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/totp/types.ts:39](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/types.ts#L39) |

# References - Frontend SDKs - Javascript SDK Reference -  TOTP
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-totp

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:28](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L28)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### createDevice()

```ts
static createDevice(input?): Promise<
  | {
  deviceName: string;
  fetchResponse: Response;
  qrCodeString: string;
  secret: string;
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "DEVICE_ALREADY_EXISTS_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:44](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L44)

Creates a new unverified device.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `deviceName?`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.deviceName?` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `deviceName`: `string`;
  `fetchResponse`: `Response`;
  `qrCodeString`: `string`;
  `secret`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the created device (secret, etc.)

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:29](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L29)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-totp-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-totp-types.mdx#preandpostapihookaction)\>

##### listDevices()

```ts
static listDevices(input?): Promise<{
  devices: object[];
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:153](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L153)

Lists all TOTP devices of the current user

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `devices`: `object`[];
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful with a list of devices in the `devices` prop

##### removeDevice()

```ts
static removeDevice(input): Promise<{
  didDeviceExist: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:133](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L133)

Removes a TOTP device

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.deviceName` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<\{
  `didDeviceExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful

##### verifyCode()

```ts
static verifyCode(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  currentNumberOfFailedAttempts: number;
  fetchResponse: Response;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  fetchResponse: Response;
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:71](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L71)

Verifies that the totp code belongs to a verified device of the current user

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `totp`: `string`; `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.totp` | `string` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `fetchResponse`: `Response`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

##### verifyDevice()

```ts
static verifyDevice(input): Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  wasAlreadyVerified: boolean;
}
  | {
  currentNumberOfFailedAttempts: number;
  fetchResponse: Response;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  fetchResponse: Response;
  status: "UNKNOWN_DEVICE_ERROR";
}
  | {
  fetchResponse: Response;
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:100](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L100)

Verifies the totp device for the current user

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `totp`: `string`; `userContext?`: `any`; \} |
| `input.deviceName` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.totp` | `string` |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `wasAlreadyVerified`: `boolean`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `fetchResponse`: `Response`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"UNKNOWN_DEVICE_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

## Variables

### createDevice()

```ts
const createDevice: (input?) => Promise<
  | {
  deviceName: string;
  fetchResponse: Response;
  qrCodeString: string;
  secret: string;
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "DEVICE_ALREADY_EXISTS_ERROR";
}> = RecipeWrapper.createDevice;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:166](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L166)

Creates a new unverified device.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `deviceName?`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.deviceName?` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `deviceName`: `string`;
  `fetchResponse`: `Response`;
  `qrCodeString`: `string`;
  `secret`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the created device (secret, etc.)

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:165](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L165)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-totp-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-totp-types.mdx#preandpostapihookaction)\>

***

### listDevices()

```ts
const listDevices: (input?) => Promise<{
  devices: object[];
  fetchResponse: Response;
  status: "OK";
}> = RecipeWrapper.listDevices;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:170](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L170)

Lists all TOTP devices of the current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `devices`: `object`[];
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful with a list of devices in the `devices` prop

***

### removeDevice()

```ts
const removeDevice: (input) => Promise<{
  didDeviceExist: boolean;
  fetchResponse: Response;
  status: "OK";
}> = RecipeWrapper.removeDevice;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:169](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L169)

Removes a TOTP device

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext?`: `any`; \} |
| `input.deviceName` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<\{
  `didDeviceExist`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful

***

### verifyCode()

```ts
const verifyCode: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  currentNumberOfFailedAttempts: number;
  fetchResponse: Response;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  fetchResponse: Response;
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}> = RecipeWrapper.verifyCode;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:167](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L167)

Verifies that the totp code belongs to a verified device of the current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `totp`: `string`; `userContext?`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.totp` | `string` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `fetchResponse`: `Response`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

***

### verifyDevice()

```ts
const verifyDevice: (input) => Promise<
  | {
  fetchResponse: Response;
  status: "OK";
  wasAlreadyVerified: boolean;
}
  | {
  currentNumberOfFailedAttempts: number;
  fetchResponse: Response;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  fetchResponse: Response;
  status: "UNKNOWN_DEVICE_ERROR";
}
  | {
  fetchResponse: Response;
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}> = RecipeWrapper.verifyDevice;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/totp/index.ts:168](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/totp/index.ts#L168)

Verifies the totp device for the current user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceName`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `totp`: `string`; `userContext?`: `any`; \} |
| `input.deviceName` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.totp` | `string` |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `wasAlreadyVerified`: `boolean`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `fetchResponse`: `Response`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"UNKNOWN_DEVICE_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

## References

### DeviceInfo

Re-exports [DeviceInfo](recipe-totp-types.mdx#deviceinfo)

***

### PostAPIHookContext

Re-exports [PostAPIHookContext](recipe-totp-types.mdx#postapihookcontext)

***

### PreAndPostAPIHookAction

Re-exports [PreAndPostAPIHookAction](recipe-totp-types.mdx#preandpostapihookaction)

***

### PreAPIHookContext

Re-exports [PreAPIHookContext](recipe-totp-types.mdx#preapihookcontext)

***

### RecipeFunctionOptions

Re-exports [RecipeFunctionOptions](recipe-emailpassword.mdx#recipefunctionoptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-totp-types.mdx#recipeinterface)

***

### UserInput

Re-exports [UserInput](recipe-totp-types.mdx#userinput)

# References - Frontend SDKs - Javascript SDK Reference -  UserRoles
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-userroles

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/userroles/index.ts:18](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/userroles/index.ts#L18)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="permissionclaim"></a> `PermissionClaim` | `static` | [`PrimitiveArrayClaim`](recipe-session.mdx#primitivearrayclaim)\<`string`\> | `PermissionClaim` | [tmp/supertokens-web-js/lib/ts/recipe/userroles/index.ts:20](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/userroles/index.ts#L20) |
| <a id="userroleclaim"></a> `UserRoleClaim` | `static` | [`PrimitiveArrayClaim`](recipe-session.mdx#primitivearrayclaim)\<`string`\> | `UserRoleClaim` | [tmp/supertokens-web-js/lib/ts/recipe/userroles/index.ts:19](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/userroles/index.ts#L19) |

## Variables

### PermissionClaim

```ts
const PermissionClaim: PrimitiveArrayClaim<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/userroles/permissionClaim.ts:17](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/userroles/permissionClaim.ts#L17)

***

### UserRoleClaim

```ts
const UserRoleClaim: PrimitiveArrayClaim<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/userroles/userRoleClaim.ts:17](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/userroles/userRoleClaim.ts#L17)

# References - Frontend SDKs - Javascript SDK Reference -  WebAuthn Types
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-webauthn-types

## Type Aliases

### AuthenticationOptions

```ts
type AuthenticationOptions = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:116](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L116)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="challenge"></a> `challenge` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:119](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L119) |
| <a id="fetchresponse"></a> `fetchResponse` | `Response` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:122](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L122) |
| <a id="status"></a> `status` | `"OK"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:117](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L117) |
| <a id="timeout"></a> `timeout` | `number` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:120](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L120) |
| <a id="userverification"></a> `userVerification` | [`UserVerification`](#userverification-1) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:121](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L121) |
| <a id="webauthngeneratedoptionsid"></a> `webauthnGeneratedOptionsId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:118](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L118) |

***

### CredentialPayload

```ts
type CredentialPayload = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:68](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L68)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authenticatorattachment"></a> `authenticatorAttachment` | `"platform"` \| `"cross-platform"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:77](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L77) |
| <a id="clientextensionresults"></a> `clientExtensionResults` | `any` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:78](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L78) |
| <a id="id"></a> `id` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:69](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L69) |
| <a id="rawid"></a> `rawId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:70](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L70) |
| <a id="response"></a> `response` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:71](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L71) |
| `response.attestationObject` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:73](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L73) |
| `response.clientDataJSON` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:72](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L72) |
| `response.transports?` | (`"ble"` \| `"cable"` \| `"hybrid"` \| `"internal"` \| `"nfc"` \| `"smart-card"` \| `"usb"`)[] | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L74) |
| `response.userHandle` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:75](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L75) |
| <a id="type"></a> `type` | `"public-key"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:79](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L79) |

***

### InputType

```ts
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:57](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L57)

***

### NormalisedInputType

```ts
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L59)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:60](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L60) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:61](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L61) |

***

### PostAPIHookContext

```ts
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L43)

***

### PreAndPostAPIHookAction

```ts
type PreAndPostAPIHookAction = 
  | "REGISTER_OPTIONS"
  | "SIGN_IN_OPTIONS"
  | "SIGN_UP"
  | "SIGN_IN"
  | "EMAIL_EXISTS"
  | "GENERATE_RECOVER_ACCOUNT_TOKEN"
  | "RECOVER_ACCOUNT"
  | "LIST_CREDENTIALS"
  | "REMOVE_CREDENTIAL"
  | "REGISTER_CREDENTIAL";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L30)

***

### PreAPIHookContext

```ts
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:42](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L42)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:125](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L125)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authenticatecredential"></a> `authenticateCredential` | (`input`) => `Promise`\< \| \{ `authenticationResponse`: `AuthenticationResponseJSON`; `status`: `"OK"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_AUTHENTICATE_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:251](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L251) |
| <a id="authenticatecredentialwithsignin"></a> `authenticateCredentialWithSignIn` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_NOT_ALLOWED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_AUTHENTICATE_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:293](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L293) |
| <a id="createandregistercredentialforsessionuser"></a> `createAndRegisterCredentialForSessionUser` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `reason?`: `string`; `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`; \} \| \{ `err`: `string`; `status`: `"INVALID_EMAIL_ERROR"`; \} \| \{ `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `reason?`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:338](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L338) |
| <a id="createcredential"></a> `createCredential` | (`input`) => `Promise`\< \| \{ `registrationResponse`: `RegistrationResponseJSON`; `status`: `"OK"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:239](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L239) |
| <a id="doesbrowsersupportwebauthn"></a> `doesBrowserSupportWebAuthn` | (`input`) => `Promise`\< \| \{ `browserSupportsWebauthn`: `boolean`; `platformAuthenticatorIsAvailable`: `boolean`; `status`: `"OK"`; \} \| \{ `error`: `any`; `status`: `"ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:406](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L406) |
| <a id="generaterecoveraccounttoken"></a> `generateRecoverAccountToken` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"RECOVER_ACCOUNT_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:207](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L207) |
| <a id="getemailexists"></a> `getEmailExists` | (`input`) => `Promise`\< \| \{ `exists`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:199](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L199) |
| <a id="getregisteroptions"></a> `getRegisterOptions` | (`input`) => `Promise`\< \| [`RegistrationOptions`](#registrationoptions) \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `err`: `string`; `fetchResponse`: `Response`; `status`: `"INVALID_EMAIL_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:126](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L126) |
| <a id="getsigninoptions"></a> `getSignInOptions` | (`input`) => `Promise`\< \| [`AuthenticationOptions`](#authenticationoptions) \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:147](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L147) |
| <a id="listcredentials"></a> `listCredentials` | (`input`) => `Promise`\< \| \{ `credentials`: `object`[]; `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:359](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L359) |
| <a id="recoveraccount"></a> `recoverAccount` | (`input`) => `Promise`\< \| \{ `email`: `string`; `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:219](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L219) |
| <a id="registercredential"></a> `registerCredential` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `reason?`: `string`; `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason?`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:384](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L384) |
| <a id="registercredentialwithrecoveraccount"></a> `registerCredentialWithRecoverAccount` | (`input`) => `Promise`\< \| \{ `email`: `string`; `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:310](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L310) |
| <a id="registercredentialwithsignup"></a> `registerCredentialWithSignUp` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `err`: `string`; `fetchResponse`: `Response`; `status`: `"INVALID_EMAIL_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_UP_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:262](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L262) |
| <a id="removecredential"></a> `removeCredential` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `status`: `"CREDENTIAL_NOT_FOUND_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:372](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L372) |
| <a id="signin"></a> `signIn` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:179](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L179) |
| <a id="signup"></a> `signUp` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_UP_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:155](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L155) |

***

### RegistrationOptions

```ts
type RegistrationOptions = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:82](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L82)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="attestation"></a> `attestation` | `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:103](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L103) |
| <a id="authenticatorselection"></a> `authenticatorSelection` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:108](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L108) |
| `authenticatorSelection.requireResidentKey` | `boolean` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:109](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L109) |
| `authenticatorSelection.residentKey` | [`ResidentKey`](#residentkey) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:110](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L110) |
| `authenticatorSelection.userVerification` | [`UserVerification`](#userverification-1) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:111](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L111) |
| <a id="challenge-1"></a> `challenge` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:96](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L96) |
| <a id="createdat"></a> `createdAt` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:85](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L85) |
| <a id="excludecredentials"></a> `excludeCredentials` | `object`[] | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:98](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L98) |
| <a id="expiresat"></a> `expiresAt` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:86](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L86) |
| <a id="fetchresponse-1"></a> `fetchResponse` | `Response` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L113) |
| <a id="pubkeycredparams"></a> `pubKeyCredParams` | `object`[] | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:104](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L104) |
| <a id="rp"></a> `rp` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:87](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L87) |
| `rp.id` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:88](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L88) |
| `rp.name` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:89](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L89) |
| <a id="status-1"></a> `status` | `"OK"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:83](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L83) |
| <a id="timeout-1"></a> `timeout` | `number` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:97](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L97) |
| <a id="user"></a> `user` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:91](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L91) |
| `user.displayName` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:94](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L94) |
| `user.id` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:92](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L92) |
| `user.name` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:93](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L93) |
| <a id="webauthngeneratedoptionsid-1"></a> `webauthnGeneratedOptionsId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:84](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L84) |

***

### ResidentKey

```ts
type ResidentKey = "required" | "preferred" | "discouraged";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L45)

***

### UserInput

```ts
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L48)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L49) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:50](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L50) |

***

### UserVerification

```ts
type UserVerification = "required" | "preferred" | "discouraged";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L46)

# References - Frontend SDKs - Javascript SDK Reference -  WebAuthn
Source: https://supertokens.com/docs/references/frontend-sdks/supertokens-web-js/recipe-webauthn

## Classes

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L30)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### authenticateCredential()

```ts
static authenticateCredential(input): Promise<
  | {
  authenticationResponse: AuthenticationResponseJSON;
  status: "OK";
}
  | {
  error: any;
  status: "FAILED_TO_AUTHENTICATE_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:352](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L352)

Authenticate the credential with the passed options by using native webauthn functions.

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `authenticationOptions`: `Omit`\<[`AuthenticationOptions`](recipe-webauthn-types.mdx#authenticationoptions), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.authenticationOptions` | `Omit`\<[`AuthenticationOptions`](recipe-webauthn-types.mdx#authenticationoptions), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| \{
  `authenticationResponse`: `AuthenticationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_AUTHENTICATE_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along with authentication response received

##### authenticateCredentialWithSignIn()

```ts
static authenticateCredentialWithSignIn(input): Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}
  | {
  error: any;
  status: "FAILED_TO_AUTHENTICATE_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:433](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L433)

Authenticate the user and sign them in after verifying their identity.

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_AUTHENTICATE_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

##### createAndRegisterCredentialForSessionUser()

```ts
static createAndRegisterCredentialForSessionUser(input): Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  reason?: string;
  status: "REGISTER_CREDENTIAL_NOT_ALLOWED";
}
  | {
  err: string;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  reason?: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:526](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L526)

Register the new device with the passed user details

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `recipeUserId`: `string`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`;
\}
  \| \{
  `err`: `string`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful

##### createCredential()

```ts
static createCredential(input): Promise<
  | {
  registrationResponse: RegistrationResponseJSON;
  status: "OK";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:328](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L328)

Creates the credential with the passed options by using native webauthn functions.

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `registrationOptions`: `Omit`\<[`RegistrationOptions`](recipe-webauthn-types.mdx#registrationoptions), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.registrationOptions` | `Omit`\<[`RegistrationOptions`](recipe-webauthn-types.mdx#registrationoptions), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| \{
  `registrationResponse`: `RegistrationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along with registration response received

##### doesBrowserSupportWebAuthn()

```ts
static doesBrowserSupportWebAuthn(input): Promise<
  | {
  browserSupportsWebauthn: boolean;
  platformAuthenticatorIsAvailable: boolean;
  status: "OK";
}
  | {
  error: any;
  status: "ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:633](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L633)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: `any`; \} |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| \{
  `browserSupportsWebauthn`: `boolean`;
  `platformAuthenticatorIsAvailable`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"ERROR"`;
\}\>

##### generateRecoverAccountToken()

```ts
static generateRecoverAccountToken(input): Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "RECOVER_ACCOUNT_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:260](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L260)

Generate and send a recover account token.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"RECOVER_ACCOUNT_NOT_ALLOWED"`;
\}\>

`{ status: "OK", ...}` if successful

##### getEmailExists()

```ts
static getEmailExists(input): Promise<
  | GeneralErrorResponse
  | {
  exists: boolean;
  fetchResponse: Response;
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:235](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L235)

Checks whether there is an webauthn user with the passed email.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `exists`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful along with a boolean indicating existence

##### getRegisterOptions()

```ts
static getRegisterOptions(input): Promise<
  | {
  attestation: "none" | "indirect" | "direct" | "enterprise";
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: string;
  excludeCredentials: object[];
  expiresAt: string;
  fetchResponse: Response;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  err: string;
  fetchResponse: Response;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L49)

Registers a new device based on the passed options and returns the
challenge to be fulfilled in order for successful addition of the identity.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `email`: `string`; \} \| \{ `recoverAccountToken`: `string`; \} |

###### Returns

`Promise`\<
  \| \{
  `attestation`: `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"`;
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: [`ResidentKey`](recipe-webauthn-types.mdx#residentkey);
     `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification-1);
  \};
  `challenge`: `string`;
  `createdAt`: `string`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `string`;
  `fetchResponse`: `Response`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `err`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the created webauthn details (challenge, etc.)

##### getSignInOptions()

```ts
static getSignInOptions(input): Promise<
  | GeneralErrorResponse
  | {
  challenge: string;
  fetchResponse: Response;
  status: "OK";
  timeout: number;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:120](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L120)

Returns details about how the authenticator to should verify that a signin
is correct.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `challenge`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification-1);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the webauthn options (challenge, etc.)

##### init()

```ts
static init(config?): CreateRecipeFunction<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:31](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-webauthn-types.mdx#userinput) |

###### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-webauthn-types.mdx#preandpostapihookaction)\>

##### listCredentials()

```ts
static listCredentials(input): Promise<
  | GeneralErrorResponse
  | {
  credentials: object[];
  status: "OK";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:560](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L560)

List the credentials for the user

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `credentials`: `object`[];
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful along with a list of the user's credentials

##### recoverAccount()

```ts
static recoverAccount(input): Promise<
  | GeneralErrorResponse
  | {
  email: string;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:293](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L293)

Recover the account using the token received in email.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `token`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.token` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `email`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

##### registerCredential()

```ts
static registerCredential(input): Promise<
  | GeneralErrorResponse
  | {
  status: "OK";
}
  | {
  reason?: string;
  status: "REGISTER_CREDENTIAL_NOT_ALLOWED";
}
  | {
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  reason?: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:615](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L615)

Register the new device with the passed user details

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `recipeUserId`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`;
\}
  \| \{
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

##### registerCredentialWithRecoverAccount()

```ts
static registerCredentialWithRecoverAccount(input): Promise<
  | GeneralErrorResponse
  | {
  email: string;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_GENERATED_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:476](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L476)

Register the new device and recover the user's account with the recover token.

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `recoverAccountToken`: `string`; `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.recoverAccountToken` | `string` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `email`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_GENERATED_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

##### registerCredentialWithSignUp()

```ts
static registerCredentialWithSignUp(input): Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  err: string;
  fetchResponse: Response;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_GENERATED_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  fetchResponse: Response;
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:379](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L379)

Register the new device and signup the user with the passed email ID.

It uses `@simplewebauthn/browser` to make the webauthn calls.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `err`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_GENERATED_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

##### removeCredential()

```ts
static removeCredential(input): Promise<
  | GeneralErrorResponse
  | {
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "CREDENTIAL_NOT_FOUND_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:587](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L587)

Remove the credential for the passed credential ID

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; `webauthnCredentialId`: `string`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |
| `input.webauthnCredentialId` | `string` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"CREDENTIAL_NOT_FOUND_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

##### signIn()

```ts
static signIn(input): Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:198](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L198)

Sign in with the credential and the generated options ID.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `AuthenticationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `AuthenticationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.)

##### signUp()

```ts
static signUp(input): Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  fetchResponse: Response;
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:155](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L155)

Signup to ST with the webauthn options ID and the credential received from the
device.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.)

## Variables

### authenticateCredential()

```ts
const authenticateCredential: (input) => Promise<
  | {
  authenticationResponse: AuthenticationResponseJSON;
  status: "OK";
}
  | {
  error: any;
  status: "FAILED_TO_AUTHENTICATE_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = RecipeWrapper.authenticateCredential;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:660](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L660)

Authenticate the credential with the passed options by using native webauthn functions.

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `authenticationOptions`: `Omit`\<[`AuthenticationOptions`](recipe-webauthn-types.mdx#authenticationoptions), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.authenticationOptions` | `Omit`\<[`AuthenticationOptions`](recipe-webauthn-types.mdx#authenticationoptions), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| \{
  `authenticationResponse`: `AuthenticationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_AUTHENTICATE_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along with authentication response received

***

### authenticateCredentialWithSignIn()

```ts
const authenticateCredentialWithSignIn: (input) => Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}
  | {
  error: any;
  status: "FAILED_TO_AUTHENTICATE_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = RecipeWrapper.authenticateCredentialWithSignIn;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:657](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L657)

Authenticate the user and sign them in after verifying their identity.

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_AUTHENTICATE_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

***

### createAndRegisterCredentialForSessionUser()

```ts
const createAndRegisterCredentialForSessionUser: (input) => Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  reason?: string;
  status: "REGISTER_CREDENTIAL_NOT_ALLOWED";
}
  | {
  err: string;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  reason?: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = RecipeWrapper.createAndRegisterCredentialForSessionUser;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:665](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L665)

Register the new device with the passed user details

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `recipeUserId`: `string`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`;
\}
  \| \{
  `err`: `string`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful

***

### createCredential()

```ts
const createCredential: (input) => Promise<
  | {
  registrationResponse: RegistrationResponseJSON;
  status: "OK";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = RecipeWrapper.createCredential;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:659](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L659)

Creates the credential with the passed options by using native webauthn functions.

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `registrationOptions`: `Omit`\<[`RegistrationOptions`](recipe-webauthn-types.mdx#registrationoptions), `"fetchResponse"` \| `"status"`\>; `userContext`: `any`; \} |
| `input.registrationOptions` | `Omit`\<[`RegistrationOptions`](recipe-webauthn-types.mdx#registrationoptions), `"fetchResponse"` \| `"status"`\> |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| \{
  `registrationResponse`: `RegistrationResponseJSON`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along with registration response received

***

### doesBrowserSupportWebAuthn()

```ts
const doesBrowserSupportWebAuthn: (input) => Promise<
  | {
  browserSupportsWebauthn: boolean;
  platformAuthenticatorIsAvailable: boolean;
  status: "OK";
}
  | {
  error: any;
  status: "ERROR";
}> = RecipeWrapper.doesBrowserSupportWebAuthn;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:661](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L661)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: `any`; \} |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| \{
  `browserSupportsWebauthn`: `boolean`;
  `platformAuthenticatorIsAvailable`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"ERROR"`;
\}\>

***

### generateRecoverAccountToken()

```ts
const generateRecoverAccountToken: (input) => Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "RECOVER_ACCOUNT_NOT_ALLOWED";
}> = RecipeWrapper.generateRecoverAccountToken;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:654](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L654)

Generate and send a recover account token.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"RECOVER_ACCOUNT_NOT_ALLOWED"`;
\}\>

`{ status: "OK", ...}` if successful

***

### getEmailExists()

```ts
const getEmailExists: (input) => Promise<
  | GeneralErrorResponse
  | {
  exists: boolean;
  fetchResponse: Response;
  status: "OK";
}> = RecipeWrapper.getEmailExists;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:653](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L653)

Checks whether there is an webauthn user with the passed email.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `exists`: `boolean`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful along with a boolean indicating existence

***

### getRegisterOptions()

```ts
const getRegisterOptions: (input) => Promise<
  | {
  attestation: "none" | "indirect" | "direct" | "enterprise";
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: string;
  excludeCredentials: object[];
  expiresAt: string;
  fetchResponse: Response;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  err: string;
  fetchResponse: Response;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}> = RecipeWrapper.getRegisterOptions;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:649](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L649)

Registers a new device based on the passed options and returns the
challenge to be fulfilled in order for successful addition of the identity.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `email`: `string`; \} \| \{ `recoverAccountToken`: `string`; \} |

#### Returns

`Promise`\<
  \| \{
  `attestation`: `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"`;
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: [`ResidentKey`](recipe-webauthn-types.mdx#residentkey);
     `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification-1);
  \};
  `challenge`: `string`;
  `createdAt`: `string`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `string`;
  `fetchResponse`: `Response`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `err`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the created webauthn details (challenge, etc.)

***

### getSignInOptions()

```ts
const getSignInOptions: (input) => Promise<
  | GeneralErrorResponse
  | {
  challenge: string;
  fetchResponse: Response;
  status: "OK";
  timeout: number;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}> = RecipeWrapper.getSignInOptions;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:650](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L650)

Returns details about how the authenticator to should verify that a signin
is correct.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `challenge`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification-1);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the webauthn options (challenge, etc.)

***

### init()

```ts
const init: (config?) => CreateRecipeFunction<PreAndPostAPIHookAction> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:648](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L648)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-webauthn-types.mdx#userinput) |

#### Returns

[`CreateRecipeFunction`](types.mdx#createrecipefunction)\<[`PreAndPostAPIHookAction`](recipe-webauthn-types.mdx#preandpostapihookaction)\>

***

### listCredentials()

```ts
const listCredentials: (input) => Promise<
  | GeneralErrorResponse
  | {
  credentials: object[];
  status: "OK";
}> = RecipeWrapper.listCredentials;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:662](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L662)

List the credentials for the user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `credentials`: `object`[];
  `status`: `"OK"`;
\}\>

`{ status: "OK", ...}` if successful along with a list of the user's credentials

***

### recoverAccount()

```ts
const recoverAccount: (input) => Promise<
  | GeneralErrorResponse
  | {
  email: string;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}> = RecipeWrapper.recoverAccount;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:655](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L655)

Recover the account using the token received in email.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `token`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.token` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `email`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

***

### registerCredential()

```ts
const registerCredential: (input) => Promise<
  | GeneralErrorResponse
  | {
  status: "OK";
}
  | {
  reason?: string;
  status: "REGISTER_CREDENTIAL_NOT_ALLOWED";
}
  | {
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  reason?: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}> = RecipeWrapper.registerCredential;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:664](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L664)

Register the new device with the passed user details

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `recipeUserId`: `string`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.recipeUserId` | `string` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`;
\}
  \| \{
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `reason?`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

***

### registerCredentialWithRecoverAccount()

```ts
const registerCredentialWithRecoverAccount: (input) => Promise<
  | GeneralErrorResponse
  | {
  email: string;
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_GENERATED_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = RecipeWrapper.registerCredentialWithRecoverAccount;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:658](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L658)

Register the new device and recover the user's account with the recover token.

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `recoverAccountToken`: `string`; `userContext`: `any`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.recoverAccountToken` | `string` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `email`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_GENERATED_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

***

### registerCredentialWithSignUp()

```ts
const registerCredentialWithSignUp: (input) => Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  err: string;
  fetchResponse: Response;
  status: "INVALID_EMAIL_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_GENERATED_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  fetchResponse: Response;
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  status: "AUTHENTICATOR_ALREADY_REGISTERED";
}
  | {
  error: any;
  status: "FAILED_TO_REGISTER_USER";
}
  | {
  error: any;
  status: "WEBAUTHN_NOT_SUPPORTED";
}> = RecipeWrapper.registerCredentialWithSignUp;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:656](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L656)

Register the new device and signup the user with the passed email ID.

It uses `@simplewebauthn/browser` to make the webauthn calls.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; \} |
| `input.email` | `string` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `err`: `string`;
  `fetchResponse`: `Response`;
  `status`: `"INVALID_EMAIL_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_GENERATED_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"FAILED_TO_REGISTER_USER"`;
\}
  \| \{
  `error`: `any`;
  `status`: `"WEBAUTHN_NOT_SUPPORTED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email

***

### removeCredential()

```ts
const removeCredential: (input) => Promise<
  | GeneralErrorResponse
  | {
  status: "OK";
}
  | {
  fetchResponse: Response;
  status: "CREDENTIAL_NOT_FOUND_ERROR";
}> = RecipeWrapper.removeCredential;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:663](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L663)

Remove the credential for the passed credential ID

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `userContext`: `any`; `webauthnCredentialId`: `string`; \} |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.userContext` | `any` |
| `input.webauthnCredentialId` | `string` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"CREDENTIAL_NOT_FOUND_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful

***

### signIn()

```ts
const signIn: (input) => Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_IN_NOT_ALLOWED";
}> = RecipeWrapper.signIn;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:652](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L652)

Sign in with the credential and the generated options ID.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `AuthenticationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `AuthenticationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_IN_NOT_ALLOWED"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.)

***

### signUp()

```ts
const signUp: (input) => Promise<
  | GeneralErrorResponse
  | {
  fetchResponse: Response;
  status: "OK";
  user: User;
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "SIGN_UP_NOT_ALLOWED";
}
  | {
  fetchResponse: Response;
  status: "INVALID_CREDENTIALS_ERROR";
}
  | {
  fetchResponse: Response;
  status: "OPTIONS_NOT_FOUND_ERROR";
}
  | {
  fetchResponse: Response;
  status: "INVALID_OPTIONS_ERROR";
}
  | {
  fetchResponse: Response;
  reason: string;
  status: "INVALID_AUTHENTICATOR_ERROR";
}
  | {
  fetchResponse: Response;
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}> = RecipeWrapper.signUp;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/index.ts:651](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/index.ts#L651)

Signup to ST with the webauthn options ID and the credential received from the
device.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: `RegistrationResponseJSON`; `options?`: [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions); `shouldTryLinkingWithSessionUser?`: `boolean`; `userContext`: `any`; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | `RegistrationResponseJSON` |
| `input.options?` | [`RecipeFunctionOptions`](recipe-emailpassword.mdx#recipefunctionoptions) |
| `input.shouldTryLinkingWithSessionUser?` | `boolean` |
| `input.userContext` | `any` |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"SIGN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_CREDENTIALS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"OPTIONS_NOT_FOUND_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"INVALID_OPTIONS_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `reason`: `string`;
  `status`: `"INVALID_AUTHENTICATOR_ERROR"`;
\}
  \| \{
  `fetchResponse`: `Response`;
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}\>

`{ status: "OK", ...}` if successful along a description of the user details (id, etc.)

## References

### RecipeInterface

Re-exports [RecipeInterface](recipe-webauthn-types.mdx#recipeinterface)

# References - Backend SDKs -  Backend SDKs
Source: https://supertokens.com/docs/references/backend-sdks/reference

## Overview

SuperTokens has support for Node.js, Python, and Golang through its backend SDKs.
Use this page to find references to each of them and about specific functionalities.

## Customization

<ReferenceCard.Grid>
  <ReferenceCard href="https://supertokens.com/docs/auth-react">
    <ReferenceCard.Title>
      Function overrides
    </ReferenceCard.Title>
  </ReferenceCard>
  <ReferenceCard href="https://supertokens.com/docs/auth-react">
    <ReferenceCard.Title>
      API overrides
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/auth-react">
    <ReferenceCard.Title>
      Hooks
    </ReferenceCard.Title>
  </ReferenceCard>

</ReferenceCard.Grid>

## SDK references

<ReferenceCard.Grid>
  <ReferenceCard href="https://supertokens.com/docs/nodejs">
    <ReferenceCard.Avatar icon="node" />
    <ReferenceCard.Title>
      NodeJS
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/golang">
    <ReferenceCard.Avatar icon="go" />
    <ReferenceCard.Title>
      GoLang
    </ReferenceCard.Title>
  </ReferenceCard>

  <ReferenceCard href="https://supertokens.com/docs/python">
    <ReferenceCard.Avatar icon="python" />
    <ReferenceCard.Title>
      Python
    </ReferenceCard.Title>
  </ReferenceCard>
</ReferenceCard.Grid>

## SDK configuration

The `appInfo` object is the paramter used to configure the SDKs during initialization.
```ts
let appInfo: {
    appName: string,
    apiDomain: string,
    websiteDomain?: string,
    websiteBasePath?: string,  
    origin?: ((input: { request?: Request; userContext: UserContext }) => string) | string,  
    apiBasePath?: string,  
    apiGatewayPath?: string 
}
```

<Accordion px="4" pb="4">

## `appName` 

This is the name of your application.
Use it when sending password reset or email verification emails (in the default email design).
An example of this is `appName: "GitHub"`.

<br/>

## `websiteDomain` 

This is the domain part of your website.
This is where the login UI appears.
For example:
- For local development, you are likely using `localhost` with some port (ex `8080`). Then the value of this should be `"http://localhost:8080"`.
- If your website is `https://www.example.com`, then the value of this should be `"https://www.example.com"`.
- If your website is `https://example.com`, then the value of this should be `"https://example.com"`.
- If you have multiple sub domains, and your users login via `https://auth.example.com`, then the value of this should be `"https://auth.example.com"`.

By default, the login UI appears on `{websiteDomain}/auth/*`. You can change this by using the `websiteBasePath` configuration.

On the frontend, you need the domain for routing purposes, and on the backend, it generates correct email verification and password reset links.

<br/>

## `apiDomain` 

This is the domain part of your API endpoint that the frontend talks to. For example:
- For local development, you are likely using `localhost` with some port (ex `9000`). Then the value of this should be `"http://localhost:9000"`.
- If your frontend queries `https://api.example.com/*`, then the value of this should be `"https://api.example.com"`
- If your API endpoint reaches `/api/*`, then the value of this is the same as the `websiteDomain` - since `/api/*` is equal to querying `{websiteDomain}/api/*`.

By default, the login widgets query `{apiDomain}/auth/*`. You can change this by using the `apiBasePath` configuration.

<br/>

## `websiteBasePath` 

By default, the login UI appears on `{websiteDomain}/auth`. Other authentication-related user interfaces appear on `{websiteDomain}/auth/*`.

If you want to change the `/auth` to something else, then you must set this value. For example:
- If you want the login UI to show on `{websiteDomain}/user/*`, then the value of this should be `"/user"`.
- If you are using a dedicated sub domain for auth, like `https://auth.example.com`, then you probably want the login UI to show up on `https://auth.example.com`. In this case, set this value to `"/"`.

:::important
Remember to set the same value for this parameter on the backend and the frontend.
:::

<br/>

## `origin`

Can be used instead of `websiteDomain` to handle multiple frontend domains within the same SuperTokens instance.
The property accepts a function that receives the original request as an input and should return a valid domain.
Make sure to whitelist all the domains during CORS configuration.

<br/>

## `apiBasePath` 

By default, the frontend SDK queries `{apiDomain}/auth/*`.

If you want to change the `/auth` to something else, then you must set this value. For example:
- If you have versioning in your API path and want to query `{apiDomain}/v0/auth/*`, then the value of this should be `"/v0/auth"`.
- If you want to scope the APIs not via `/auth` but via some other string like `/supertokens`, then you can set the value of this to `"/supertokens"`. This means, the APIs appear on `{apiDomain}/supertokens/*`.
- If you do not want to scope the APIs at all, then you can set the values of this to be `"/"`. This means the APIs are available on `{apiDomain}/*`

:::important
Remember to set the same value for this parameter on the backend and the frontend.
:::

:::caution
Note that setting a custom `apiBasePath` updates the refresh API path, this can cause an issue where previously issued refresh tokens no longer get sent to the new API endpoint and the user logs out.
For example, the default `apiBasePath` value is `/auth`, if it changes to `/supertokens`, then your refresh endpoint updates from `/auth/session/refresh` to `/supertokens/session/refresh`.
Previously issued refresh tokens do not get sent to the new API endpoint and the user logs out.
:::

<br/>

## `apiGatewayPath` 

:::note
Most relevant if you are using an API gateway or reverse proxy
:::

If you are using an API gateway (like the one provided by AWS) or a reverse proxy (like Nginx), it may add a path to your API endpoints to scope them for different development environments.
For example, your APIs for development appear via `{apiDomain}/dev/*`, and for production, they may appear via `{apiDomain}/prod/*`.

Whilst the frontend would need to use the `/dev/` and `/prod/`, your backend code would not see that sub path (that is `/dev/` and `/prod/` because the gateway removes them). 

For these situations, you should set the `apiGatewayPath` to `/dev` or `/prod`. For example:
- If your API gateway is using `/development` for scoping, and you want to expose the SuperTokens APIs on `/supertokens/*`, then set `apiGatewayPath: "/development"` & `apiBasePath: "/supertokens"`.
This means that the frontend SDK queries `{apiDomain}/development/supertokens/*` to reach the endpoints exposed by the service.
- If you set this and not `apiBasePath`, then the frontend SDK queries `{apiDomain}{apiGatewayPath}/auth/*` to reach the endpoints exposed by the service.

The reason for this distinction between `apiGatewayPath` and `apiBasePath` is that when routing, the backend SDK does not see the `apiGatewayPath` path from the request because the gateway removes them.
Taking the above example, whilst the frontend queries `{apiDomain}/development/supertokens/*`, the backend SDK sees `{apiDomain}/supertokens/*`.

<br/>

</Accordion>

# References - Backend SDKs -  Function overrides
Source: https://supertokens.com/docs/references/backend-sdks/function-overrides

## Overview

**Function overrides** let you customize the behavior of the functions used internally, by the SDKs.
You can change how actions like signing in, signing up, creating, or revoking sessions or signing out work.
This flexibility lets you integrate your own logic into the authentication and session management processes.

For example, if a recipe checks for an active session using the session recipe's `doesSessionExist` function, you can override that function to work with custom session management.
Similarly, if you already have a sign-in/sign-up flow and want to integrate with SuperTokens, you can use an override to handle the migration process.
You can even implement a custom `userId` format by mapping `userIds` to those generated by SuperTokens.

## Example

The code snippet shows the general flow of overriding a function. 
Custom logic can be injected while also calling the original implementation of the function.

<Tabs>
<Tab value="nodejs">

:::info
See all the [functions that can be overridden here](https://supertokens.com/docs/nodejs/modules/recipe_thirdparty.html#RecipeInterface)
:::

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        Session.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // here we are only overriding the function that's responsible
                        // for creating a new session
                        createNewSession: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return await originalImplementation.createNewSession(input);
                        },
                        // ...
                        // TODO: override more functions
                    }
                }
            }
            // highlight-end
        }),
        ThirdParty.init({
            signInAndUpFeature: {
                providers: [/* ... */]
            },
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // here we are only overriding the function that's responsible
                        // for signing in or signing up a user.
                        signInUp: async function (input) {
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return await originalImplementation.signInUp(input);
                        },
                        // ...
                        // TODO: override more functions
                    }
                }
            }
            // highlight-end
        })
    ]
});
```

</Tab>
<Tab value="go">

:::info
See all the [functions that can be overridden here](https://pkg.go.dev/github.com/supertokens/supertokens-golang/recipe/thirdparty/tpmodels#RecipeInterface)
:::

```go

### Raise the error

<Tabs>
<Tab value="nodejs">

```ts

Session.init({
    override: {
        functions: (originalImplementation) => {
            return {
                ...originalImplementation,
                createNewSession: async function (input) {
                    //highlight-start
                    const existingSessions = await Session.getAllSessionHandlesForUser(input.userId);
                    if (existingSessions.length > 0) {
                        // this means that the user already has a session on some other device
                        throw new Error("Session already exists on another device");
                    }

                    // no other session exists, and so we can continue with logging in this user
                    return originalImplementation.createNewSession(input);
                    //highlight-end
                }
            }
        }
    }
})
```

</Tab>
<Tab value="go">

```go

let app = express();

//...

// in your app's error handler, we catch the custom error
app.use((err: any, req: express.Request, res: express.Response, next: express.NextFunction) => {
    if (err.message === "Session already exists on another device") {
        // TODO: send a custom response using res
        return;
    }
    res.send(500).send(err.message)
})
```

</Tab>
<Tab value="hapi">

```ts
let server = new Hapi.Server({ port: 8000 });

// first we create a plugin to handle all errors from the app
const plugin = {
    name: "...",
    version: "...",
    register: async function (server: Hapi.Server) {
        server.ext("onPreResponse", async (request, h) => {
            if ("isBoom" in request.response) {
                let err = request.response.data;
                if (err.message === "Session already exists on another device") {
                    // TODO: send a custom response here with takeover
                }
            }
            return h.continue;
        });
    },
};

// then we register this plugin
(async () => {
    await server.register(plugin);

    await server.start();
})();
```
</Tab>
<Tab value="fastify">

```tsx

let fastify = Fastify();

fastify.setErrorHandler(async (err: any, req, res) => {
    if (err.message === "Session already exists on another device") {
        // TODO: send a custom response here with takeover
    }
    // TODO: send a 500 error with the err.message
});
```

</Tab>
<Tab value="awsLambda">

```ts
// this is in the auth.js file
// @ts-ignore

module.exports.handler = middy(middleware()).use(cors({
    origin: getBackendConfig().appInfo.websiteDomain,
    credentials: true,
    headers: ["Content-Type", ...SuperTokens.getAllCORSHeaders()].join(", "),
    methods: "OPTIONS,POST,GET,PUT,DELETE"
})).onError(request => {
    if (request.error !== null && request.error.message === "Session already exists on another device") {
        // TODO: send a custom response here with takeover
    }
    throw request.error;
});
```

</Tab>
<Tab value="koa">

```ts

let app = new Koa();

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err: any) {
    if (err.message === "Session already exists on another device") {
      // TODO: return a custom response
    }
    throw err;
  }
})

app.use(middleware());
```

</Tab>
<Tab value="loopback">

```ts

let app = new RestApplication();

export const customErrorMiddleware: Middleware = async (ctx: MiddlewareContext, next: Next) => {
  try {
    return await next();
  } catch (err: any) {
    if (err.message === "Session already exists on another device") {
      // TODO: return a custom response
    }
    throw err;
  }
};

app.middleware(middleware);
app.middleware(customErrorMiddleware);
```

</Tab>
<Tab value="nextjs">

<Tabs.HeaderCustomActions>
  <NextjsRouterTypeSelect />
</Tabs.HeaderCustomActions>

<ConditionalContent propertyName="nextjsRouterType" condition="pages-router">

```ts

// in the /auth/[[...path]].tsx file
export default async function superTokens(req: any, res: any) {
    //...
    try {
        await superTokensNextWrapper(
            async (next) => {
                // Refer to the Next.js integration guide to know why this is needed
                res.setHeader(
                    "Cache-Control",
                    "no-cache, no-store, max-age=0, must-revalidate"
                );
                await middleware()(req, res, next)
            },
            req,
            res
        )
    } catch (err: any) {
        if (err.message === "Session already exists on another device") {
            // TODO: send custom reply
        }
        throw err;
    }

    //...
}
```

</ConditionalContent>
<ConditionalContent propertyName="nextjsRouterType" condition="app-router">

```ts
// @ts-ignore

SuperTokens.init(backendConfig());

// in the app/api/auth/[...path]/route.ts file
const handleCall = getAppDirRequestHandler();

const withCustomErrorHandling = async (request: NextRequest) => {
    try {
        return await handleCall(request);
    } catch (err: any) {
        if (err.message === "Session already exists on another device") {
            // TODO: send custom reply
        }
        throw err;
    }
};

export async function GET(request: NextRequest) {
    const res = await withCustomErrorHandling(request);
    if (!res.headers.has("Cache-Control")) {
        // Refer to the Next.js integration guide to know why this is needed
        res.headers.set("Cache-Control", "no-cache, no-store, max-age=0, must-revalidate");
    }
    return res;
}

export const POST = withCustomErrorHandling;
export const DELETE = withCustomErrorHandling;
export const PUT = withCustomErrorHandling;
export const PATCH = withCustomErrorHandling;
export const HEAD = withCustomErrorHandling;
```

</ConditionalContent>
</Tab>
<Tab value="nestjs">

```tsx

// we want to add our own error handler which will catch the special exception

@Catch(STError)
export class AppErrorHandler implements ExceptionFilter {

  catch(exception: Error, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    if (exception.message === "Session already exists on another device") {
        // TODO: send custom error using ctx.getResponse<Response>()
    } else {
        throw exception;
    }
  }
}
```
</Tab>
</Tabs>
</Tab>
<Tab value="go">

```go

```tsx

Session.init({
    override: {
        functions: (oI) => {
            return {
                ...oI,
                revokeSession: async (input) => {
                    // highlight-start
                    let customHeaderValue = "";
                    const request = SuperTokens.getRequestFromUserContext(input.userContext);

                    if (request !== undefined) {
                        //@ts-ignore
                        customHeaderValue = request.getHeaderValue("customHeader");
                    } else {
                        /**
                         * This is possible if the function is triggered from the user management dashboard
                         * 
                         * In this case set a reasonable default value to use
                         */
                        customHeaderValue = "default";
                    }

                    // highlight-end

                    // Perform custom logic based on the value of customHeaderValue

                    return oI.revokeSession(input);
                },
            };
        },
    },
})
```

</Tab>
<Tab value="go">

We use the `GetRequestFromUserContext` function provided by the SDK to get the request object from the user context.

```go
                        * 
                        * In this case set a reasonable default value to use
                        */
                        customHeadervalue = "default";
                    }
                    // highlight-end

                    print(customHeadervalue)

                    // Perform custom logic based on the value of customHeadervalue

                    return originalRevokeSession(sessionHandle, userContext)
                }

                return originalImplementation
            },
        },
    })
}
```

</Tab>
<Tab value="python">

We use the `get_request_from_user_context` function provided by the SDK to get the request object from the user context.

```python
from typing import Any, Dict

from supertokens_python import get_request_from_user_context
from supertokens_python.recipe import session
from supertokens_python.recipe.session.interfaces import RecipeInterface

def override_session_functions(original_implementation: RecipeInterface):
    original_revoke_session = original_implementation.revoke_session

    async def revoke_session(session_handle: str, user_context: Dict[str, Any]):
        # highlight-start
        request=get_request_from_user_context(user_context)
        customHeaderValue=""

        if request is not None:
            customHeaderValue=request.get_header("customHeader")
        else:
            #
            # This is possible if the function is triggered from the user management dashboard
            #
            # In this case set a reasonable default value to use
            #
            customHeaderValue="default"
        # highlight-end

        print(customHeaderValue)
        # Perform custom logic based on the value of customHeadervalue

        return await original_revoke_session(session_handle, user_context)

    original_implementation.revoke_session = revoke_session
    return original_implementation

session.init(
    override=session.InputOverrideConfig(
        functions=override_session_functions,
    ),
)
```

</Tab>
</Tabs>

# References - Backend SDKs -  APIs override
Source: https://supertokens.com/docs/references/backend-sdks/api-overrides

## Overview

Overriding APIs allows you to take full control of what happens when the frontend SDK calls the backend authentication endpoints.
You can send analytics events, synchronize additional information in the database, or adjust the request input.

---

## General example

Like with the [functions override](/docs/references/backend-sdks/function-overrides) feature, the original implementation reference must be called to avoid any errors in the authentication flow.

<Tabs>
<Tab value="nodejs">

```ts

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        Session.init({
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // only overriding the function that signs out a user
                        signOutPOST: async function (input) {

                            if (originalImplementation.signOutPOST === undefined) {
                                throw Error("Should never come here")
                            }
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return await originalImplementation.signOutPOST(input);
                        },
                        // ...
                        // TODO: override more apis
                    }
                }
            }
            // highlight-end
        }),
        EmailPassword.init({
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        emailExistsGET: async function (input) {

                            // highlight-start
                            // send a custom response like this:
                            input.options.res.setStatusCode(200); // or any other status code
                            input.options.res.sendJSONResponse({
                                message: "my custom response",
                                //...
                            })
                            // highlight-end

                            // this return doesn't matter. But we must do it
                            // cause the function signature expects a response.
                            return {
                                status: "OK",
                                exists: false
                            };
                        }
                    }
                }
            }
        })
    ]
});

```

</Tab>
<Tab value="go">

```go
              options.Res.WriteHeader(200)
              responseJson := map[string]interface{}{
                "message": "My custom response",
                // ...
              }

              bytes, _ := json.Marshal(responseJson)
              options.Res.Write(bytes)
              // highlight-end

              // this return doesn't matter. But we must do it
              // cause the function signature expects a response.
              return epmodels.EmailExistsGETResponse{
                OK: &struct{ Exists bool }{
                  Exists: false,
                },
              }, nil
            }

            return originalImplementation
          },
        },
      }),
		},
	})
}
```

</Tab>
<Tab value="python">

```python
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe.emailpassword.interfaces import APIOptions as EmailPasswordAPIOptions, EmailExistsGetOkResult, APIInterface as EmailPasswordAPIInterface
from supertokens_python.recipe.session.interfaces import APIOptions as SessionAPIOptions, APIInterface as SessionAPIInterface
from supertokens_python.recipe import emailpassword
from supertokens_python.recipe import session
from typing import Dict, Any

def override_emailpassword_apis(original_implementation: EmailPasswordAPIInterface):

    async def email_exists_get(email: str, tenant_id: str, api_options: EmailPasswordAPIOptions, user_context: Dict[str, Any]):

        # highlight-start
        # send custom response like this
        api_options.response.set_status_code(200)  # type: ignore
        json_dict = {'message': 'Custom response'}
        api_options.response.set_json_content(json_dict) # type: ignore
        # highlight-end

        # this return doesn't matter. But we must do it
        # cause the function signature expects a response.
        return EmailExistsGetOkResult(False)

    original_implementation.email_exists_get = email_exists_get
    return original_implementation

# highlight-start
def override_session_apis(original_implementation: SessionAPIInterface):
    original_signout_post = original_implementation.signout_post

    async def signout_post(
        session: session.SessionContainer,
        api_options: SessionAPIOptions,
        user_context: Dict[str, Any],
    ):
        # TODO: custom logic

        # or call the default behaviour as show below
        return await original_signout_post(session, api_options, user_context)

    original_implementation.signout_post = signout_post
    return original_implementation

# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        session.init(
            # highlight-start
            override=session.InputOverrideConfig(apis=override_session_apis)
            # highlight-end
        ),
        emailpassword.init(override=emailpassword.InputOverrideConfig(apis=override_emailpassword_apis))
    ],
)
```

</Tab>
</Tabs>

---

## Error management

If you want to send a custom error message from the API override function, you can send a `GENERAL_ERROR` response.

If you are using the pre-built UI, the response renders directly in the frontend UI.
For custom UI, you can read this response and display the message in an error UI.

The next example shows how to prevent the user from signing up unless their email is pre-approved by the application's admin.

<Tabs>
<Tab value="nodejs">

```ts

EmailPassword.init({
    override: {
        apis: (oI) => {
            return {
                ...oI,
                signUpPOST: async function (input) {
                    let email = input.formFields.find(i => i.id === "email")!.value as string;

                    if (emailNotAllowed(email)) {
                        // highlight-start
                        return {
                            status: "GENERAL_ERROR",
                            message: "You are not allowed to sign up. Please contact the app's admin to get permission"
                        }
                        // highlight-end
                    }
                    return oI.signUpPOST!(input);
                }
            }
        }
    }
})

function emailNotAllowed(email: string) {
    // TODO: your impl to check if email is allowed or not
    return true;
}
```

</Tab>
<Tab value="go">

```go

<Tabs
	isSubTab={true}
	groupId="node-80X-version"
	defaultValue="greater"
	values={[
		{ label: '>= v8.0.0', value: 'greater' },
		{ label: '< v8.0.0', value: 'lesser' },
	]}>
<TabItem value="greater">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signInPOST: undefined, // disable sign in with email & password
                        signUpPOST: undefined, // disable sign up with email & password
                    }
                }
            }
            // highlight-end
        }),
        ThirdParty.init({
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signInUpPOST: undefined // disable sign in & up with third party
                    }
                }
            }
            // highlight-end
        })
    ]
});
```

</TabItem>
<TabItem value="lesser">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            // highlight-start
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signInUpPOST: undefined
                    }
                }
            }
            // highlight-end
        })
    ]
});
```

</TabItem>
</Tabs>

</Tab>
<Tab value="go">

To disable an API entirely, all you need to do is override the API implementation with `nil`.

For example, if you want to disable the sign up / sign in API from this recipe, all you do is this:

```go

```python
from supertokens_python import init, InputAppInfo
from supertokens_python.recipe import thirdparty, emailpassword
from supertokens_python.recipe.thirdparty.interfaces import (
    APIInterface as ThirdPartyAPIInterface,
)
from supertokens_python.recipe.emailpassword.interfaces import (
    APIInterface as EmailPasswordAPIInterface,
)

# highlight-start
def thirdparty_apis_override(original_impl: ThirdPartyAPIInterface):
    # disable sign in & up with third party
    original_impl.disable_sign_in_up_post = True

    return original_impl
# highlight-end

# highlight-start
def emailpassword_apis_override(original_impl: EmailPasswordAPIInterface):
    # disable sign up with email & password
    original_impl.disable_sign_up_post = True

    # disable sign in with email & password
    original_impl.disable_sign_in_post = True
    return original_impl
# highlight-end

init(
    app_info=InputAppInfo(api_domain="...", app_name="...", website_domain="..."),
    framework="...",  # type: ignore
    recipe_list=[
        thirdparty.init(
            # highlight-start
            override=thirdparty.InputOverrideConfig(apis=thirdparty_apis_override),
            # highlight-end
        ),
        emailpassword.init(
            # highlight-start
            override=emailpassword.InputOverrideConfig(
                apis=emailpassword_apis_override
            ),
            # highlight-end
        ),
    ],
)
```

</Tab>
</Tabs>

:::info Important
You then need to define routes that handle this API call. You can see the [Frontend driver interface API spec here](/docs/references/fdi/introduction)
:::

---

## Read custom request information

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

The `getRequestFromUserContext` function provided by the SDK is used to get the request object from the user context.

```tsx

Session.init({
    override: {
        apis: (oI) => {
            return {
                ...oI,
                signOutPOST: async (input) => {
                    if (oI.signOutPOST === undefined) {
                        throw Error("Signout API is disabled");
                    }

                    // highlight-start
                    let customHeaderValue = "";
                    const request = SuperTokens.getRequestFromUserContext(input.userContext);

                    if (request !== undefined) {
                        //@ts-ignore
                        customHeaderValue = request.getHeaderValue("customHeader");
                    } else {
                        /**
                         * This is possible if the function is triggered from the user management dashboard
                         * 
                         * In this case set a reasonable default value to use
                         */
                        customHeaderValue = "default";
                    }

                    // highlight-end

                    // Perform custom logic based on the value of customHeaderValue

                    return oI.signOutPOST(input);
                },
            };
        }
    },
})
```

</Tab>
<Tab value="go">

The `GetRequestFromUserContext` function provided by the SDK is used to get the request object from the user context.

```go
                        * 
                        * In this case set a reasonable default value to use
                        */
                        customHeadervalue = "default";
                    }
                    // highlight-end

                    print(customHeadervalue)

                    // Perform custom logic based on the value of customHeadervalue

                    return originalSignOutPost(sessionContainer, options, userContext)
                }

                return originalImplementation
            },
        },
    })
}
```

</Tab>
<Tab value="python">

The `get_request_from_user_context` function provided by the SDK is used to get the request object from the user context.

```python
from supertokens_python import get_request_from_user_context
from supertokens_python.recipe import session
from supertokens_python.recipe.session.interfaces import APIInterface, APIOptions
from typing import Any, Dict

def override_session_apis(original_implementation: APIInterface):
    original_signout_post = original_implementation.signout_post

    async def signout_post(session: session.SessionContainer, api_options: APIOptions, user_context: Dict[str, Any]):
        # highlight-start
        request=get_request_from_user_context(user_context)
        customHeaderValue=""

        if request is not None:
            customHeaderValue=request.get_header("customHeader")
        else:
            #
            # This is possible if the function is triggered from the user management dashboard
            # 
            # In this case set a reasonable default value to use
            #
            customHeaderValue="default"
        # highlight-end
        
        print(customHeaderValue)
        # Perform custom logic based on the value of customHeadervalue

        return await original_signout_post(session, api_options, user_context)

    original_implementation.signout_post = signout_post
    return original_implementation

session.init(
    override=session.InputOverrideConfig(
        apis=override_session_apis
    ),
)
```

</Tab>
</Tabs>

# References - Backend SDKs -  User context
Source: https://supertokens.com/docs/references/backend-sdks/user-context

## Overview

The `UserContext` mechanism is a way to pass information across recipe or API functions to customize the authentication flow inside a specific *execution context*. 

By default, the user context passed to APIs and functions contains the request object that can read custom headers, body, or query parameters.

## Prerequisites

:::info Important
This feature is only available for SDKs versions:
- NodeJS >= `v9.0`
- Python >= `v0.5`
- GoLang >= `v0.5`
:::

## Example

For example, you may want to disable creation of a session during sign up, ensuring that the user has to login again post sign up.
To do that, the `create new session` recipe function must know that it's called from the sign up API and return an empty session.
This is as opposed to it invoking from the sign in API, when it should continue with normal functionality.

To achieve this, all the API interface and recipe interface functions take a parameter called `userContext`, which is by default an empty object.
When overriding the functions, anything can be added to this object, and that information carries onto the next set of functions called in the API.

<Tabs additionalValues={[{label: "Curl", value: "curl"}, {label: "Dashboard", value: "dashboard"}]}>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        EmailPassword.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signUp: async function (input) {
                            let resp = await originalImplementation.signUp(input);
                            if (resp.status === "OK" && resp.user.loginMethods.length === 1 && input.session === undefined) {
                                /*
                                 * This is called during the sign up API for email password login,
                                 * but before calling the createNewSession function.
                                 * We override the recipe function as shown here,
                                 * and then set the relevant context only if it's a new user.
                                 */
                                input.userContext.isSignUp = true;
                            }
                            return resp;
                        },
                    }
                },
            }
            // highlight-end
        }),
        ThirdParty.init({
            // highlight-start
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        signInUp: async function (input) {
                            let resp = await originalImplementation.signInUp(input);
                            if (resp.status === "OK" && resp.createdNewRecipeUser && resp.user.loginMethods.length === 1 && input.session === undefined) {
                                /*
                                 * This is called during the signInUp API for third party login,
                                 * but before calling the createNewSession function.
                                 * At the start of the API, we do not know if it will result in a 
                                 * sign in or a sign up, so we cannot override the API function.
                                 * Instead, we override the recipe function as shown here,
                                 * and then set the relevant context only if it's a new user.
                                 */
                                input.userContext.isSignUp = true;
                            }
                            return resp;
                        },
                    }
                },
            }
            // highlight-end
        })
    ]
});
```

</Tab>
<Tab value="go">

```go

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        ThirdParty.init({
            /* See previous step... */
        }),
        EmailPassword.init({
            /* See previous step... */
        }),
        Session.init({
            override: {
                functions: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        createNewSession: async function (input) {
                            if (input.userContext.isSignUp) {
                                /**
                                 * The execution will come here only in case
                                 * a sign up API is calling this function. This is because
                                 * only then will the input.userContext.isSignUp === true
                                 * (see above code).
                                 */
                                return { // this is an empty session. It won't result in a session being created for the user.
                                    getAccessToken: () => "",
                                    getAccessTokenPayload: () => null,
                                    getExpiry: async () => -1,
                                    getHandle: () => "",
                                    getSessionDataFromDatabase: async () => null,
                                    getTimeCreated: async () => -1,
                                    getUserId: () => "",
                                    revokeSession: async () => { },
                                    updateSessionDataInDatabase: async () => { },
                                    mergeIntoAccessTokenPayload: async () => { },
                                    assertClaims: async () => { },
                                    fetchAndSetClaim: async () => { },
                                    getClaimValue: async () => undefined,
                                    setClaimValue: async () => { },
                                    removeClaim: async () => { },
                                    attachToRequestResponse: () => { },
                                    getAllSessionTokensDangerously: () => ({
                                        accessAndFrontTokenUpdated: false,
                                        accessToken: "",
                                        frontToken: "",
                                        antiCsrfToken: undefined,
                                        refreshToken: undefined,
                                    }),
                                    getTenantId: () => "public",
                                    getRecipeUserId: () => SuperTokens.convertToRecipeUserId(""),
                                };
                            }
                            return originalImplementation.createNewSession(input);
                        }
                    }
                }
            }
        })
    ]
});
```

</Tab>
<Tab value="go">

```go

# References - Backend SDKs -  The user object
Source: https://supertokens.com/docs/references/backend-sdks/user-object

## Overview

The user object represents the entity that exposes user information during an authentication flow.

## Prerequisites

:::info Important
This is only applicable for NodeJS SDK >= 16.0 and for Python SDK >= 0.25.0. For other versions, or SDKs, please see: https://github.com/supertokens/core-driver-interface/wiki
:::

## Structure

### `User`

| Property | Type | Description |
|----------|------|-------------|
| `id` | `string` | The primary user ID. It can change if the user links to another user. |
| `timeJoined` | `number` | Time (in MS since epoch) when user first signed up. It does not update when new login methods appear. |
| `isPrimaryUser` | `boolean` | `true` if the user can accept other login methods from other users. Important for account linking. |
| `tenantIds` | `string[]` | List of tenantIds the user belongs to. Union of all login methods' tenantIds. |
| `emails` | `string[]` | List of all emails associated with this user. |
| `phoneNumbers` | `string[]` | List of all phone numbers associated with this user. |
| `thirdParty` | `ThirdParty` | List of third party provider information. See Third Party Properties table below. |
| `loginMethods` | `LoginMethod[]` | List of all login methods. See Login Method Properties table below. |

### `ThirdParty`

| Property | Type | Description |
|----------|------|-------------|
| `id` | `string` | Unique identifier for the third party provider (for example, "google") |
| `userId` | `string` | User ID from the third party provider |

### `LoginMethod`

| Property | Type | Description |
|----------|------|-------------|
| `recipeId` | `string` | ID representing the login method (for example, "email password", "third party", "passwordless") |
| `tenantIds` | `string[]` | List of tenantIds for this login method |
| `timeJoined` | `number` | Time (in MS since epoch) when user signed up with this method |
| `recipeUserId` | `RecipeUserId` | Recipe user ID for this login method |
| `verified` | `boolean` | `true` if email/phone verifies for this method |
| `email` | `string` | Email for this login method (undefined if not applicable) |
| `phoneNumber` | `string` | Phone number for this method (undefined if not applicable) |
| `thirdParty` | `ThirdParty` | Third party info for this method (undefined if not third party) |
| `hasSameEmailAs` | `function` | Helper function to compare normalized emails |
| `hasSamePhoneNumberAs` | `function` | Helper function to compare normalized phone numbers |
| `hasSameThirdPartyInfoAs` | `function` | Helper function to compare third party info |

<br />

<Accordion>

## Code sample

```ts
type User = {
    id: string;
    timeJoined: number;
    isPrimaryUser: boolean;
    tenantIds: string[];
    emails: string[];
    phoneNumbers: string[];
    thirdParty: {
        id: string;
        userId: string;
    }[];
    loginMethods: ({
        recipeId: "emailpassword" | "thirdparty" | "passwordless";
        tenantIds: string[];
        timeJoined: number;
        recipeUserId: RecipeUserId;
        verified: boolean;
        email?: string;
        phoneNumber?: string;
        thirdParty?: {
            id: string;
            userId: string;
        };
        hasSameEmailAs: (email: string | undefined) => boolean;
        hasSamePhoneNumberAs: (phoneNumber: string | undefined) => boolean;
        hasSameThirdPartyInfoAs: (thirdParty?: { id: string; userId: string }) => boolean;
    })[];
};

class RecipeUserId {
    private recipeUserId: string;
    constructor(recipeUserId: string) {
        this.recipeUserId = recipeUserId;
    }

    public getAsString = () => {
        return this.recipeUserId;
    };
}

```

</Accordion>

## Primary and recipe user ID

In SuperTokens, each user can have multiple login methods.
For example, one user may be able to login with both, email password and social login.
Each of these login methods gives the user a **unique user ID** - this is a `recipeUserId`.

When the user logs in with either of the two methods, **SuperTokens** resolves a common ID.
This user ID is the **primary user ID**.
The value of the **primary user ID** is equal to the **recipe user ID** of the initial login method registered by the user.

### Example

- A user first signs up with the email password recipe.
- This gives them the **recipe user ID** `r1`. As well, their **primary user ID** is also `r1`.
- They sign in with Google with the same email.
- This creates a different **recipe user ID**, `r2`.
- If you have enabled the automatic account linking, then the two recipe `userIds` link, and `r2`'s **primary user ID** becomes `r1`.
- If you have not enabled automatic account linking, then you have two distinct users, with two different **primary user IDs**.

## Examples

### Email password user without account linking

In a simple case, if there is a user who signed up with email password (with `test@example.com`), and automatic account linking is not enabled, their user object would look like:

```text
{
    id: "3f23dca5-79da-4d84-9a72-90286ef6ea0d";
    timeJoined: 1693286254150;
    isPrimaryUser: false;
    tenantIds: ["public"];
    emails: ["test@example.com"];
    phoneNumbers: [];
    thirdParty: [];
    loginMethods: [{
        recipeId: "emailpassword";
        tenantIds: ["public"];
        timeJoined: 1693286254150;
        recipeUserId: new RecipeUserId("3f23dca5-79da-4d84-9a72-90286ef6ea0d");
        verified: false;
        email: "test@example.com";
        hasSameEmailAs: (email: string | undefined) => boolean;
        hasSamePhoneNumberAs: (phoneNumber: string | undefined) => boolean;
        hasSameThirdPartyInfoAs: (thirdParty?: { id: string; userId: string }) => boolean;
    }];
};
```

- Notice that the value of `isPrimaryUser` is `false`.
This means that if this user links to another user, this user's primary user ID changes to the other user's primary user ID.
- This user has one login method (email password), since it's not linked to any other user.

### Email password user linked with a social login user

We have a user who signed up with email password (with `test@example.com`), and then with Google (with the same email).
Automatic account linking is active, therefore these two users get linked.

```text
{
    id: "3f23dca5-79da-4d84-9a72-90286ef6ea0d";
    timeJoined: 1693286254150;
    isPrimaryUser: true;
    tenantIds: ["public"];
    emails: ["test@example.com"];
    phoneNumbers: [];
    thirdParty: [{
        id: "google";
        userId: "1234567890";
    }];
    loginMethods: [{
        recipeId: "emailpassword";
        tenantIds: ["public"];
        timeJoined: 1693286254150;
        recipeUserId: new RecipeUserId("3f23dca5-79da-4d84-9a72-90286ef6ea0d");
        verified: false;
        email: "test@example.com";
        hasSameEmailAs: (email: string | undefined) => boolean;
        hasSamePhoneNumberAs: (phoneNumber: string | undefined) => boolean;
        hasSameThirdPartyInfoAs: (thirdParty?: { id: string; userId: string }) => boolean;
    }, {
        recipeId: "thirdparty";
        tenantIds: ["public"];
        timeJoined: 1693286254250;
        recipeUserId: new RecipeUserId("6ffc0ac5-d840-4a5b-92e8-86965f67c2ea");
        verified: true;
        email: "test@example.com";
        thirdParty: {
            id: "google";
            userId: "1234567890";
        };
        hasSameEmailAs: (email: string | undefined) => boolean;
        hasSamePhoneNumberAs: (phoneNumber: string | undefined) => boolean;
        hasSameThirdPartyInfoAs: (thirdParty?: { id: string; userId: string }) => boolean;
    }];
};
```

- Notice that the value of `isPrimaryUser` is `true`. This means that if this user links to another user, this user's primary user ID does not change.
- This user has two login methods (email password and third party). The top level `timeJoined` value is the min of the two `timeJoined` values in the `loginMethods`.
- In this example, the top level `emails` array has one item since both the login methods emails are the same, but if they were different, there would be two items in this array.

# References - Backend SDKs -  Backend SDK core interceptor
Source: https://supertokens.com/docs/references/backend-sdks/backend-sdk-core-interceptor

## Overview

This hook intercepts all outgoing requests from the backend SDK to the core.
Capture and modify the request before sending it to the core.
Users can modify the HTTP method, query params, headers, and body of the request.

## Prerequisites

:::info Important
This feature is only available for SDKs versions:
- NodeJS >= `v16.5.0`
- Python >= `v0.16.8`
- GoLang >= `v0.6.6`
:::

## Example 

<Tabs>
<Tab value="nodejs">

```tsx

SuperTokens.init({
    supertokens: {
        connectionURI: "...",
        apiKey: "...",
        // highlight-start
        networkInterceptor: (request: HttpRequest, userContext: any) => {
            console.log("http request to core: ", request)
            // this can also be used to return a modified request object.
            return request;
        },
        // highlight-end
    },
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "...",
    },
    recipeList: [
        // ... 
    ],
});
```

</Tab>
<Tab value="go">

```go

# References - Backend SDKs - Node.js SDK Reference -  SuperTokens Node
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/package

## Classes

### default

Defined in: [index.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L33)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="error"></a> `Error` | `static` | *typeof* `default` | `SuperTokensError` | [index.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L36) |
| <a id="init"></a> `init` | `static` | (`config`) => `void` | `SuperTokens.init` | [index.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L34) |
| <a id="recipeuserid"></a> `RecipeUserId` | `static` | *typeof* [`RecipeUserId`](#recipeuserid-1) | `RecipeUserId` | [index.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L37) |
| <a id="user"></a> `User` | `static` | *typeof* [`User`](#user-1) | `User` | [index.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L38) |

#### Methods

##### convertToRecipeUserId()

```ts
static convertToRecipeUserId(recipeUserId): RecipeUserId;
```

Defined in: [index.ts:167](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L167)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | `string` |

###### Returns

[`RecipeUserId`](#recipeuserid-1)

##### createUserIdMapping()

```ts
static createUserIdMapping(input): Promise<
  | {
  status: "OK" | "UNKNOWN_SUPERTOKENS_USER_ID_ERROR";
}
  | {
  doesExternalUserIdExist: boolean;
  doesSuperTokensUserIdExist: boolean;
  status: "USER_ID_MAPPING_ALREADY_EXISTS_ERROR";
}>;
```

Defined in: [index.ts:88](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L88)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `externalUserId`: `string`; `externalUserIdInfo?`: `string`; `force?`: `boolean`; `superTokensUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.externalUserId` | `string` |
| `input.externalUserIdInfo?` | `string` |
| `input.force?` | `boolean` |
| `input.superTokensUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_SUPERTOKENS_USER_ID_ERROR"`;
\}
  \| \{
  `doesExternalUserIdExist`: `boolean`;
  `doesSuperTokensUserIdExist`: `boolean`;
  `status`: `"USER_ID_MAPPING_ALREADY_EXISTS_ERROR"`;
\}\>

##### deleteUser()

```ts
static deleteUser(
   userId, 
   removeAllLinkedAccounts, 
   userContext?): Promise<{
  status: "OK";
}>;
```

Defined in: [index.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L156)

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `userId` | `string` | `undefined` |
| `removeAllLinkedAccounts` | `boolean` | `true` |
| `userContext?` | `Record`\<`string`, `any`\> | `undefined` |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### deleteUserIdMapping()

```ts
static deleteUserIdMapping(input): Promise<{
  didMappingExist: boolean;
  status: "OK";
}>;
```

Defined in: [index.ts:112](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L112)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `force?`: `boolean`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; `userIdType?`: `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"`; \} |
| `input.force?` | `boolean` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |
| `input.userIdType?` | `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"` |

###### Returns

`Promise`\<\{
  `didMappingExist`: `boolean`;
  `status`: `"OK"`;
\}\>

##### getAllCORSHeaders()

```ts
static getAllCORSHeaders(): string[];
```

Defined in: [index.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L40)

###### Returns

`string`[]

##### getRequestFromUserContext()

```ts
static getRequestFromUserContext(userContext): BaseRequest;
```

Defined in: [index.ts:171](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L171)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`BaseRequest`

##### getUser()

```ts
static getUser(userId, userContext?): Promise<User>;
```

Defined in: [index.ts:136](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L136)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`User`](types.mdx#user)\>

##### getUserCount()

```ts
static getUserCount(
   includeRecipeIds?, 
   tenantId?, 
userContext?): Promise<number>;
```

Defined in: [index.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L44)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `includeRecipeIds?` | `string`[] |
| `tenantId?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`number`\>

##### getUserIdMapping()

```ts
static getUserIdMapping(input): Promise<
  | {
  externalUserId: string;
  externalUserIdInfo: string;
  status: "OK";
  superTokensUserId: string;
}
  | {
  status: "UNKNOWN_MAPPING_ERROR";
}>;
```

Defined in: [index.ts:101](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L101)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; `userIdType?`: `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"`; \} |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |
| `input.userIdType?` | `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"` |

###### Returns

`Promise`\<
  \| \{
  `externalUserId`: `string`;
  `externalUserIdInfo`: `string`;
  `status`: `"OK"`;
  `superTokensUserId`: `string`;
\}
  \| \{
  `status`: `"UNKNOWN_MAPPING_ERROR"`;
\}\>

##### getUsersNewestFirst()

```ts
static getUsersNewestFirst(input): Promise<{
  nextPaginationToken?: string;
  users: User[];
}>;
```

Defined in: [index.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L70)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `includeRecipeIds?`: `string`[]; `limit?`: `number`; `paginationToken?`: `string`; `query?`: \{ \[`key`: `string`\]: `string`; \}; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.includeRecipeIds?` | `string`[] |
| `input.limit?` | `number` |
| `input.paginationToken?` | `string` |
| `input.query?` | \{ \[`key`: `string`\]: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `nextPaginationToken?`: `string`;
  `users`: [`User`](types.mdx#user)[];
\}\>

##### getUsersOldestFirst()

```ts
static getUsersOldestFirst(input): Promise<{
  nextPaginationToken?: string;
  users: User[];
}>;
```

Defined in: [index.ts:52](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L52)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `includeRecipeIds?`: `string`[]; `limit?`: `number`; `paginationToken?`: `string`; `query?`: \{ \[`key`: `string`\]: `string`; \}; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.includeRecipeIds?` | `string`[] |
| `input.limit?` | `number` |
| `input.paginationToken?` | `string` |
| `input.query?` | \{ \[`key`: `string`\]: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `nextPaginationToken?`: `string`;
  `users`: [`User`](types.mdx#user)[];
\}\>

##### isRecipeInitialized()

```ts
static isRecipeInitialized(recipeId): boolean;
```

Defined in: [index.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L175)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeId` | `string` |

###### Returns

`boolean`

##### listUsersByAccountInfo()

```ts
static listUsersByAccountInfo(
   tenantId, 
   accountInfo, 
   doUnionOfAccountInfo, 
userContext?): Promise<User[]>;
```

Defined in: [index.ts:143](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L143)

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `tenantId` | `string` | `undefined` |
| `accountInfo` | [`AccountInfoInput`](recipe-accountlinking-types.mdx#accountinfoinput) | `undefined` |
| `doUnionOfAccountInfo` | `boolean` | `false` |
| `userContext?` | `Record`\<`string`, `any`\> | `undefined` |

###### Returns

`Promise`\<[`User`](types.mdx#user)[]\>

##### updateOrDeleteUserIdMappingInfo()

```ts
static updateOrDeleteUserIdMappingInfo(input): Promise<{
  status: "OK" | "UNKNOWN_MAPPING_ERROR";
}>;
```

Defined in: [index.ts:124](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L124)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `externalUserIdInfo?`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; `userIdType?`: `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"`; \} |
| `input.externalUserIdInfo?` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |
| `input.userIdType?` | `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"` |

###### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"UNKNOWN_MAPPING_ERROR"`;
\}\>

***

### RecipeUserId

Defined in: [recipeUserId.ts:1](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipeUserId.ts#L1)

#### Constructors

##### Constructor

```ts
new RecipeUserId(recipeUserId): RecipeUserId;
```

Defined in: [recipeUserId.ts:3](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipeUserId.ts#L3)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | `string` |

###### Returns

[`RecipeUserId`](#recipeuserid-1)

#### Methods

##### getAsString()

```ts
getAsString(): string;
```

Defined in: [recipeUserId.ts:10](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipeUserId.ts#L10)

###### Returns

`string`

***

### User

Defined in: [user.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L91)

#### Implements

- [`User`](types.mdx#user)

#### Constructors

##### Constructor

```ts
new User(user): User;
```

Defined in: [user.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L109)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | `UserWithoutHelperFunctions` |

###### Returns

[`User`](#user-1)

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="emails"></a> `emails` | `readonly` | `string`[] | [user.ts:96](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L96) |
| <a id="id"></a> `id` | `readonly` | `string` | [user.ts:92](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L92) |
| <a id="isprimaryuser"></a> `isPrimaryUser` | `readonly` | `boolean` | [user.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L93) |
| <a id="loginmethods"></a> `loginMethods` | `readonly` | `LoginMethod`[] | [user.ts:105](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L105) |
| <a id="phonenumbers"></a> `phoneNumbers` | `readonly` | `string`[] | [user.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L97) |
| <a id="tenantids"></a> `tenantIds` | `readonly` | `string`[] | [user.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L94) |
| <a id="thirdparty"></a> `thirdParty` | `readonly` | `object`[] | [user.ts:98](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L98) |
| <a id="timejoined"></a> `timeJoined` | `readonly` | `number` | [user.ts:107](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L107) |
| <a id="webauthn"></a> `webauthn` | `readonly` | `object` | [user.ts:102](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L102) |
| `webauthn.credentialIds` | `public` | `string`[] | [user.ts:103](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L103) |

#### Methods

##### toJson()

```ts
toJson(): JSONObject;
```

Defined in: [user.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L133)

###### Returns

[`JSONObject`](types.mdx#jsonobject)

###### Implementation of

```ts
UserType.toJson
```

##### fromApi()

```ts
static fromApi(apiUser): User;
```

Defined in: [user.ts:129](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/user.ts#L129)

This function is used to create a User object from the API response.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `apiUser` | `Omit`\<`UserWithoutHelperFunctions`, `"id"`\> & `object` | The API response from the user endpoint. |

###### Returns

[`User`](#user-1)

A User object.

## Variables

### convertToRecipeUserId()

```ts
convertToRecipeUserId: (recipeUserId) => RecipeUserId = SuperTokensWrapper.convertToRecipeUserId;
```

Defined in: [index.ts:206](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L206)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | `string` |

#### Returns

[`RecipeUserId`](#recipeuserid-1)

***

### createUserIdMapping()

```ts
createUserIdMapping: (input) => Promise<
  | {
  status: "OK" | "UNKNOWN_SUPERTOKENS_USER_ID_ERROR";
}
  | {
  doesExternalUserIdExist: boolean;
  doesSuperTokensUserIdExist: boolean;
  status: "USER_ID_MAPPING_ALREADY_EXISTS_ERROR";
}> = SuperTokensWrapper.createUserIdMapping;
```

Defined in: [index.ts:194](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L194)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `externalUserId`: `string`; `externalUserIdInfo?`: `string`; `force?`: `boolean`; `superTokensUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.externalUserId` | `string` |
| `input.externalUserIdInfo?` | `string` |
| `input.force?` | `boolean` |
| `input.superTokensUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_SUPERTOKENS_USER_ID_ERROR"`;
\}
  \| \{
  `doesExternalUserIdExist`: `boolean`;
  `doesSuperTokensUserIdExist`: `boolean`;
  `status`: `"USER_ID_MAPPING_ALREADY_EXISTS_ERROR"`;
\}\>

***

### deleteUser()

```ts
deleteUser: (userId, removeAllLinkedAccounts, userContext?) => Promise<{
  status: "OK";
}> = SuperTokensWrapper.deleteUser;
```

Defined in: [index.ts:192](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L192)

#### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `userId` | `string` | `undefined` |
| `removeAllLinkedAccounts` | `boolean` | `true` |
| `userContext?` | `Record`\<`string`, `any`\> | `undefined` |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### deleteUserIdMapping()

```ts
deleteUserIdMapping: (input) => Promise<{
  didMappingExist: boolean;
  status: "OK";
}> = SuperTokensWrapper.deleteUserIdMapping;
```

Defined in: [index.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L198)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `force?`: `boolean`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; `userIdType?`: `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"`; \} |
| `input.force?` | `boolean` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |
| `input.userIdType?` | `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"` |

#### Returns

`Promise`\<\{
  `didMappingExist`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### Error

```ts
Error: typeof default = SuperTokensWrapper.Error;
```

Defined in: [index.ts:212](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L212)

***

### getAllCORSHeaders()

```ts
getAllCORSHeaders: () => string[] = SuperTokensWrapper.getAllCORSHeaders;
```

Defined in: [index.ts:184](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L184)

#### Returns

`string`[]

***

### getRequestFromUserContext()

```ts
getRequestFromUserContext: (userContext) => BaseRequest = SuperTokensWrapper.getRequestFromUserContext;
```

Defined in: [index.ts:208](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L208)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`BaseRequest`

***

### getUser()

```ts
getUser: (userId, userContext?) => Promise<User> = SuperTokensWrapper.getUser;
```

Defined in: [index.ts:202](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L202)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`User`](types.mdx#user)\>

***

### getUserCount()

```ts
getUserCount: (includeRecipeIds?, tenantId?, userContext?) => Promise<number> = SuperTokensWrapper.getUserCount;
```

Defined in: [index.ts:186](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L186)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `includeRecipeIds?` | `string`[] |
| `tenantId?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`number`\>

***

### getUserIdMapping()

```ts
getUserIdMapping: (input) => Promise<
  | {
  externalUserId: string;
  externalUserIdInfo: string;
  status: "OK";
  superTokensUserId: string;
}
  | {
  status: "UNKNOWN_MAPPING_ERROR";
}> = SuperTokensWrapper.getUserIdMapping;
```

Defined in: [index.ts:196](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L196)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; `userIdType?`: `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"`; \} |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |
| `input.userIdType?` | `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"` |

#### Returns

`Promise`\<
  \| \{
  `externalUserId`: `string`;
  `externalUserIdInfo`: `string`;
  `status`: `"OK"`;
  `superTokensUserId`: `string`;
\}
  \| \{
  `status`: `"UNKNOWN_MAPPING_ERROR"`;
\}\>

***

### getUsersNewestFirst()

```ts
getUsersNewestFirst: (input) => Promise<{
  nextPaginationToken?: string;
  users: User[];
}> = SuperTokensWrapper.getUsersNewestFirst;
```

Defined in: [index.ts:190](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L190)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `includeRecipeIds?`: `string`[]; `limit?`: `number`; `paginationToken?`: `string`; `query?`: \{ \[`key`: `string`\]: `string`; \}; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.includeRecipeIds?` | `string`[] |
| `input.limit?` | `number` |
| `input.paginationToken?` | `string` |
| `input.query?` | \{ \[`key`: `string`\]: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `nextPaginationToken?`: `string`;
  `users`: [`User`](types.mdx#user)[];
\}\>

***

### getUsersOldestFirst()

```ts
getUsersOldestFirst: (input) => Promise<{
  nextPaginationToken?: string;
  users: User[];
}> = SuperTokensWrapper.getUsersOldestFirst;
```

Defined in: [index.ts:188](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L188)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `includeRecipeIds?`: `string`[]; `limit?`: `number`; `paginationToken?`: `string`; `query?`: \{ \[`key`: `string`\]: `string`; \}; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.includeRecipeIds?` | `string`[] |
| `input.limit?` | `number` |
| `input.paginationToken?` | `string` |
| `input.query?` | \{ \[`key`: `string`\]: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `nextPaginationToken?`: `string`;
  `users`: [`User`](types.mdx#user)[];
\}\>

***

### init()

```ts
init: (config) => void = SuperTokensWrapper.init;
```

Defined in: [index.ts:182](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L182)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`TypeInput`](types.mdx#typeinput) |

#### Returns

`void`

***

### isRecipeInitialized()

```ts
isRecipeInitialized: (recipeId) => boolean = SuperTokensWrapper.isRecipeInitialized;
```

Defined in: [index.ts:210](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L210)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeId` | `string` |

#### Returns

`boolean`

***

### listUsersByAccountInfo()

```ts
listUsersByAccountInfo: (tenantId, accountInfo, doUnionOfAccountInfo, userContext?) => Promise<User[]> = SuperTokensWrapper.listUsersByAccountInfo;
```

Defined in: [index.ts:204](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L204)

#### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `tenantId` | `string` | `undefined` |
| `accountInfo` | [`AccountInfoInput`](recipe-accountlinking-types.mdx#accountinfoinput) | `undefined` |
| `doUnionOfAccountInfo` | `boolean` | `false` |
| `userContext?` | `Record`\<`string`, `any`\> | `undefined` |

#### Returns

`Promise`\<[`User`](types.mdx#user)[]\>

***

### updateOrDeleteUserIdMappingInfo()

```ts
updateOrDeleteUserIdMappingInfo: (input) => Promise<{
  status: "OK" | "UNKNOWN_MAPPING_ERROR";
}> = SuperTokensWrapper.updateOrDeleteUserIdMappingInfo;
```

Defined in: [index.ts:200](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/index.ts#L200)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `externalUserIdInfo?`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; `userIdType?`: `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"`; \} |
| `input.externalUserIdInfo?` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |
| `input.userIdType?` | `"SUPERTOKENS"` \| `"EXTERNAL"` \| `"ANY"` |

#### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"UNKNOWN_MAPPING_ERROR"`;
\}\>

## References

### SuperTokensConfig

Renames and re-exports [TypeInput](types.mdx#typeinput)

***

### SuperTokensPlugin

Re-exports [SuperTokensPlugin](types.mdx#supertokensplugin)

***

### SuperTokensPublicConfig

Re-exports [SuperTokensPublicConfig](types.mdx#supertokenspublicconfig)

***

### SuperTokensPublicPlugin

Re-exports [SuperTokensPublicPlugin](types.mdx#supertokenspublicplugin)

# References - Backend SDKs - Node.js SDK Reference -  SuperTokens Node Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/types

## Interfaces

### HttpRequest

Defined in: [types.ts:197](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L197)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="body"></a> `body?` | `any` | [types.ts:202](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L202) |
| <a id="headers"></a> `headers` | `object` | [types.ts:200](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L200) |
| <a id="method"></a> `method` | [`HTTPMethod`](#httpmethod) | [types.ts:199](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L199) |
| <a id="params"></a> `params?` | `Record`\<`string`, `boolean` \| `number` \| `string` \| `undefined`\> | [types.ts:201](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L201) |
| <a id="url"></a> `url` | `string` | [types.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L198) |

***

### JSONObject

Defined in: [types.ts:223](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L223)

#### Indexable

```ts
[ind: string]: JSONValue
```

## Type Aliases

### AllRecipeConfigs

```ts
type AllRecipeConfigs = object;
```

Defined in: [types.ts:90](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L90)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="accountlinking"></a> `accountlinking` | [`TypeInput`](recipe-accountlinking-types.mdx#typeinput) & `object` | [types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L91) |
| <a id="dashboard"></a> `dashboard` | [`TypeInput`](recipe-dashboard-types.mdx#typeinput) | [types.ts:92](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L92) |
| <a id="emailpassword"></a> `emailpassword` | [`TypeInput`](recipe-emailpassword-types.mdx#typeinput) | [types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L93) |
| <a id="emailverification"></a> `emailverification` | [`TypeInput`](recipe-emailverification-types.mdx#typeinput) | [types.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L94) |
| <a id="jwt"></a> `jwt` | [`TypeInput`](recipe-jwt-types.mdx#typeinput) | [types.ts:95](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L95) |
| <a id="multifactorauth"></a> `multifactorauth` | [`TypeInput`](recipe-multifactorauth-types.mdx#typeinput) | [types.ts:96](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L96) |
| <a id="multitenancy"></a> `multitenancy` | [`TypeInput`](recipe-multitenancy-types.mdx#typeinput) | [types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L97) |
| <a id="oauth2provider"></a> `oauth2provider` | [`TypeInput`](recipe-oauth2provider-types.mdx#typeinput) | [types.ts:98](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L98) |
| <a id="openid"></a> `openid` | [`TypeInput`](recipe-openid-types.mdx#typeinput) | [types.ts:99](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L99) |
| <a id="passwordless"></a> `passwordless` | [`TypeInput`](recipe-passwordless-types.mdx#typeinput) | [types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L100) |
| <a id="session"></a> `session` | `SessionTypeInput` | [types.ts:101](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L101) |
| <a id="thirdparty"></a> `thirdparty` | [`TypeInput`](recipe-thirdparty-types.mdx#typeinput) | [types.ts:102](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L102) |
| <a id="totp"></a> `totp` | [`TypeInput`](recipe-totp-types.mdx#typeinput) | [types.ts:103](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L103) |
| <a id="usermetadata"></a> `usermetadata` | [`TypeInput`](recipe-usermetadata-types.mdx#typeinput) | [types.ts:104](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L104) |
| <a id="userroles"></a> `userroles` | [`TypeInput`](recipe-userroles-types.mdx#typeinput) | [types.ts:105](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L105) |
| <a id="webauthn"></a> `webauthn` | [`TypeInput`](recipe-webauthn-types.mdx#typeinput) | [types.ts:106](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L106) |

***

### APIHandled

```ts
type APIHandled = object;
```

Defined in: [types.ts:211](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L211)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="disabled"></a> `disabled` | `boolean` | [types.ts:215](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L215) |
| <a id="id"></a> `id` | `string` | [types.ts:214](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L214) |
| <a id="method-1"></a> `method` | [`HTTPMethod`](#httpmethod) | [types.ts:213](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L213) |
| <a id="pathwithoutapibasepath"></a> `pathWithoutApiBasePath` | `NormalisedURLPath` | [types.ts:212](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L212) |

***

### AppInfo

```ts
type AppInfo = object;
```

Defined in: [types.ts:62](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L62)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apibasepath"></a> `apiBasePath?` | `string` | [types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L68) |
| <a id="apidomain"></a> `apiDomain` | `string` | [types.ts:67](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L67) |
| <a id="apigatewaypath"></a> `apiGatewayPath?` | `string` | [types.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L69) |
| <a id="appname"></a> `appName` | `string` | [types.ts:63](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L63) |
| <a id="origin"></a> `origin?` | `string` \| (`input`) => `string` | [types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L65) |
| <a id="websitebasepath"></a> `websiteBasePath?` | `string` | [types.ts:66](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L66) |
| <a id="websitedomain"></a> `websiteDomain?` | `string` | [types.ts:64](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L64) |

***

### Entries\<T\>

```ts
type Entries<T> = { [K in keyof T]-?: [K, T[K]] }[keyof T][];
```

Defined in: [types.ts:53](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L53)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

***

### GeneralErrorResponse

```ts
type GeneralErrorResponse = object;
```

Defined in: [types.ts:226](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L226)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="message"></a> `message` | `string` | [types.ts:228](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L228) |
| <a id="status"></a> `status` | `"GENERAL_ERROR"` | [types.ts:227](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L227) |

***

### HTTPMethod

```ts
type HTTPMethod = "post" | "get" | "delete" | "put" | "patch" | "options" | "trace";
```

Defined in: [types.ts:218](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L218)

***

### JSONArray

```ts
type JSONArray = JSONValue[];
```

Defined in: [types.ts:221](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L221)

***

### JSONPrimitive

```ts
type JSONPrimitive = string | number | boolean | null;
```

Defined in: [types.ts:220](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L220)

***

### JSONValue

```ts
type JSONValue = 
  | JSONPrimitive
  | JSONObject
  | JSONArray
  | undefined;
```

Defined in: [types.ts:222](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L222)

***

### NetworkInterceptor()

```ts
type NetworkInterceptor = (request, userContext) => HttpRequest;
```

Defined in: [types.ts:195](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L195)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `request` | [`HttpRequest`](#httprequest) |
| `userContext` | [`UserContext`](#usercontext) |

#### Returns

[`HttpRequest`](#httprequest)

***

### NonNullableProperties\<T\>

```ts
type NonNullableProperties<T> = { [P in keyof T]: NonNullable<T[P]> };
```

Defined in: [types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L49)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

***

### NonPublicConfigPropertiesType

```ts
type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];
```

Defined in: [types.ts:163](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L163)

***

### NormalisedAppinfo

```ts
type NormalisedAppinfo = object;
```

Defined in: [types.ts:72](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L72)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apibasepath-1"></a> `apiBasePath` | `NormalisedURLPath` | [types.ts:78](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L78) |
| <a id="apidomain-1"></a> `apiDomain` | `NormalisedURLDomain` | [types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L75) |
| <a id="apigatewaypath-1"></a> `apiGatewayPath` | `NormalisedURLPath` | [types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L79) |
| <a id="appname-1"></a> `appName` | `string` | [types.ts:73](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L73) |
| <a id="getorigin"></a> `getOrigin` | (`input`) => `NormalisedURLDomain` | [types.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L74) |
| <a id="gettoplevelwebsitedomain"></a> `getTopLevelWebsiteDomain` | (`input`) => `string` | [types.ts:77](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L77) |
| <a id="toplevelapidomain"></a> `topLevelAPIDomain` | `string` | [types.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L76) |
| <a id="websitebasepath-1"></a> `websiteBasePath` | `NormalisedURLPath` | [types.ts:80](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L80) |

***

### PluginRouteHandler

```ts
type PluginRouteHandler = object;
```

Defined in: [types.ts:115](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L115)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="handler"></a> `handler` | (`req`, `res`, `session`, `userContext`) => `Promise`\< \| \{ `body`: [`JSONObject`](#jsonobject); `status`: `number`; \} \| `null`\> | [types.ts:119](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L119) |
| <a id="method-2"></a> `method` | [`HTTPMethod`](#httpmethod) | [types.ts:116](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L116) |
| <a id="path"></a> `path` | `string` | [types.ts:117](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L117) |
| <a id="verifysessionoptions"></a> `verifySessionOptions?` | `VerifySessionOptions` | [types.ts:118](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L118) |

***

### RecipeListFunction()

```ts
type RecipeListFunction = (appInfo, isInServerlessEnv, overrideMaps) => RecipeModule;
```

Defined in: [types.ts:205](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L205)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `appInfo` | [`NormalisedAppinfo`](#normalisedappinfo) |
| `isInServerlessEnv` | `boolean` |
| `overrideMaps` | `NonNullable`\<[`SuperTokensPlugin`](#supertokensplugin)\[`"overrideMap"`\]\>[] |

#### Returns

`RecipeModule`

***

### RecipePluginOverride\<T\>

```ts
type RecipePluginOverride<T> = object;
```

Defined in: [types.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L109)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`AllRecipeConfigs`](#allrecipeconfigs) |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apis"></a> `apis?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"apis"`\] | [types.ts:111](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L111) |
| <a id="config"></a> `config?` | (`config`) => [`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\] | [types.ts:112](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L112) |
| <a id="functions"></a> `functions?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"functions"`\] | [types.ts:110](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L110) |

***

### SuperTokensConfigWithNormalisedAppInfo

```ts
type SuperTokensConfigWithNormalisedAppInfo = Omit<TypeInput, "appInfo"> & object;
```

Defined in: [types.ts:165](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L165)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppinfo`](#normalisedappinfo) | [types.ts:166](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L166) |

***

### SuperTokensInfo

```ts
type SuperTokensInfo = object;
```

Defined in: [types.ts:83](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L83)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apikey"></a> `apiKey?` | `string` | [types.ts:85](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L85) |
| <a id="connectionuri"></a> `connectionURI` | `string` | [types.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L84) |
| <a id="disablecorecallcache"></a> `disableCoreCallCache?` | `boolean` | [types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L87) |
| <a id="networkinterceptor-1"></a> `networkInterceptor?` | [`NetworkInterceptor`](#networkinterceptor) | [types.ts:86](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L86) |

***

### SuperTokensPlugin

```ts
type SuperTokensPlugin = object;
```

Defined in: [types.ts:130](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L130)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="compatiblesdkversions"></a> `compatibleSDKVersions?` | `string` \| `string`[] | [types.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L133) |
| <a id="config-1"></a> `config?` | (`config`) => \| `Omit`\<[`SuperTokensPublicConfig`](#supertokenspublicconfig), `"appInfo"`\> \| `undefined` | [types.ts:152](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L152) |
| <a id="dependencies"></a> `dependencies?` | (`config`, `pluginsAbove`, `sdkVersion`) => \| \{ `pluginsToAdd?`: [`SuperTokensPlugin`](#supertokensplugin)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} | [types.ts:135](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L135) |
| <a id="exports"></a> `exports?` | `Record`\<`string`, `any`\> | [types.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L153) |
| <a id="id-1"></a> `id` | `string` | [types.ts:131](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L131) |
| <a id="init"></a> `init?` | (`config`, `allPlugins`, `sdkVersion`) => `void` | [types.ts:134](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L134) |
| <a id="overridemap"></a> `overrideMap?` | \{ \[recipeId in keyof AllRecipeConfigs\]?: RecipePluginOverride\<recipeId\> & \{ recipeInitRequired?: boolean \| ((sdkVersion: string) =\> boolean) \} \} | [types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L140) |
| <a id="routehandlers"></a> `routeHandlers?` | \| (`config`, `allPlugins`, `sdkVersion`) => \| \{ `routeHandlers`: [`PluginRouteHandler`](#pluginroutehandler)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} \| [`PluginRouteHandler`](#pluginroutehandler)[] | [types.ts:145](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L145) |
| <a id="version"></a> `version?` | `string` | [types.ts:132](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L132) |

***

### SuperTokensPublicConfig

```ts
type SuperTokensPublicConfig = Omit<Omit<TypeInput, NonPublicConfigPropertiesType>, "appInfo"> & object;
```

Defined in: [types.ts:169](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L169)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppinfo`](#normalisedappinfo) | [types.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L170) |

***

### SuperTokensPublicPlugin

```ts
type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, "id" | "version" | "compatibleSDKVersions" | "exports"> & object;
```

Defined in: [types.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L156)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `initialized` | `boolean` | [types.ts:159](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L159) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [types.ts:173](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L173)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="appinfo-1"></a> `appInfo` | [`AppInfo`](#appinfo) | - | [types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L176) |
| <a id="debug"></a> `debug?` | `boolean` | - | [types.ts:180](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L180) |
| <a id="experimental"></a> `experimental?` | `object` | Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord | [types.ts:190](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L190) |
| `experimental.plugins?` | [`SuperTokensPlugin`](#supertokensplugin)[] | - | [types.ts:191](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L191) |
| <a id="framework"></a> `framework?` | `TypeFramework` | - | [types.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L175) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv?` | `boolean` | - | [types.ts:179](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L179) |
| <a id="recipelist"></a> `recipeList` | [`RecipeListFunction`](#recipelistfunction)[] | - | [types.ts:177](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L177) |
| <a id="supertokens"></a> `supertokens?` | [`SuperTokensInfo`](#supertokensinfo) | - | [types.ts:174](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L174) |
| <a id="telemetry"></a> `telemetry?` | `boolean` | - | [types.ts:178](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L178) |

***

### User

```ts
type User = object;
```

Defined in: [types.ts:231](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L231)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emails"></a> `emails` | `string`[] | [types.ts:236](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L236) |
| <a id="id-2"></a> `id` | `string` | [types.ts:232](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L232) |
| <a id="isprimaryuser"></a> `isPrimaryUser` | `boolean` | [types.ts:234](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L234) |
| <a id="loginmethods"></a> `loginMethods` | [`RecipeLevelUser`](recipe-accountlinking-types.mdx#recipeleveluser) & `object`[] | [types.ts:245](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L245) |
| <a id="phonenumbers"></a> `phoneNumbers` | `string`[] | [types.ts:237](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L237) |
| <a id="tenantids"></a> `tenantIds` | `string`[] | [types.ts:235](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L235) |
| <a id="thirdparty-1"></a> `thirdParty` | `object`[] | [types.ts:238](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L238) |
| <a id="timejoined"></a> `timeJoined` | `number` | [types.ts:233](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L233) |
| <a id="tojson"></a> `toJson` | () => `any` | [types.ts:257](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L257) |
| <a id="webauthn-1"></a> `webauthn` | `object` | [types.ts:242](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L242) |
| `webauthn.credentialIds` | `string`[] | [types.ts:243](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L243) |

***

### UserContext

```ts
type UserContext = Branded<Record<string, any>, "UserContext">;
```

Defined in: [types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L60)

## Variables

### nonPublicConfigProperties

```ts
const nonPublicConfigProperties: readonly ["recipeList", "experimental"];
```

Defined in: [types.ts:161](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L161)

# References - Backend SDKs - Node.js SDK Reference -  EmailPassword Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-emailpassword-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/emailpassword/types.ts:208](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L208)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailexistsget"></a> `emailExistsGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `exists`: `boolean`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailpassword/types.ts:209](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L209) |
| <a id="generatepasswordresettokenpost"></a> `generatePasswordResetTokenPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; \} \| \{ `reason`: `string`; `status`: `"PASSWORD_RESET_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailpassword/types.ts:219](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L219) |
| <a id="passwordresetpost"></a> `passwordResetPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `email`: `string`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`; \} \| \{ `failureReason`: `string`; `status`: `"PASSWORD_POLICY_VIOLATED_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailpassword/types.ts:240](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L240) |
| <a id="signinpost"></a> `signInPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `session`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `reason`: `string`; `status`: `"SIGN_IN_NOT_ALLOWED"`; \} \| \{ `status`: `"WRONG_CREDENTIALS_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailpassword/types.ts:264](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L264) |
| <a id="signuppost"></a> `signUpPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `session`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `reason`: `string`; `status`: `"SIGN_UP_NOT_ALLOWED"`; \} \| \{ `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailpassword/types.ts:292](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L292) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/emailpassword/types.ts:197](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L197)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types.mdx#normalisedappinfo) | [recipe/emailpassword/types.ts:199](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L199) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/emailpassword/types.ts:200](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L200) |
| <a id="emaildelivery"></a> `emailDelivery` | `EmailDeliveryIngredient`\<[`TypeEmailPasswordEmailDeliveryInput`](#typeemailpasswordemaildeliveryinput)\> | [recipe/emailpassword/types.ts:205](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L205) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/emailpassword/types.ts:202](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L202) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/emailpassword/types.ts:201](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L201) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/emailpassword/types.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L198) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/emailpassword/types.ts:203](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L203) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/emailpassword/types.ts:204](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L204) |

***

### NormalisedFormField

```ts
type NormalisedFormField = object;
```

Defined in: [recipe/emailpassword/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L55)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id"></a> `id` | `string` | [recipe/emailpassword/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L56) |
| <a id="optional"></a> `optional` | `boolean` | [recipe/emailpassword/types.ts:58](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L58) |
| <a id="validate"></a> `validate` | (`value`, `tenantId`, `userContext`) => `Promise`\<`string` \| `undefined`\> | [recipe/emailpassword/types.ts:57](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L57) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/emailpassword/types.ts:86](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L86)

#### Methods

##### consumePasswordResetToken()

```ts
consumePasswordResetToken(input): Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
  | {
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}>;
```

Defined in: [recipe/emailpassword/types.ts:167](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L167)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
  `userId`: `string`;
\}
  \| \{
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}\>

##### createNewRecipeUser()

```ts
createNewRecipeUser(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}>;
```

Defined in: [recipe/emailpassword/types.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L114)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `password`: `string`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.password` | `string` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}\>

##### createResetPasswordToken()

```ts
createResetPasswordToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}>;
```

Defined in: [recipe/emailpassword/types.ts:160](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L160)

We pass in the email as well to this function cause the input userId
may not be associated with an emailpassword account. In this case, we
need to know which email to use to create an emailpassword account later on.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `userId`: `string`; \} |
| `input.email` | `string` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.userId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

##### signIn()

```ts
signIn(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/emailpassword/types.ts:128](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L128)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `password`: `string`; `session`: `SessionContainerInterface` \| `undefined`; `shouldTryLinkingWithSessionUser`: `boolean` \| `undefined`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.password` | `string` |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` \| `undefined` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

##### signUp()

```ts
signUp(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/emailpassword/types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L87)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `password`: `string`; `session`: `SessionContainerInterface` \| `undefined`; `shouldTryLinkingWithSessionUser`: `boolean` \| `undefined`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.password` | `string` |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` \| `undefined` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

##### updateEmailOrPassword()

```ts
updateEmailOrPassword(input): Promise<
  | {
  status: "OK" | "UNKNOWN_USER_ID_ERROR" | "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  failureReason: string;
  status: "PASSWORD_POLICY_VIOLATED_ERROR";
}>;
```

Defined in: [recipe/emailpassword/types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L176)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `applyPasswordPolicy?`: `boolean`; `email?`: `string`; `password?`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `tenantIdForPasswordPolicy`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.applyPasswordPolicy?` | `boolean` |
| `input.email?` | `string` |
| `input.password?` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.tenantIdForPasswordPolicy` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"` \| `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `failureReason`: `string`;
  `status`: `"PASSWORD_POLICY_VIOLATED_ERROR"`;
\}\>

##### verifyCredentials()

```ts
verifyCredentials(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}>;
```

Defined in: [recipe/emailpassword/types.ts:148](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L148)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `password`: `string`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.password` | `string` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}\>

***

### TypeEmailPasswordEmailDeliveryInput

```ts
type TypeEmailPasswordEmailDeliveryInput = TypeEmailPasswordPasswordResetEmailDeliveryInput;
```

Defined in: [recipe/emailpassword/types.ts:332](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L332)

***

### TypeEmailPasswordPasswordResetEmailDeliveryInput

```ts
type TypeEmailPasswordPasswordResetEmailDeliveryInput = object;
```

Defined in: [recipe/emailpassword/types.ts:321](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L321)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="passwordresetlink"></a> `passwordResetLink` | `string` | [recipe/emailpassword/types.ts:328](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L328) |
| <a id="tenantid"></a> `tenantId` | `string` | [recipe/emailpassword/types.ts:329](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L329) |
| <a id="type"></a> `type` | `"PASSWORD_RESET"` | [recipe/emailpassword/types.ts:322](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L322) |
| <a id="user"></a> `user` | `object` | [recipe/emailpassword/types.ts:323](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L323) |
| `user.email` | `string` | [recipe/emailpassword/types.ts:326](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L326) |
| `user.id` | `string` | [recipe/emailpassword/types.ts:324](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L324) |
| `user.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) \| `undefined` | [recipe/emailpassword/types.ts:325](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L325) |

***

### TypeFormField

```ts
type TypeFormField = object;
```

Defined in: [recipe/emailpassword/types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L49)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id-1"></a> `id` | `string` | [recipe/emailpassword/types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L49) |
| <a id="value"></a> `value` | `any` | [recipe/emailpassword/types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L49) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/emailpassword/types.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L74)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emaildelivery-1"></a> `emailDelivery?` | `EmailDeliveryTypeInput`\<[`TypeEmailPasswordEmailDeliveryInput`](#typeemailpasswordemaildeliveryinput)\> | [recipe/emailpassword/types.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L76) |
| <a id="override"></a> `override?` | `object` | [recipe/emailpassword/types.ts:77](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L77) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/emailpassword/types.ts:82](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L82) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/emailpassword/types.ts:78](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L78) |
| <a id="signupfeature"></a> `signUpFeature?` | [`TypeInputSignUp`](#typeinputsignup) | [recipe/emailpassword/types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L75) |

***

### TypeInputFormField

```ts
type TypeInputFormField = object;
```

Defined in: [recipe/emailpassword/types.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L43)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id-2"></a> `id` | `string` | [recipe/emailpassword/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L44) |
| <a id="optional-1"></a> `optional?` | `boolean` | [recipe/emailpassword/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L46) |
| <a id="validate-1"></a> `validate?` | (`value`, `tenantId`, `userContext`) => `Promise`\<`string` \| `undefined`\> | [recipe/emailpassword/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L45) |

***

### TypeInputSignUp

```ts
type TypeInputSignUp = object;
```

Defined in: [recipe/emailpassword/types.ts:51](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L51)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="formfields"></a> `formFields?` | [`TypeInputFormField`](#typeinputformfield)[] | [recipe/emailpassword/types.ts:52](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L52) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/emailpassword/types.ts:27](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L27)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getemaildeliveryconfig"></a> `getEmailDeliveryConfig` | (`isInServerlessEnv`) => `EmailDeliveryTypeInputWithService`\<[`TypeEmailPasswordEmailDeliveryInput`](#typeemailpasswordemaildeliveryinput)\> | [recipe/emailpassword/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L30) |
| <a id="override-1"></a> `override` | `object` | [recipe/emailpassword/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L34) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/emailpassword/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L39) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/emailpassword/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L35) |
| <a id="resetpasswordusingtokenfeature"></a> `resetPasswordUsingTokenFeature` | [`TypeNormalisedInputResetPasswordUsingTokenFeature`](#typenormalisedinputresetpasswordusingtokenfeature-1) | [recipe/emailpassword/types.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L33) |
| <a id="signinfeature"></a> `signInFeature` | [`TypeNormalisedInputSignIn`](#typenormalisedinputsignin) | [recipe/emailpassword/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L29) |
| <a id="signupfeature-1"></a> `signUpFeature` | [`TypeNormalisedInputSignUp`](#typenormalisedinputsignup) | [recipe/emailpassword/types.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L28) |

***

### TypeNormalisedInputResetPasswordUsingTokenFeature

```ts
type TypeNormalisedInputResetPasswordUsingTokenFeature = object;
```

Defined in: [recipe/emailpassword/types.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L69)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="formfieldsforgeneratetokenform"></a> `formFieldsForGenerateTokenForm` | [`NormalisedFormField`](#normalisedformfield)[] | [recipe/emailpassword/types.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L70) |
| <a id="formfieldsforpasswordresetform"></a> `formFieldsForPasswordResetForm` | [`NormalisedFormField`](#normalisedformfield)[] | [recipe/emailpassword/types.ts:71](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L71) |

***

### TypeNormalisedInputSignIn

```ts
type TypeNormalisedInputSignIn = object;
```

Defined in: [recipe/emailpassword/types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L65)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="formfields-1"></a> `formFields` | [`NormalisedFormField`](#normalisedformfield)[] | [recipe/emailpassword/types.ts:66](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L66) |

***

### TypeNormalisedInputSignUp

```ts
type TypeNormalisedInputSignUp = object;
```

Defined in: [recipe/emailpassword/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L61)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="formfields-2"></a> `formFields` | [`NormalisedFormField`](#normalisedformfield)[] | [recipe/emailpassword/types.ts:62](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/types.ts#L62) |

# References - Backend SDKs - Node.js SDK Reference -  EmailPassword
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-emailpassword

## Classes

### default

Defined in: [recipe/emailpassword/index.ts:27](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L27)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="error"></a> `Error` | `static` | *typeof* `default` | `SuperTokensError` | [recipe/emailpassword/index.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L30) |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/emailpassword/index.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L28) |

#### Methods

##### consumePasswordResetToken()

```ts
static consumePasswordResetToken(
   tenantId, 
   token, 
   userContext?): Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
  | {
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:236](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L236)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `token` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
  `userId`: `string`;
\}
  \| \{
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}\>

##### createResetPasswordLink()

```ts
static createResetPasswordLink(
   tenantId, 
   userId, 
   email, 
   userContext?): Promise<
  | {
  link: string;
  status: "OK";
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:280](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L280)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `email` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `link`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

##### createResetPasswordToken()

```ts
static createResetPasswordToken(
   tenantId, 
   userId, 
   email, 
   userContext?): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:183](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L183)

We do not make email optional here cause we want to
allow passing in primaryUserId. If we make email optional,
and if the user provides a primaryUserId, then it may result in two problems:
 - there is no recipeUserId = input primaryUserId, in this case,
   this function will throw an error
 - There is a recipe userId = input primaryUserId, but that recipe has no email,
   or has wrong email compared to what the user wanted to generate a reset token for.

And we want to allow primaryUserId being passed in.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `email` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

##### resetPasswordUsingToken()

```ts
static resetPasswordUsingToken(
   tenantId, 
   token, 
   newPassword, 
   userContext?): Promise<
  | {
  status: "OK" | "UNKNOWN_USER_ID_ERROR" | "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}
  | {
  failureReason: string;
  status: "PASSWORD_POLICY_VIOLATED_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:197](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L197)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `token` | `string` |
| `newPassword` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"` \| `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}
  \| \{
  `failureReason`: `string`;
  `status`: `"PASSWORD_POLICY_VIOLATED_ERROR"`;
\}\>

##### sendEmail()

```ts
static sendEmail(input): Promise<void>;
```

Defined in: [recipe/emailpassword/index.ts:343](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L343)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypeEmailPasswordPasswordResetEmailDeliveryInput`](recipe-emailpassword-types.mdx#typeemailpasswordpasswordresetemaildeliveryinput) & `object` |

###### Returns

`Promise`\<`void`\>

##### sendResetPasswordEmail()

```ts
static sendResetPasswordEmail(
   tenantId, 
   userId, 
   email, 
   userContext?): Promise<{
  status: "OK" | "UNKNOWN_USER_ID_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:305](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L305)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `email` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}\>

##### signIn()

###### Call Signature

```ts
static signIn(
   tenantId, 
   email, 
   password, 
   session?, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L100)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session?` | `undefined` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}\>

###### Call Signature

```ts
static signIn(
   tenantId, 
   email, 
   password, 
   session, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/emailpassword/index.ts:107](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L107)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

##### signUp()

###### Call Signature

```ts
static signUp(
   tenantId, 
   email, 
   password, 
   session?, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L32)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session?` | `undefined` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}\>

###### Call Signature

```ts
static signUp(
   tenantId, 
   email, 
   password, 
   session, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/emailpassword/index.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L46)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

##### updateEmailOrPassword()

```ts
static updateEmailOrPassword(input): Promise<
  | {
  status: "OK" | "EMAIL_ALREADY_EXISTS_ERROR" | "UNKNOWN_USER_ID_ERROR";
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  failureReason: string;
  status: "PASSWORD_POLICY_VIOLATED_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:255](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L255)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `applyPasswordPolicy?`: `boolean`; `email?`: `string`; `password?`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `tenantIdForPasswordPolicy?`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.applyPasswordPolicy?` | `boolean` |
| `input.email?` | `string` |
| `input.password?` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.tenantIdForPasswordPolicy?` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"EMAIL_ALREADY_EXISTS_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `failureReason`: `string`;
  `status`: `"PASSWORD_POLICY_VIOLATED_ERROR"`;
\}\>

##### verifyCredentials()

```ts
static verifyCredentials(
   tenantId, 
   email, 
   password, 
   userContext?): Promise<{
  status: "OK" | "WRONG_CREDENTIALS_ERROR";
}>;
```

Defined in: [recipe/emailpassword/index.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L153)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"WRONG_CREDENTIALS_ERROR"`;
\}\>

## Variables

### consumePasswordResetToken()

```ts
consumePasswordResetToken: (tenantId, token, userContext?) => Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
  | {
  status: "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}> = Wrapper.consumePasswordResetToken;
```

Defined in: [recipe/emailpassword/index.ts:369](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L369)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `token` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
  `userId`: `string`;
\}
  \| \{
  `status`: `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}\>

***

### createResetPasswordLink()

```ts
createResetPasswordLink: (tenantId, userId, email, userContext?) => Promise<
  | {
  link: string;
  status: "OK";
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}> = Wrapper.createResetPasswordLink;
```

Defined in: [recipe/emailpassword/index.ts:375](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L375)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `email` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `link`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

***

### createResetPasswordToken()

```ts
createResetPasswordToken: (tenantId, userId, email, userContext?) => Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}> = Wrapper.createResetPasswordToken;
```

Defined in: [recipe/emailpassword/index.ts:365](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L365)

We do not make email optional here cause we want to
allow passing in primaryUserId. If we make email optional,
and if the user provides a primaryUserId, then it may result in two problems:
 - there is no recipeUserId = input primaryUserId, in this case,
   this function will throw an error
 - There is a recipe userId = input primaryUserId, but that recipe has no email,
   or has wrong email compared to what the user wanted to generate a reset token for.

And we want to allow primaryUserId being passed in.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `email` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

***

### Error

```ts
Error: typeof default = Wrapper.Error;
```

Defined in: [recipe/emailpassword/index.ts:357](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L357)

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/emailpassword/index.ts:355](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L355)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-emailpassword-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### resetPasswordUsingToken()

```ts
resetPasswordUsingToken: (tenantId, token, newPassword, userContext?) => Promise<
  | {
  status: "OK" | "UNKNOWN_USER_ID_ERROR" | "RESET_PASSWORD_INVALID_TOKEN_ERROR";
}
  | {
  failureReason: string;
  status: "PASSWORD_POLICY_VIOLATED_ERROR";
}> = Wrapper.resetPasswordUsingToken;
```

Defined in: [recipe/emailpassword/index.ts:367](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L367)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `token` | `string` |
| `newPassword` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"` \| `"RESET_PASSWORD_INVALID_TOKEN_ERROR"`;
\}
  \| \{
  `failureReason`: `string`;
  `status`: `"PASSWORD_POLICY_VIOLATED_ERROR"`;
\}\>

***

### sendEmail()

```ts
sendEmail: (input) => Promise<void> = Wrapper.sendEmail;
```

Defined in: [recipe/emailpassword/index.ts:379](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L379)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypeEmailPasswordPasswordResetEmailDeliveryInput`](recipe-emailpassword-types.mdx#typeemailpasswordpasswordresetemaildeliveryinput) & `object` |

#### Returns

`Promise`\<`void`\>

***

### sendResetPasswordEmail()

```ts
sendResetPasswordEmail: (tenantId, userId, email, userContext?) => Promise<{
  status: "OK" | "UNKNOWN_USER_ID_ERROR";
}> = Wrapper.sendResetPasswordEmail;
```

Defined in: [recipe/emailpassword/index.ts:377](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L377)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `email` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}\>

***

### signIn()

```ts
signIn: {
  (tenantId, email, password, session?, userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}>;
  (tenantId, email, password, session, userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
} = Wrapper.signIn;
```

Defined in: [recipe/emailpassword/index.ts:361](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L361)

#### Call Signature

```ts
(
   tenantId, 
   email, 
   password, 
   session?, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}>;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session?` | `undefined` |
| `userContext?` | `Record`\<`string`, `any`\> |

##### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}\>

#### Call Signature

```ts
(
   tenantId, 
   email, 
   password, 
   session, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "WRONG_CREDENTIALS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

##### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"WRONG_CREDENTIALS_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

***

### signUp()

```ts
signUp: {
  (tenantId, email, password, session?, userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}>;
  (tenantId, email, password, session, userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
} = Wrapper.signUp;
```

Defined in: [recipe/emailpassword/index.ts:359](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L359)

#### Call Signature

```ts
(
   tenantId, 
   email, 
   password, 
   session?, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}>;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session?` | `undefined` |
| `userContext?` | `Record`\<`string`, `any`\> |

##### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}\>

#### Call Signature

```ts
(
   tenantId, 
   email, 
   password, 
   session, 
   userContext?): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  status: "EMAIL_ALREADY_EXISTS_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

##### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

***

### updateEmailOrPassword()

```ts
updateEmailOrPassword: (input) => Promise<
  | {
  status: "OK" | "EMAIL_ALREADY_EXISTS_ERROR" | "UNKNOWN_USER_ID_ERROR";
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  failureReason: string;
  status: "PASSWORD_POLICY_VIOLATED_ERROR";
}> = Wrapper.updateEmailOrPassword;
```

Defined in: [recipe/emailpassword/index.ts:371](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L371)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `applyPasswordPolicy?`: `boolean`; `email?`: `string`; `password?`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `tenantIdForPasswordPolicy?`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.applyPasswordPolicy?` | `boolean` |
| `input.email?` | `string` |
| `input.password?` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.tenantIdForPasswordPolicy?` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"EMAIL_ALREADY_EXISTS_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `failureReason`: `string`;
  `status`: `"PASSWORD_POLICY_VIOLATED_ERROR"`;
\}\>

***

### verifyCredentials()

```ts
verifyCredentials: (tenantId, email, password, userContext?) => Promise<{
  status: "OK" | "WRONG_CREDENTIALS_ERROR";
}> = Wrapper.verifyCredentials;
```

Defined in: [recipe/emailpassword/index.ts:363](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailpassword/index.ts#L363)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `email` | `string` |
| `password` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"WRONG_CREDENTIALS_ERROR"`;
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-emailpassword-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-emailpassword-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-emailpassword-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  Passwordless Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-passwordless-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/passwordless/types.ts:335](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L335)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="consumecodepost"></a> `consumeCodePOST?` | (`input`) => `Promise`\< \| \{ `createdNewRecipeUser`: `boolean`; `session`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `failedCodeInputAttemptCount`: `number`; `maximumCodeInputAttempts`: `number`; `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`; \} \| \{ `status`: `"RESTART_FLOW_ERROR"`; \} \| \{ `reason`: `string`; `status`: `"SIGN_IN_UP_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/passwordless/types.ts:368](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L368) |
| <a id="createcodepost"></a> `createCodePOST?` | (`input`) => `Promise`\< \| \{ `deviceId`: `string`; `flowType`: `"USER_INPUT_CODE"` \| `"MAGIC_LINK"` \| `"USER_INPUT_CODE_AND_MAGIC_LINK"`; `preAuthSessionId`: `string`; `status`: `"OK"`; \} \| \{ `reason`: `string`; `status`: `"SIGN_IN_UP_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/passwordless/types.ts:336](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L336) |
| <a id="emailexistsget"></a> `emailExistsGET?` | (`input`) => `Promise`\< \| \{ `exists`: `boolean`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/passwordless/types.ts:406](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L406) |
| <a id="phonenumberexistsget"></a> `phoneNumberExistsGET?` | (`input`) => `Promise`\< \| \{ `exists`: `boolean`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/passwordless/types.ts:419](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L419) |
| <a id="resendcodepost"></a> `resendCodePOST?` | (`input`) => `Promise`\< \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| \{ `status`: `"RESTART_FLOW_ERROR"` \| `"OK"`; \}\> | [recipe/passwordless/types.ts:358](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L358) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/passwordless/types.ts:323](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L323)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types.mdx#normalisedappinfo) | [recipe/passwordless/types.ts:325](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L325) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/passwordless/types.ts:326](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L326) |
| <a id="emaildelivery"></a> `emailDelivery` | `EmailDeliveryIngredient`\<[`TypePasswordlessEmailDeliveryInput`](#typepasswordlessemaildeliveryinput)\> | [recipe/passwordless/types.ts:331](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L331) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/passwordless/types.ts:328](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L328) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/passwordless/types.ts:327](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L327) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/passwordless/types.ts:324](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L324) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/passwordless/types.ts:329](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L329) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/passwordless/types.ts:330](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L330) |
| <a id="smsdelivery"></a> `smsDelivery` | `SmsDeliveryIngredient`\<[`TypePasswordlessSmsDeliveryInput`](#typepasswordlesssmsdeliveryinput)\> | [recipe/passwordless/types.ts:332](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L332) |

***

### DeviceType

```ts
type DeviceType = object;
```

Defined in: [recipe/passwordless/types.ts:308](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L308)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="codes"></a> `codes` | `object`[] | [recipe/passwordless/types.ts:316](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L316) |
| <a id="email"></a> `email?` | `string` | [recipe/passwordless/types.ts:313](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L313) |
| <a id="failedcodeinputattemptcount"></a> `failedCodeInputAttemptCount` | `number` | [recipe/passwordless/types.ts:311](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L311) |
| <a id="phonenumber"></a> `phoneNumber?` | `string` | [recipe/passwordless/types.ts:314](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L314) |
| <a id="preauthsessionid"></a> `preAuthSessionId` | `string` | [recipe/passwordless/types.ts:309](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L309) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/passwordless/types.ts:110](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L110)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="checkcode"></a> `checkCode` | (`input`) => `Promise`\< \| \{ `consumedDevice`: \{ `email?`: `string`; `failedCodeInputAttemptCount`: `number`; `phoneNumber?`: `string`; `preAuthSessionId`: `string`; \}; `status`: `"OK"`; \} \| \{ `failedCodeInputAttemptCount`: `number`; `maximumCodeInputAttempts`: `number`; `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`; \} \| \{ `status`: `"RESTART_FLOW_ERROR"`; \}\> | [recipe/passwordless/types.ts:203](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L203) |
| <a id="consumecode"></a> `consumeCode` | (`input`) => `Promise`\< \| \{ `consumedDevice`: \{ `email?`: `string`; `failedCodeInputAttemptCount`: `number`; `phoneNumber?`: `string`; `preAuthSessionId`: `string`; \}; `createdNewRecipeUser`: `boolean`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `failedCodeInputAttemptCount`: `number`; `maximumCodeInputAttempts`: `number`; `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`; \} \| \{ `status`: `"RESTART_FLOW_ERROR"`; \} \| \{ `reason`: \| `"EMAIL_VERIFICATION_REQUIRED"` \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"` \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"` \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; `status`: `"LINKING_TO_SESSION_USER_FAILED"`; \}\> | [recipe/passwordless/types.ts:155](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L155) |
| <a id="createcode"></a> `createCode` | (`input`) => `Promise`\<\{ `codeId`: `string`; `codeLifetime`: `number`; `deviceId`: `string`; `linkCode`: `string`; `preAuthSessionId`: `string`; `status`: `"OK"`; `timeCreated`: `number`; `userInputCode`: `string`; \}\> | [recipe/passwordless/types.ts:111](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L111) |
| <a id="createnewcodefordevice"></a> `createNewCodeForDevice` | (`input`) => `Promise`\< \| \{ `codeId`: `string`; `codeLifetime`: `number`; `deviceId`: `string`; `linkCode`: `string`; `preAuthSessionId`: `string`; `status`: `"OK"`; `timeCreated`: `number`; `userInputCode`: `string`; \} \| \{ `status`: `"RESTART_FLOW_ERROR"` \| `"USER_INPUT_CODE_ALREADY_USED_ERROR"`; \}\> | [recipe/passwordless/types.ts:137](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L137) |
| <a id="listcodesbydeviceid"></a> `listCodesByDeviceId` | (`input`) => `Promise`\<[`DeviceType`](#devicetype) \| `undefined`\> | [recipe/passwordless/types.ts:295](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L295) |
| <a id="listcodesbyemail"></a> `listCodesByEmail` | (`input`) => `Promise`\<[`DeviceType`](#devicetype)[]\> | [recipe/passwordless/types.ts:287](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L287) |
| <a id="listcodesbyphonenumber"></a> `listCodesByPhoneNumber` | (`input`) => `Promise`\<[`DeviceType`](#devicetype)[]\> | [recipe/passwordless/types.ts:289](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L289) |
| <a id="listcodesbypreauthsessionid"></a> `listCodesByPreAuthSessionId` | (`input`) => `Promise`\<[`DeviceType`](#devicetype) \| `undefined`\> | [recipe/passwordless/types.ts:301](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L301) |
| <a id="revokeallcodes"></a> `revokeAllCodes` | (`input`) => `Promise`\<\{ `status`: `"OK"`; \}\> | [recipe/passwordless/types.ts:255](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L255) |
| <a id="revokecode"></a> `revokeCode` | (`input`) => `Promise`\<\{ `status`: `"OK"`; \}\> | [recipe/passwordless/types.ts:271](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L271) |
| <a id="updateuser"></a> `updateUser` | (`input`) => `Promise`\< \| \{ `status`: \| `"OK"` \| `"UNKNOWN_USER_ID_ERROR"` \| `"EMAIL_ALREADY_EXISTS_ERROR"` \| `"PHONE_NUMBER_ALREADY_EXISTS_ERROR"`; \} \| \{ `reason`: `string`; `status`: \| `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"` \| `"PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR"`; \}\> | [recipe/passwordless/types.ts:236](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L236) |

***

### TypeInput

```ts
type TypeInput = 
  | {
  contactMethod: "PHONE";
  validatePhoneNumber?: (phoneNumber, tenantId) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "EMAIL";
  validateEmailAddress?: (email, tenantId) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "EMAIL_OR_PHONE";
  validateEmailAddress?: (email, tenantId) => Promise<string | undefined> | string | undefined;
  validatePhoneNumber?: (phoneNumber, tenantId) => Promise<string | undefined> | string | undefined;
} & object;
```

Defined in: [recipe/passwordless/types.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L33)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `emailDelivery?` | `EmailDeliveryTypeInput`\<[`TypePasswordlessEmailDeliveryInput`](#typepasswordlessemaildeliveryinput)\> | [recipe/passwordless/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L56) |
| `flowType` | `"USER_INPUT_CODE"` \| `"MAGIC_LINK"` \| `"USER_INPUT_CODE_AND_MAGIC_LINK"` | [recipe/passwordless/types.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L54) |
| `getCustomUserInputCode()?` | (`tenantId`, `userContext`) => `Promise`\<`string`\> \| `string` | [recipe/passwordless/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L61) |
| `override?` | `object` | [recipe/passwordless/types.ts:63](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L63) |
| `override.apis()?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/passwordless/types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L68) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/passwordless/types.ts:64](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L64) |
| `smsDelivery?` | `SmsDeliveryTypeInput`\<[`TypePasswordlessSmsDeliveryInput`](#typepasswordlesssmsdeliveryinput)\> | [recipe/passwordless/types.ts:57](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L57) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = 
  | {
  contactMethod: "PHONE";
  validatePhoneNumber: (phoneNumber, tenantId) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "EMAIL";
  validateEmailAddress: (email, tenantId) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "EMAIL_OR_PHONE";
  validateEmailAddress: (email, tenantId) => Promise<string | undefined> | string | undefined;
  validatePhoneNumber: (phoneNumber, tenantId) => Promise<string | undefined> | string | undefined;
} & object;
```

Defined in: [recipe/passwordless/types.ts:72](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L72)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `flowType` | `"USER_INPUT_CODE"` \| `"MAGIC_LINK"` \| `"USER_INPUT_CODE_AND_MAGIC_LINK"` | [recipe/passwordless/types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L93) |
| `getCustomUserInputCode()?` | (`tenantId`, `userContext`) => `Promise`\<`string`\> \| `string` | [recipe/passwordless/types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L97) |
| `getEmailDeliveryConfig()` | () => `EmailDeliveryTypeInputWithService`\<[`TypePasswordlessEmailDeliveryInput`](#typepasswordlessemaildeliveryinput)\> | [recipe/passwordless/types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L100) |
| `getSmsDeliveryConfig()` | () => `SmsDeliveryTypeInputWithService`\<[`TypePasswordlessSmsDeliveryInput`](#typepasswordlesssmsdeliveryinput)\> | [recipe/passwordless/types.ts:99](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L99) |
| `override` | `object` | [recipe/passwordless/types.ts:101](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L101) |
| `override.apis()` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/passwordless/types.ts:106](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L106) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/passwordless/types.ts:102](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L102) |

***

### TypePasswordlessEmailDeliveryInput

```ts
type TypePasswordlessEmailDeliveryInput = object;
```

Defined in: [recipe/passwordless/types.ts:433](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L433)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="codelifetime"></a> `codeLifetime` | `number` | [recipe/passwordless/types.ts:439](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L439) |
| <a id="email-1"></a> `email` | `string` | [recipe/passwordless/types.ts:436](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L436) |
| <a id="isfirstfactor"></a> `isFirstFactor` | `boolean` | [recipe/passwordless/types.ts:435](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L435) |
| <a id="preauthsessionid-1"></a> `preAuthSessionId` | `string` | [recipe/passwordless/types.ts:440](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L440) |
| <a id="tenantid"></a> `tenantId` | `string` | [recipe/passwordless/types.ts:441](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L441) |
| <a id="type"></a> `type` | `"PASSWORDLESS_LOGIN"` | [recipe/passwordless/types.ts:434](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L434) |
| <a id="urlwithlinkcode"></a> `urlWithLinkCode?` | `string` | [recipe/passwordless/types.ts:438](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L438) |
| <a id="userinputcode"></a> `userInputCode?` | `string` | [recipe/passwordless/types.ts:437](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L437) |

***

### TypePasswordlessSmsDeliveryInput

```ts
type TypePasswordlessSmsDeliveryInput = object;
```

Defined in: [recipe/passwordless/types.ts:444](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L444)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="codelifetime-1"></a> `codeLifetime` | `number` | [recipe/passwordless/types.ts:450](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L450) |
| <a id="isfirstfactor-1"></a> `isFirstFactor` | `boolean` | [recipe/passwordless/types.ts:446](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L446) |
| <a id="phonenumber-1"></a> `phoneNumber` | `string` | [recipe/passwordless/types.ts:447](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L447) |
| <a id="preauthsessionid-2"></a> `preAuthSessionId` | `string` | [recipe/passwordless/types.ts:451](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L451) |
| <a id="tenantid-1"></a> `tenantId` | `string` | [recipe/passwordless/types.ts:452](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L452) |
| <a id="type-1"></a> `type` | `"PASSWORDLESS_LOGIN"` | [recipe/passwordless/types.ts:445](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L445) |
| <a id="urlwithlinkcode-1"></a> `urlWithLinkCode?` | `string` | [recipe/passwordless/types.ts:449](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L449) |
| <a id="userinputcode-1"></a> `userInputCode?` | `string` | [recipe/passwordless/types.ts:448](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/types.ts#L448) |

# References - Backend SDKs - Node.js SDK Reference -  Passwordless
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-passwordless

## Classes

### default

Defined in: [recipe/passwordless/index.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L31)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="error"></a> `Error` | `static` | *typeof* `default` | `SuperTokensError` | [recipe/passwordless/index.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L34) |
| <a id="init"></a> `init` | `static` | (`config`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/passwordless/index.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L32) |

#### Methods

##### checkCode()

```ts
static checkCode(input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  status: "OK";
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}>;
```

Defined in: [recipe/passwordless/index.ts:219](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L219)

This function will only verify the code (not consume it), and:
NOT create a new user if it doesn't exist
NOT verify the user email if it exists
NOT do any linking
NOT delete the code unless it returned RESTART_FLOW_ERROR

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `deviceId`: `string`; `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode`: `string`; \} \| \{ `linkCode`: `string`; `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<
  \| \{
  `consumedDevice`: \{
     `email?`: `string`;
     `failedCodeInputAttemptCount`: `number`;
     `phoneNumber?`: `string`;
     `preAuthSessionId`: `string`;
  \};
  `status`: `"OK"`;
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"`;
\}\>

##### consumeCode()

###### Call Signature

```ts
static consumeCode(input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}>;
```

Defined in: [recipe/passwordless/index.ts:77](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L77)

1. verifies the code
2. creates the user if it doesn't exist
3. tries to link it
4. marks the email as verified

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `deviceId`: `string`; `preAuthSessionId`: `string`; `session?`: `undefined`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode`: `string`; \} \| \{ `linkCode`: `string`; `preAuthSessionId`: `string`; `session?`: `undefined`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<
  \| \{
  `consumedDevice`: \{
     `email?`: `string`;
     `failedCodeInputAttemptCount`: `number`;
     `phoneNumber?`: `string`;
     `preAuthSessionId`: `string`;
  \};
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"`;
\}\>

###### Call Signature

```ts
static consumeCode(input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/passwordless/index.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L114)

1. verifies the code
2. creates the user if it doesn't exist
3. tries to link it
4. marks the email as verified

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `deviceId`: `string`; `preAuthSessionId`: `string`; `session`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode`: `string`; \} \| \{ `linkCode`: `string`; `preAuthSessionId`: `string`; `session`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<
  \| \{
  `consumedDevice`: \{
     `email?`: `string`;
     `failedCodeInputAttemptCount`: `number`;
     `phoneNumber?`: `string`;
     `preAuthSessionId`: `string`;
  \};
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

##### createCode()

```ts
static createCode(input): Promise<{
  codeId: string;
  codeLifetime: number;
  deviceId: string;
  linkCode: string;
  preAuthSessionId: string;
  status: "OK";
  timeCreated: number;
  userInputCode: string;
}>;
```

Defined in: [recipe/passwordless/index.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L36)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; \} \| \{ `phoneNumber`: `string`; \} & `object` |

###### Returns

`Promise`\<\{
  `codeId`: `string`;
  `codeLifetime`: `number`;
  `deviceId`: `string`;
  `linkCode`: `string`;
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
  `timeCreated`: `number`;
  `userInputCode`: `string`;
\}\>

##### createMagicLink()

```ts
static createMagicLink(input): Promise<string>;
```

Defined in: [recipe/passwordless/index.ts:331](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L331)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `phoneNumber`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<`string`\>

##### createNewCodeForDevice()

```ts
static createNewCodeForDevice(input): Promise<
  | {
  codeId: string;
  codeLifetime: number;
  deviceId: string;
  linkCode: string;
  preAuthSessionId: string;
  status: "OK";
  timeCreated: number;
  userInputCode: string;
}
  | {
  status: "RESTART_FLOW_ERROR" | "USER_INPUT_CODE_ALREADY_USED_ERROR";
}>;
```

Defined in: [recipe/passwordless/index.ts:59](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L59)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode?`: `string`; \} |
| `input.deviceId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userInputCode?` | `string` |

###### Returns

`Promise`\<
  \| \{
  `codeId`: `string`;
  `codeLifetime`: `number`;
  `deviceId`: `string`;
  `linkCode`: `string`;
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
  `timeCreated`: `number`;
  `userInputCode`: `string`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"` \| `"USER_INPUT_CODE_ALREADY_USED_ERROR"`;
\}\>

##### listCodesByDeviceId()

```ts
static listCodesByDeviceId(input): Promise<DeviceType>;
```

Defined in: [recipe/passwordless/index.ts:313](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L313)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.deviceId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)\>

##### listCodesByEmail()

```ts
static listCodesByEmail(input): Promise<DeviceType[]>;
```

Defined in: [recipe/passwordless/index.ts:299](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L299)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.email` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)[]\>

##### listCodesByPhoneNumber()

```ts
static listCodesByPhoneNumber(input): Promise<DeviceType[]>;
```

Defined in: [recipe/passwordless/index.ts:306](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L306)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `phoneNumber`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.phoneNumber` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)[]\>

##### listCodesByPreAuthSessionId()

```ts
static listCodesByPreAuthSessionId(input): Promise<DeviceType>;
```

Defined in: [recipe/passwordless/index.ts:320](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L320)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.preAuthSessionId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)\>

##### revokeAllCodes()

```ts
static revokeAllCodes(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/passwordless/index.ts:269](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L269)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `phoneNumber`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### revokeCode()

```ts
static revokeCode(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/passwordless/index.ts:288](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L288)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `codeId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### sendEmail()

```ts
static sendEmail(input): Promise<void>;
```

Defined in: [recipe/passwordless/index.ts:373](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L373)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypePasswordlessEmailDeliveryInput`](recipe-passwordless-types.mdx#typepasswordlessemaildeliveryinput) & `object` |

###### Returns

`Promise`\<`void`\>

##### sendSms()

```ts
static sendSms(input): Promise<void>;
```

Defined in: [recipe/passwordless/index.ts:380](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L380)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypePasswordlessSmsDeliveryInput`](recipe-passwordless-types.mdx#typepasswordlesssmsdeliveryinput) & `object` |

###### Returns

`Promise`\<`void`\>

##### signInUp()

```ts
static signInUp(input): Promise<{
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: string;
  user: User;
}>;
```

Defined in: [recipe/passwordless/index.ts:352](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L352)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `session?`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `phoneNumber`: `string`; `session?`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

###### Returns

`Promise`\<\{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `string`;
  `user`: [`User`](types.mdx#user);
\}\>

##### updateUser()

```ts
static updateUser(input): Promise<
  | {
  status:   | "OK"
     | "EMAIL_ALREADY_EXISTS_ERROR"
     | "UNKNOWN_USER_ID_ERROR"
     | "PHONE_NUMBER_ALREADY_EXISTS_ERROR";
}
  | {
  reason: string;
  status:   | "EMAIL_CHANGE_NOT_ALLOWED_ERROR"
     | "PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR";
}>;
```

Defined in: [recipe/passwordless/index.ts:257](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L257)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email?`: `string`; `phoneNumber?`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.email?` | `string` |
| `input.phoneNumber?` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`:   \| `"OK"`
     \| `"EMAIL_ALREADY_EXISTS_ERROR"`
     \| `"UNKNOWN_USER_ID_ERROR"`
     \| `"PHONE_NUMBER_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`:   \| `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`
     \| `"PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR"`;
\}\>

## Variables

### checkCode()

```ts
checkCode: (input) => Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  status: "OK";
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}> = Wrapper.checkCode;
```

Defined in: [recipe/passwordless/index.ts:416](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L416)

This function will only verify the code (not consume it), and:
NOT create a new user if it doesn't exist
NOT verify the user email if it exists
NOT do any linking
NOT delete the code unless it returned RESTART_FLOW_ERROR

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `deviceId`: `string`; `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode`: `string`; \} \| \{ `linkCode`: `string`; `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

#### Returns

`Promise`\<
  \| \{
  `consumedDevice`: \{
     `email?`: `string`;
     `failedCodeInputAttemptCount`: `number`;
     `phoneNumber?`: `string`;
     `preAuthSessionId`: `string`;
  \};
  `status`: `"OK"`;
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"`;
\}\>

***

### consumeCode()

```ts
consumeCode: {
  (input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}>;
  (input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
} = Wrapper.consumeCode;
```

Defined in: [recipe/passwordless/index.ts:394](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L394)

#### Call Signature

```ts
(input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}>;
```

1. verifies the code
2. creates the user if it doesn't exist
3. tries to link it
4. marks the email as verified

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `deviceId`: `string`; `preAuthSessionId`: `string`; `session?`: `undefined`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode`: `string`; \} \| \{ `linkCode`: `string`; `preAuthSessionId`: `string`; `session?`: `undefined`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

##### Returns

`Promise`\<
  \| \{
  `consumedDevice`: \{
     `email?`: `string`;
     `failedCodeInputAttemptCount`: `number`;
     `phoneNumber?`: `string`;
     `preAuthSessionId`: `string`;
  \};
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"`;
\}\>

#### Call Signature

```ts
(input): Promise<
  | {
  consumedDevice: {
     email?: string;
     failedCodeInputAttemptCount: number;
     phoneNumber?: string;
     preAuthSessionId: string;
  };
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  failedCodeInputAttemptCount: number;
  maximumCodeInputAttempts: number;
  status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR";
}
  | {
  status: "RESTART_FLOW_ERROR";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

1. verifies the code
2. creates the user if it doesn't exist
3. tries to link it
4. marks the email as verified

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `deviceId`: `string`; `preAuthSessionId`: `string`; `session`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode`: `string`; \} \| \{ `linkCode`: `string`; `preAuthSessionId`: `string`; `session`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

##### Returns

`Promise`\<
  \| \{
  `consumedDevice`: \{
     `email?`: `string`;
     `failedCodeInputAttemptCount`: `number`;
     `phoneNumber?`: `string`;
     `preAuthSessionId`: `string`;
  \};
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `failedCodeInputAttemptCount`: `number`;
  `maximumCodeInputAttempts`: `number`;
  `status`: `"INCORRECT_USER_INPUT_CODE_ERROR"` \| `"EXPIRED_USER_INPUT_CODE_ERROR"`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

***

### createCode()

```ts
createCode: (input) => Promise<{
  codeId: string;
  codeLifetime: number;
  deviceId: string;
  linkCode: string;
  preAuthSessionId: string;
  status: "OK";
  timeCreated: number;
  userInputCode: string;
}> = Wrapper.createCode;
```

Defined in: [recipe/passwordless/index.ts:392](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L392)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; \} \| \{ `phoneNumber`: `string`; \} & `object` |

#### Returns

`Promise`\<\{
  `codeId`: `string`;
  `codeLifetime`: `number`;
  `deviceId`: `string`;
  `linkCode`: `string`;
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
  `timeCreated`: `number`;
  `userInputCode`: `string`;
\}\>

***

### createMagicLink()

```ts
createMagicLink: (input) => Promise<string> = Wrapper.createMagicLink;
```

Defined in: [recipe/passwordless/index.ts:412](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L412)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `phoneNumber`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

#### Returns

`Promise`\<`string`\>

***

### createNewCodeForDevice()

```ts
createNewCodeForDevice: (input) => Promise<
  | {
  codeId: string;
  codeLifetime: number;
  deviceId: string;
  linkCode: string;
  preAuthSessionId: string;
  status: "OK";
  timeCreated: number;
  userInputCode: string;
}
  | {
  status: "RESTART_FLOW_ERROR" | "USER_INPUT_CODE_ALREADY_USED_ERROR";
}> = Wrapper.createNewCodeForDevice;
```

Defined in: [recipe/passwordless/index.ts:404](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L404)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userInputCode?`: `string`; \} |
| `input.deviceId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userInputCode?` | `string` |

#### Returns

`Promise`\<
  \| \{
  `codeId`: `string`;
  `codeLifetime`: `number`;
  `deviceId`: `string`;
  `linkCode`: `string`;
  `preAuthSessionId`: `string`;
  `status`: `"OK"`;
  `timeCreated`: `number`;
  `userInputCode`: `string`;
\}
  \| \{
  `status`: `"RESTART_FLOW_ERROR"` \| `"USER_INPUT_CODE_ALREADY_USED_ERROR"`;
\}\>

***

### Error

```ts
Error: typeof default = Wrapper.Error;
```

Defined in: [recipe/passwordless/index.ts:390](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L390)

***

### init()

```ts
init: (config) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/passwordless/index.ts:388](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L388)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`TypeInput`](recipe-passwordless-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### listCodesByDeviceId()

```ts
listCodesByDeviceId: (input) => Promise<DeviceType> = Wrapper.listCodesByDeviceId;
```

Defined in: [recipe/passwordless/index.ts:396](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L396)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `deviceId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.deviceId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)\>

***

### listCodesByEmail()

```ts
listCodesByEmail: (input) => Promise<DeviceType[]> = Wrapper.listCodesByEmail;
```

Defined in: [recipe/passwordless/index.ts:398](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L398)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.email` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)[]\>

***

### listCodesByPhoneNumber()

```ts
listCodesByPhoneNumber: (input) => Promise<DeviceType[]> = Wrapper.listCodesByPhoneNumber;
```

Defined in: [recipe/passwordless/index.ts:400](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L400)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `phoneNumber`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.phoneNumber` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)[]\>

***

### listCodesByPreAuthSessionId()

```ts
listCodesByPreAuthSessionId: (input) => Promise<DeviceType> = Wrapper.listCodesByPreAuthSessionId;
```

Defined in: [recipe/passwordless/index.ts:402](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L402)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.preAuthSessionId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`DeviceType`](recipe-passwordless-types.mdx#devicetype)\>

***

### revokeAllCodes()

```ts
revokeAllCodes: (input) => Promise<{
  status: "OK";
}> = Wrapper.revokeAllCodes;
```

Defined in: [recipe/passwordless/index.ts:408](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L408)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `phoneNumber`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### revokeCode()

```ts
revokeCode: (input) => Promise<{
  status: "OK";
}> = Wrapper.revokeCode;
```

Defined in: [recipe/passwordless/index.ts:410](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L410)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `codeId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `preAuthSessionId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### sendEmail()

```ts
sendEmail: (input) => Promise<void> = Wrapper.sendEmail;
```

Defined in: [recipe/passwordless/index.ts:420](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L420)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypePasswordlessEmailDeliveryInput`](recipe-passwordless-types.mdx#typepasswordlessemaildeliveryinput) & `object` |

#### Returns

`Promise`\<`void`\>

***

### sendSms()

```ts
sendSms: (input) => Promise<void> = Wrapper.sendSms;
```

Defined in: [recipe/passwordless/index.ts:422](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L422)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypePasswordlessSmsDeliveryInput`](recipe-passwordless-types.mdx#typepasswordlesssmsdeliveryinput) & `object` |

#### Returns

`Promise`\<`void`\>

***

### signInUp()

```ts
signInUp: (input) => Promise<{
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: string;
  user: User;
}> = Wrapper.signInUp;
```

Defined in: [recipe/passwordless/index.ts:414](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L414)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `email`: `string`; `session?`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} \| \{ `phoneNumber`: `string`; `session?`: `SessionContainerInterface`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |

#### Returns

`Promise`\<\{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `string`;
  `user`: [`User`](types.mdx#user);
\}\>

***

### updateUser()

```ts
updateUser: (input) => Promise<
  | {
  status:   | "OK"
     | "EMAIL_ALREADY_EXISTS_ERROR"
     | "UNKNOWN_USER_ID_ERROR"
     | "PHONE_NUMBER_ALREADY_EXISTS_ERROR";
}
  | {
  reason: string;
  status:   | "EMAIL_CHANGE_NOT_ALLOWED_ERROR"
     | "PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR";
}> = Wrapper.updateUser;
```

Defined in: [recipe/passwordless/index.ts:406](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/passwordless/index.ts#L406)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email?`: `string`; `phoneNumber?`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.email?` | `string` |
| `input.phoneNumber?` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`:   \| `"OK"`
     \| `"EMAIL_ALREADY_EXISTS_ERROR"`
     \| `"UNKNOWN_USER_ID_ERROR"`
     \| `"PHONE_NUMBER_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`:   \| `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`
     \| `"PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR"`;
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-passwordless-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-passwordless-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-passwordless-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  ThirdParty Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-thirdparty-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/thirdparty/types.ts:253](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L253)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appleredirecthandlerpost"></a> `appleRedirectHandlerPOST` | `undefined` \| (`input`) => `Promise`\<`void`\> | [recipe/thirdparty/types.ts:313](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L313) |
| <a id="authorisationurlget"></a> `authorisationUrlGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `pkceCodeVerifier?`: `string`; `status`: `"OK"`; `urlWithQueryParams`: `string`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/thirdparty/types.ts:254](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L254) |
| <a id="signinuppost"></a> `signInUpPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `createdNewRecipeUser`: `boolean`; `oAuthTokens`: \{ \[`key`: `string`\]: `any`; \}; `rawUserInfoFromProvider`: \{ `fromIdTokenPayload?`: \{ \[`key`: `string`\]: `any`; \}; `fromUserInfoAPI?`: \{ \[`key`: `string`\]: `any`; \}; \}; `session`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `status`: `"NO_EMAIL_GIVEN_BY_PROVIDER"`; \} \| \{ `reason`: `string`; `status`: `"SIGN_IN_UP_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/thirdparty/types.ts:271](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L271) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/thirdparty/types.ts:242](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L242)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types.mdx#normalisedappinfo) | [recipe/thirdparty/types.ts:250](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L250) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/thirdparty/types.ts:244](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L244) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/thirdparty/types.ts:246](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L246) |
| <a id="providers"></a> `providers` | [`ProviderInput`](#providerinput)[] | [recipe/thirdparty/types.ts:247](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L247) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/thirdparty/types.ts:245](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L245) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/thirdparty/types.ts:243](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L243) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/thirdparty/types.ts:248](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L248) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/thirdparty/types.ts:249](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L249) |

***

### ProviderClientConfig

```ts
type ProviderClientConfig = object;
```

Defined in: [recipe/thirdparty/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L42)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="additionalconfig"></a> `additionalConfig?` | `object` | [recipe/thirdparty/types.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L48) |
| <a id="clientid"></a> `clientId` | `string` | [recipe/thirdparty/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L44) |
| <a id="clientsecret"></a> `clientSecret?` | `string` | [recipe/thirdparty/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L45) |
| <a id="clienttype"></a> `clientType?` | `string` | [recipe/thirdparty/types.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L43) |
| <a id="forcepkce"></a> `forcePKCE?` | `boolean` | [recipe/thirdparty/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L47) |
| <a id="scope"></a> `scope?` | `string`[] | [recipe/thirdparty/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L46) |

***

### ProviderConfig

```ts
type ProviderConfig = CommonProviderConfig & object;
```

Defined in: [recipe/thirdparty/types.ts:119](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L119)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clients?` | [`ProviderClientConfig`](#providerclientconfig)[] | [recipe/thirdparty/types.ts:120](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L120) |

***

### ProviderConfigForClientType

```ts
type ProviderConfigForClientType = ProviderClientConfig & CommonProviderConfig;
```

Defined in: [recipe/thirdparty/types.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L94)

***

### ProviderInput

```ts
type ProviderInput = object;
```

Defined in: [recipe/thirdparty/types.ts:123](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L123)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-1"></a> `config` | [`ProviderConfig`](#providerconfig) | [recipe/thirdparty/types.ts:124](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L124) |
| <a id="includeinnonpublictenantsbydefault"></a> `includeInNonPublicTenantsByDefault?` | `boolean` | [recipe/thirdparty/types.ts:125](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L125) |
| <a id="override"></a> `override?` | (`originalImplementation`) => [`TypeProvider`](#typeprovider) | [recipe/thirdparty/types.ts:126](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L126) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/thirdparty/types.ts:159](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L159)

#### Methods

##### getProvider()

```ts
getProvider(input): Promise<TypeProvider>;
```

Defined in: [recipe/thirdparty/types.ts:160](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L160)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `clientType?`: `string`; `tenantId`: `string`; `thirdPartyId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.clientType?` | `string` |
| `input.tenantId` | `string` |
| `input.thirdPartyId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<[`TypeProvider`](#typeprovider)\>

##### manuallyCreateOrUpdateUser()

```ts
manuallyCreateOrUpdateUser(input): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/thirdparty/types.ts:207](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L207)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `isVerified`: `boolean`; `session`: `SessionContainerInterface` \| `undefined`; `shouldTryLinkingWithSessionUser`: `boolean` \| `undefined`; `tenantId`: `string`; `thirdPartyId`: `string`; `thirdPartyUserId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.isVerified` | `boolean` |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` \| `undefined` |
| `input.tenantId` | `string` |
| `input.thirdPartyId` | `string` |
| `input.thirdPartyUserId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

##### signInUp()

```ts
signInUp(input): Promise<
  | {
  createdNewRecipeUser: boolean;
  oAuthTokens: {
   [key: string]: any;
  };
  rawUserInfoFromProvider: {
     fromIdTokenPayload?: {
      [key: string]: any;
     };
     fromUserInfoAPI?: {
      [key: string]: any;
     };
  };
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/thirdparty/types.ts:167](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L167)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `isVerified`: `boolean`; `oAuthTokens`: \{ \[`key`: `string`\]: `any`; \}; `rawUserInfoFromProvider`: \{ `fromIdTokenPayload?`: \{ \[`key`: `string`\]: `any`; \}; `fromUserInfoAPI?`: \{ \[`key`: `string`\]: `any`; \}; \}; `session`: `SessionContainerInterface` \| `undefined`; `shouldTryLinkingWithSessionUser`: `boolean` \| `undefined`; `tenantId`: `string`; `thirdPartyId`: `string`; `thirdPartyUserId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.isVerified` | `boolean` |
| `input.oAuthTokens` | \{ \[`key`: `string`\]: `any`; \} |
| `input.rawUserInfoFromProvider` | \{ `fromIdTokenPayload?`: \{ \[`key`: `string`\]: `any`; \}; `fromUserInfoAPI?`: \{ \[`key`: `string`\]: `any`; \}; \} |
| `input.rawUserInfoFromProvider.fromIdTokenPayload?` | \{ \[`key`: `string`\]: `any`; \} |
| `input.rawUserInfoFromProvider.fromUserInfoAPI?` | \{ \[`key`: `string`\]: `any`; \} |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` \| `undefined` |
| `input.tenantId` | `string` |
| `input.thirdPartyId` | `string` |
| `input.thirdPartyUserId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `oAuthTokens`: \{
   \[`key`: `string`\]: `any`;
  \};
  `rawUserInfoFromProvider`: \{
     `fromIdTokenPayload?`: \{
      \[`key`: `string`\]: `any`;
     \};
     `fromUserInfoAPI?`: \{
      \[`key`: `string`\]: `any`;
     \};
  \};
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/thirdparty/types.ts:137](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L137)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override?` | `object` | [recipe/thirdparty/types.ts:139](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L139) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/thirdparty/types.ts:144](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L144) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/thirdparty/types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L140) |
| <a id="signinandupfeature"></a> `signInAndUpFeature?` | [`TypeInputSignInAndUp`](#typeinputsigninandup) | [recipe/thirdparty/types.ts:138](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L138) |

***

### TypeInputSignInAndUp

```ts
type TypeInputSignInAndUp = object;
```

Defined in: [recipe/thirdparty/types.ts:129](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L129)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="providers-1"></a> `providers?` | [`ProviderInput`](#providerinput)[] | [recipe/thirdparty/types.ts:130](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L130) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/thirdparty/types.ts:148](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L148)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-2"></a> `override` | `object` | [recipe/thirdparty/types.ts:150](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L150) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/thirdparty/types.ts:155](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L155) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/thirdparty/types.ts:151](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L151) |
| <a id="signinandupfeature-1"></a> `signInAndUpFeature` | [`TypeNormalisedInputSignInAndUp`](#typenormalisedinputsigninandup) | [recipe/thirdparty/types.ts:149](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L149) |

***

### TypeNormalisedInputSignInAndUp

```ts
type TypeNormalisedInputSignInAndUp = object;
```

Defined in: [recipe/thirdparty/types.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L133)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="providers-2"></a> `providers` | [`ProviderInput`](#providerinput)[] | [recipe/thirdparty/types.ts:134](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L134) |

***

### TypeProvider

```ts
type TypeProvider = object;
```

Defined in: [recipe/thirdparty/types.ts:96](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L96)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config-2"></a> `config` | [`ProviderConfigForClientType`](#providerconfigforclienttype) | [recipe/thirdparty/types.ts:98](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L98) |
| <a id="exchangeauthcodeforoauthtokens"></a> `exchangeAuthCodeForOAuthTokens` | (`input`) => `Promise`\<`any`\> | [recipe/thirdparty/types.ts:108](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L108) |
| <a id="getauthorisationredirecturl"></a> `getAuthorisationRedirectURL` | (`input`) => `Promise`\<\{ `pkceCodeVerifier?`: `string`; `urlWithQueryParams`: `string`; \}\> | [recipe/thirdparty/types.ts:104](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L104) |
| <a id="getconfigforclienttype"></a> `getConfigForClientType` | (`input`) => `Promise`\<[`ProviderConfigForClientType`](#providerconfigforclienttype)\> | [recipe/thirdparty/types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L100) |
| <a id="getuserinfo"></a> `getUserInfo` | (`input`) => `Promise`\<[`UserInfo`](#userinfo)\> | [recipe/thirdparty/types.ts:116](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L116) |
| <a id="id"></a> `id` | `string` | [recipe/thirdparty/types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L97) |

***

### UserInfo

```ts
type UserInfo = object;
```

Defined in: [recipe/thirdparty/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L23)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email"></a> `email?` | `object` | [recipe/thirdparty/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L25) |
| `email.id` | `string` | [recipe/thirdparty/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L25) |
| `email.isVerified` | `boolean` | [recipe/thirdparty/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L25) |
| <a id="rawuserinfofromprovider"></a> `rawUserInfoFromProvider` | `object` | [recipe/thirdparty/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L26) |
| `rawUserInfoFromProvider.fromIdTokenPayload?` | `object` | [recipe/thirdparty/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L26) |
| `rawUserInfoFromProvider.fromUserInfoAPI?` | `object` | [recipe/thirdparty/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L26) |
| <a id="thirdpartyuserid"></a> `thirdPartyUserId` | `string` | [recipe/thirdparty/types.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L24) |

***

### UserInfoMap

```ts
type UserInfoMap = object;
```

Defined in: [recipe/thirdparty/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="fromidtokenpayload"></a> `fromIdTokenPayload?` | `object` | [recipe/thirdparty/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L30) |
| `fromIdTokenPayload.email?` | `string` | [recipe/thirdparty/types.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L32) |
| `fromIdTokenPayload.emailVerified?` | `string` | [recipe/thirdparty/types.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L33) |
| `fromIdTokenPayload.userId?` | `string` | [recipe/thirdparty/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L31) |
| <a id="fromuserinfoapi"></a> `fromUserInfoAPI?` | `object` | [recipe/thirdparty/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L35) |
| `fromUserInfoAPI.email?` | `string` | [recipe/thirdparty/types.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L37) |
| `fromUserInfoAPI.emailVerified?` | `string` | [recipe/thirdparty/types.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L38) |
| `fromUserInfoAPI.userId?` | `string` | [recipe/thirdparty/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/types.ts#L36) |

# References - Backend SDKs - Node.js SDK Reference -  ThirdParty
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-thirdparty

## Classes

### default

Defined in: [recipe/thirdparty/index.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L25)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="error"></a> `Error` | `static` | *typeof* `default` | `SuperTokensError` | [recipe/thirdparty/index.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L28) |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/thirdparty/index.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L26) |

#### Methods

##### getProvider()

```ts
static getProvider(
   tenantId, 
   thirdPartyId, 
   clientType, 
userContext?): Promise<TypeProvider>;
```

Defined in: [recipe/thirdparty/index.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L30)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `clientType` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`TypeProvider`](recipe-thirdparty-types.mdx#typeprovider)\>

##### manuallyCreateOrUpdateUser()

###### Call Signature

```ts
static manuallyCreateOrUpdateUser(
   tenantId, 
   thirdPartyId, 
   thirdPartyUserId, 
   email, 
   isVerified, 
   session?, 
   userContext?): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

Defined in: [recipe/thirdparty/index.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L44)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `thirdPartyUserId` | `string` |
| `email` | `string` |
| `isVerified` | `boolean` |
| `session?` | `undefined` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

###### Call Signature

```ts
static manuallyCreateOrUpdateUser(
   tenantId, 
   thirdPartyId, 
   thirdPartyUserId, 
   email, 
   isVerified, 
   session, 
   userContext?): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

Defined in: [recipe/thirdparty/index.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L68)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `thirdPartyUserId` | `string` |
| `email` | `string` |
| `isVerified` | `boolean` |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

## Variables

### Error

```ts
Error: typeof default = Wrapper.Error;
```

Defined in: [recipe/thirdparty/index.ts:147](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L147)

***

### getProvider()

```ts
getProvider: (tenantId, thirdPartyId, clientType, userContext?) => Promise<TypeProvider> = Wrapper.getProvider;
```

Defined in: [recipe/thirdparty/index.ts:149](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L149)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `clientType` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`TypeProvider`](recipe-thirdparty-types.mdx#typeprovider)\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/thirdparty/index.ts:145](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L145)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-thirdparty-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### manuallyCreateOrUpdateUser()

```ts
manuallyCreateOrUpdateUser: {
  (tenantId, thirdPartyId, thirdPartyUserId, email, isVerified, session?, userContext?): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
  (tenantId, thirdPartyId, thirdPartyUserId, email, isVerified, session, userContext?): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
} = Wrapper.manuallyCreateOrUpdateUser;
```

Defined in: [recipe/thirdparty/index.ts:151](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/thirdparty/index.ts#L151)

#### Call Signature

```ts
(
   tenantId, 
   thirdPartyId, 
   thirdPartyUserId, 
   email, 
   isVerified, 
   session?, 
   userContext?): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}>;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `thirdPartyUserId` | `string` |
| `email` | `string` |
| `isVerified` | `boolean` |
| `session?` | `undefined` |
| `userContext?` | `Record`\<`string`, `any`\> |

##### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}\>

#### Call Signature

```ts
(
   tenantId, 
   thirdPartyId, 
   thirdPartyUserId, 
   email, 
   isVerified, 
   session, 
   userContext?): Promise<
  | {
  createdNewRecipeUser: boolean;
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | {
  reason: string;
  status: "EMAIL_CHANGE_NOT_ALLOWED_ERROR";
}
  | {
  reason: string;
  status: "SIGN_IN_UP_NOT_ALLOWED";
}
  | {
  reason:   | "EMAIL_VERIFICATION_REQUIRED"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  status: "LINKING_TO_SESSION_USER_FAILED";
}>;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `thirdPartyUserId` | `string` |
| `email` | `string` |
| `isVerified` | `boolean` |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

##### Returns

`Promise`\<
  \| \{
  `createdNewRecipeUser`: `boolean`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `reason`: `string`;
  `status`: `"EMAIL_CHANGE_NOT_ALLOWED_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"SIGN_IN_UP_NOT_ALLOWED"`;
\}
  \| \{
  `reason`:   \| `"EMAIL_VERIFICATION_REQUIRED"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `status`: `"LINKING_TO_SESSION_USER_FAILED"`;
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-thirdparty-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-thirdparty-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-thirdparty-types.mdx#recipeinterface)

***

### TypeProvider

Re-exports [TypeProvider](recipe-thirdparty-types.mdx#typeprovider)

# References - Backend SDKs - Node.js SDK Reference -  WebAuthn Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-webauthn-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/webauthn/types.ts:477](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L477)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailexistsget"></a> `emailExistsGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `exists`: `boolean`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/webauthn/types.ts:655](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L655) |
| <a id="generaterecoveraccounttokenpost"></a> `generateRecoverAccountTokenPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `GenerateRecoverAccountTokenPOSTErrorResponse`\> | [recipe/webauthn/types.ts:580](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L580) |
| <a id="listcredentialsget"></a> `listCredentialsGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `credentials`: `object`[]; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/webauthn/types.ts:609](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L609) |
| <a id="recoveraccountpost"></a> `recoverAccountPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `email`: `string`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `RecoverAccountPOSTErrorResponse`\> | [recipe/webauthn/types.ts:590](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L590) |
| <a id="registercredentialpost"></a> `registerCredentialPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `RegisterCredentialPOSTErrorResponse`\> | [recipe/webauthn/types.ts:623](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L623) |
| <a id="registeroptionspost"></a> `registerOptionsPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `attestation`: `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"`; `authenticatorSelection`: \{ `requireResidentKey`: `boolean`; `residentKey`: [`ResidentKey`](#residentkey); `userVerification`: [`UserVerification`](#userverification); \}; `challenge`: `string`; `createdAt`: `number`; `excludeCredentials`: `object`[]; `expiresAt`: `number`; `pubKeyCredParams`: `object`[]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `status`: `"OK"`; `timeout`: `number`; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; `webauthnGeneratedOptionsId`: `string`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `RegisterOptionsPOSTErrorResponse`\> | [recipe/webauthn/types.ts:478](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L478) |
| <a id="removecredentialpost"></a> `removeCredentialPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `RemoveCredentialPOSTErrorResponse`\> | [recipe/webauthn/types.ts:640](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L640) |
| <a id="signinoptionspost"></a> `signInOptionsPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `challenge`: `string`; `createdAt`: `number`; `expiresAt`: `number`; `rpId`: `string`; `status`: `"OK"`; `timeout`: `number`; `userVerification`: [`UserVerification`](#userverification); `webauthnGeneratedOptionsId`: `string`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `SignInOptionsPOSTErrorResponse`\> | [recipe/webauthn/types.ts:523](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L523) |
| <a id="signinpost"></a> `signInPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `session`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `SignInPOSTErrorResponse`\> | [recipe/webauthn/types.ts:560](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L560) |
| <a id="signuppost"></a> `signUpPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `session`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| `SignUpPOSTErrorResponse`\> | [recipe/webauthn/types.ts:540](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L540) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/webauthn/types.ts:420](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L420)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types.mdx#normalisedappinfo) | [recipe/webauthn/types.ts:422](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L422) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/webauthn/types.ts:423](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L423) |
| <a id="emaildelivery"></a> `emailDelivery` | `EmailDeliveryIngredient`\<[`TypeWebauthnEmailDeliveryInput`](#typewebauthnemaildeliveryinput)\> | [recipe/webauthn/types.ts:428](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L428) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/webauthn/types.ts:425](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L425) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/webauthn/types.ts:424](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L424) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/webauthn/types.ts:421](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L421) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/webauthn/types.ts:426](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L426) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/webauthn/types.ts:427](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L427) |

***

### Attestation

```ts
type Attestation = "none" | "indirect" | "direct" | "enterprise";
```

Defined in: [recipe/webauthn/types.ts:173](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L173)

***

### AuthenticationPayload

```ts
type AuthenticationPayload = CredentialPayloadBase & object;
```

Defined in: [recipe/webauthn/types.ts:703](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L703)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `response` | [`AuthenticatorAssertionResponseJSON`](#authenticatorassertionresponsejson) | [recipe/webauthn/types.ts:704](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L704) |

***

### AuthenticatorAssertionResponseJSON

```ts
type AuthenticatorAssertionResponseJSON = object;
```

Defined in: [recipe/webauthn/types.ts:687](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L687)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authenticatordata"></a> `authenticatorData` | `Base64URLString` | [recipe/webauthn/types.ts:689](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L689) |
| <a id="clientdatajson"></a> `clientDataJSON` | `Base64URLString` | [recipe/webauthn/types.ts:688](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L688) |
| <a id="signature"></a> `signature` | `Base64URLString` | [recipe/webauthn/types.ts:690](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L690) |
| <a id="userhandle"></a> `userHandle?` | `Base64URLString` | [recipe/webauthn/types.ts:691](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L691) |

***

### AuthenticatorAttestationResponseJSON

```ts
type AuthenticatorAttestationResponseJSON = object;
```

Defined in: [recipe/webauthn/types.ts:694](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L694)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="attestationobject"></a> `attestationObject` | `Base64URLString` | [recipe/webauthn/types.ts:696](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L696) |
| <a id="authenticatordata-1"></a> `authenticatorData?` | `Base64URLString` | [recipe/webauthn/types.ts:697](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L697) |
| <a id="clientdatajson-1"></a> `clientDataJSON` | `Base64URLString` | [recipe/webauthn/types.ts:695](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L695) |
| <a id="publickey"></a> `publicKey?` | `Base64URLString` | [recipe/webauthn/types.ts:700](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L700) |
| <a id="publickeyalgorithm"></a> `publicKeyAlgorithm?` | `COSEAlgorithmIdentifier` | [recipe/webauthn/types.ts:699](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L699) |
| <a id="transports"></a> `transports?` | (`"ble"` \| `"cable"` \| `"hybrid"` \| `"internal"` \| `"nfc"` \| `"smart-card"` \| `"usb"`)[] | [recipe/webauthn/types.ts:698](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L698) |

***

### CredentialPayload

```ts
type CredentialPayload = CredentialPayloadBase & object;
```

Defined in: [recipe/webauthn/types.ts:711](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L711)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `response` | `object` | [recipe/webauthn/types.ts:712](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L712) |
| `response.attestationObject` | `string` | [recipe/webauthn/types.ts:714](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L714) |
| `response.clientDataJSON` | `string` | [recipe/webauthn/types.ts:713](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L713) |
| `response.transports?` | (`"ble"` \| `"cable"` \| `"hybrid"` \| `"internal"` \| `"nfc"` \| `"smart-card"` \| `"usb"`)[] | [recipe/webauthn/types.ts:715](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L715) |
| `response.userHandle` | `string` | [recipe/webauthn/types.ts:716](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L716) |

***

### CredentialPayloadBase

```ts
type CredentialPayloadBase = object;
```

Defined in: [recipe/webauthn/types.ts:679](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L679)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authenticatorattachment"></a> `authenticatorAttachment?` | `"platform"` \| `"cross-platform"` | [recipe/webauthn/types.ts:682](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L682) |
| <a id="clientextensionresults"></a> `clientExtensionResults` | `Record`\<`string`, `unknown`\> | [recipe/webauthn/types.ts:683](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L683) |
| <a id="id"></a> `id` | `string` | [recipe/webauthn/types.ts:680](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L680) |
| <a id="rawid"></a> `rawId` | `string` | [recipe/webauthn/types.ts:681](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L681) |
| <a id="type"></a> `type` | `"public-key"` | [recipe/webauthn/types.ts:684](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L684) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/webauthn/types.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L175)

#### Methods

##### consumeRecoverAccountToken()

```ts
consumeRecoverAccountToken(input): Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
| ConsumeRecoverAccountTokenErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:322](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L322)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
  `userId`: `string`;
\}
  \| `ConsumeRecoverAccountTokenErrorResponse`\>

##### createNewRecipeUser()

```ts
createNewRecipeUser(input): Promise<
  | CreateNewRecipeUserErrorResponse
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}>;
```

Defined in: [recipe/webauthn/types.ts:296](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L296)

This function is meant only for creating the recipe in the core and nothing else.
We added this even though signUp exists cause devs may override signup expecting it
to be called just during sign up. But we also need a version of signing up which can be
called during operations like creating a user during account recovery flow.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](#registrationpayload); `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](#registrationpayload) |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| `CreateNewRecipeUserErrorResponse`
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}\>

##### generateRecoverAccountToken()

```ts
generateRecoverAccountToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
| GenerateRecoverAccountTokenErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:315](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L315)

We pass in the email as well to this function cause the input userId
may not be associated with an webauthn account. In this case, we
need to know which email to use to create an webauthn account later on.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `userId`: `string`; \} |
| `input.email` | `string` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.userId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| `GenerateRecoverAccountTokenErrorResponse`\>

##### getCredential()

```ts
getCredential(input): Promise<
  | {
  createdAt: number;
  recipeUserId: RecipeUserId;
  relyingPartyId: string;
  status: "OK";
  webauthnCredentialId: string;
}
| GetCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:358](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L358)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnCredentialId`: `string`; \} |
| `input.recipeUserId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnCredentialId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `createdAt`: `number`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `relyingPartyId`: `string`;
  `status`: `"OK"`;
  `webauthnCredentialId`: `string`;
\}
  \| `GetCredentialErrorResponse`\>

##### getGeneratedOptions()

```ts
getGeneratedOptions(input): Promise<
  | {
  challenge: string;
  createdAt: number;
  email?: string;
  expiresAt: number;
  origin: string;
  relyingPartyId: string;
  relyingPartyName: string;
  status: "OK";
  timeout: number;
  userPresence: boolean;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
| GetGeneratedOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:385](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L385)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `challenge`: `string`;
  `createdAt`: `number`;
  `email?`: `string`;
  `expiresAt`: `number`;
  `origin`: `string`;
  `relyingPartyId`: `string`;
  `relyingPartyName`: `string`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userPresence`: `boolean`;
  `userVerification`: [`UserVerification`](#userverification);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `GetGeneratedOptionsErrorResponse`\>

##### getUserFromRecoverAccountToken()

```ts
getUserFromRecoverAccountToken(input): Promise<
  | {
  recipeUserId?: RecipeUserId;
  status: "OK";
  user: User;
}
| GetUserFromRecoverAccountTokenErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:343](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L343)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId?`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `GetUserFromRecoverAccountTokenErrorResponse`\>

##### listCredentials()

```ts
listCredentials(input): Promise<{
  credentials: object[];
  status: "OK";
}>;
```

Defined in: [recipe/webauthn/types.ts:369](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L369)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.recipeUserId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `credentials`: `object`[];
  `status`: `"OK"`;
\}\>

##### registerCredential()

```ts
registerCredential(input): Promise<
  | {
  status: "OK";
}
| RegisterCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:331](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L331)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](#registrationpayload); `recipeUserId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](#registrationpayload) |
| `input.recipeUserId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RegisterCredentialErrorResponse`\>

##### registerOptions()

```ts
registerOptions(input): Promise<
  | {
  attestation: Attestation;
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: number;
  excludeCredentials: object[];
  expiresAt: number;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
| RegisterOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L176)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `recoverAccountToken`: `string`; \} \| \{ `displayName`: `string` \| `undefined`; `email`: `string`; \} |

###### Returns

`Promise`\<
  \| \{
  `attestation`: [`Attestation`](#attestation);
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: [`ResidentKey`](#residentkey);
     `userVerification`: [`UserVerification`](#userverification);
  \};
  `challenge`: `string`;
  `createdAt`: `number`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `number`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `RegisterOptionsErrorResponse`\>

##### removeCredential()

```ts
removeCredential(input): Promise<
  | {
  status: "OK";
}
| RemoveCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:351](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L351)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnCredentialId`: `string`; \} |
| `input.recipeUserId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnCredentialId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RemoveCredentialErrorResponse`\>

##### removeGeneratedOptions()

```ts
removeGeneratedOptions(input): Promise<
  | {
  status: "OK";
}
| RemoveGeneratedOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:379](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L379)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RemoveGeneratedOptionsErrorResponse`\>

##### signIn()

```ts
signIn(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
| SignInErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:274](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L274)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`AuthenticationPayload`](#authenticationpayload); `session`: `SessionContainerInterface` \| `undefined`; `shouldTryLinkingWithSessionUser`: `boolean` \| `undefined`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`AuthenticationPayload`](#authenticationpayload) |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` \| `undefined` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `SignInErrorResponse`\>

##### signInOptions()

```ts
signInOptions(input): Promise<
  | {
  challenge: string;
  createdAt: number;
  expiresAt: number;
  status: "OK";
  timeout: number;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
| SignInOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:236](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L236)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `origin`: `string`; `relyingPartyId`: `string`; `relyingPartyName`: `string`; `tenantId`: `string`; `timeout`: `number` \| `undefined`; `userContext`: [`UserContext`](types.mdx#usercontext); `userPresence`: `boolean` \| `undefined`; `userVerification`: [`UserVerification`](#userverification) \| `undefined`; \} |
| `input.origin` | `string` |
| `input.relyingPartyId` | `string` |
| `input.relyingPartyName` | `string` |
| `input.tenantId` | `string` |
| `input.timeout` | `number` \| `undefined` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.userPresence` | `boolean` \| `undefined` |
| `input.userVerification` | [`UserVerification`](#userverification) \| `undefined` |

###### Returns

`Promise`\<
  \| \{
  `challenge`: `string`;
  `createdAt`: `number`;
  `expiresAt`: `number`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userVerification`: [`UserVerification`](#userverification);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `SignInOptionsErrorResponse`\>

##### signUp()

```ts
signUp(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
| SignUpErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:258](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L258)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](#registrationpayload); `session`: `SessionContainerInterface` \| `undefined`; `shouldTryLinkingWithSessionUser`: `boolean` \| `undefined`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](#registrationpayload) |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` \| `undefined` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `SignUpErrorResponse`\>

##### updateUserEmail()

```ts
updateUserEmail(input): Promise<
  | {
  status: "OK";
}
| UpdateUserEmailErrorResponse>;
```

Defined in: [recipe/webauthn/types.ts:407](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L407)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: `string`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.recipeUserId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `UpdateUserEmailErrorResponse`\>

##### verifyCredentials()

```ts
verifyCredentials(input): Promise<
  | VerifyCredentialsErrorResponse
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}>;
```

Defined in: [recipe/webauthn/types.ts:283](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L283)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`AuthenticationPayload`](#authenticationpayload); `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`AuthenticationPayload`](#authenticationpayload) |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| `VerifyCredentialsErrorResponse`
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}\>

***

### RegistrationPayload

```ts
type RegistrationPayload = CredentialPayloadBase & object;
```

Defined in: [recipe/webauthn/types.ts:707](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L707)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `response` | [`AuthenticatorAttestationResponseJSON`](#authenticatorattestationresponsejson) | [recipe/webauthn/types.ts:708](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L708) |

***

### ResidentKey

```ts
type ResidentKey = "required" | "preferred" | "discouraged";
```

Defined in: [recipe/webauthn/types.ts:171](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L171)

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/webauthn/types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L68)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emaildelivery-1"></a> `emailDelivery?` | `EmailDeliveryTypeInput`\<[`TypeWebauthnEmailDeliveryInput`](#typewebauthnemaildeliveryinput)\> | [recipe/webauthn/types.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L69) |
| <a id="getorigin"></a> `getOrigin?` | [`TypeInputGetOrigin`](#typeinputgetorigin-1) | [recipe/webauthn/types.ts:73](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L73) |
| <a id="getrelyingpartyid"></a> `getRelyingPartyId?` | [`TypeInputRelyingPartyId`](#typeinputrelyingpartyid) | [recipe/webauthn/types.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L70) |
| <a id="getrelyingpartyname"></a> `getRelyingPartyName?` | [`TypeInputRelyingPartyName`](#typeinputrelyingpartyname) | [recipe/webauthn/types.ts:71](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L71) |
| <a id="override"></a> `override?` | `object` | [recipe/webauthn/types.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L74) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/webauthn/types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L79) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/webauthn/types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L75) |
| <a id="validateemailaddress"></a> `validateEmailAddress?` | [`TypeInputValidateEmailAddress`](#typeinputvalidateemailaddress-1) | [recipe/webauthn/types.ts:72](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L72) |

***

### TypeInputGetOrigin()

```ts
type TypeInputGetOrigin = (input) => Promise<string>;
```

Defined in: [recipe/webauthn/types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L91)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `request`: `BaseRequest`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.request` | `BaseRequest` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string`\>

***

### TypeInputRelyingPartyId

```ts
type TypeInputRelyingPartyId = string | (input) => Promise<string>;
```

Defined in: [recipe/webauthn/types.ts:83](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L83)

***

### TypeInputRelyingPartyName

```ts
type TypeInputRelyingPartyName = string | (input) => Promise<string>;
```

Defined in: [recipe/webauthn/types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L87)

***

### TypeInputValidateEmailAddress()

```ts
type TypeInputValidateEmailAddress = (email, tenantId, userContext) => Promise<string | undefined> | string | undefined;
```

Defined in: [recipe/webauthn/types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L97)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `email` | `string` |
| `tenantId` | `string` |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string` \| `undefined`\> \| `string` \| `undefined`

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/webauthn/types.ts:27](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L27)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getemaildeliveryconfig"></a> `getEmailDeliveryConfig` | (`isInServerlessEnv`) => `EmailDeliveryTypeInputWithService`\<[`TypeWebauthnEmailDeliveryInput`](#typewebauthnemaildeliveryinput)\> | [recipe/webauthn/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L31) |
| <a id="getorigin-1"></a> `getOrigin` | [`TypeNormalisedInputGetOrigin`](#typenormalisedinputgetorigin-1) | [recipe/webauthn/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L30) |
| <a id="getrelyingpartyid-1"></a> `getRelyingPartyId` | [`TypeNormalisedInputRelyingPartyId`](#typenormalisedinputrelyingpartyid) | [recipe/webauthn/types.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L28) |
| <a id="getrelyingpartyname-1"></a> `getRelyingPartyName` | [`TypeNormalisedInputRelyingPartyName`](#typenormalisedinputrelyingpartyname) | [recipe/webauthn/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L29) |
| <a id="override-1"></a> `override` | `object` | [recipe/webauthn/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L35) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/webauthn/types.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L40) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/webauthn/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L36) |
| <a id="validateemailaddress-1"></a> `validateEmailAddress` | [`TypeNormalisedInputValidateEmailAddress`](#typenormalisedinputvalidateemailaddress-1) | [recipe/webauthn/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L34) |

***

### TypeNormalisedInputGetOrigin()

```ts
type TypeNormalisedInputGetOrigin = (input) => Promise<string>;
```

Defined in: [recipe/webauthn/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L56)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `request`: `BaseRequest`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.request` | `BaseRequest` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string`\>

***

### TypeNormalisedInputRelyingPartyId()

```ts
type TypeNormalisedInputRelyingPartyId = (input) => Promise<string>;
```

Defined in: [recipe/webauthn/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L44)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `request`: `BaseRequest` \| `undefined`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.request` | `BaseRequest` \| `undefined` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string`\>

***

### TypeNormalisedInputRelyingPartyName()

```ts
type TypeNormalisedInputRelyingPartyName = (input) => Promise<string>;
```

Defined in: [recipe/webauthn/types.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L50)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `request`: `BaseRequest` \| `undefined`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.request` | `BaseRequest` \| `undefined` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string`\>

***

### TypeNormalisedInputValidateEmailAddress()

```ts
type TypeNormalisedInputValidateEmailAddress = (email, tenantId, userContext) => Promise<string | undefined> | string | undefined;
```

Defined in: [recipe/webauthn/types.ts:62](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L62)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `email` | `string` |
| `tenantId` | `string` |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string` \| `undefined`\> \| `string` \| `undefined`

***

### TypeWebauthnEmailDeliveryInput

```ts
type TypeWebauthnEmailDeliveryInput = TypeWebauthnRecoverAccountEmailDeliveryInput;
```

Defined in: [recipe/webauthn/types.ts:677](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L677)

***

### TypeWebauthnRecoverAccountEmailDeliveryInput

```ts
type TypeWebauthnRecoverAccountEmailDeliveryInput = object;
```

Defined in: [recipe/webauthn/types.ts:666](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L666)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="recoveraccountlink"></a> `recoverAccountLink` | `string` | [recipe/webauthn/types.ts:673](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L673) |
| <a id="tenantid"></a> `tenantId` | `string` | [recipe/webauthn/types.ts:674](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L674) |
| <a id="type-1"></a> `type` | `"RECOVER_ACCOUNT"` | [recipe/webauthn/types.ts:667](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L667) |
| <a id="user"></a> `user` | `object` | [recipe/webauthn/types.ts:668](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L668) |
| `user.email` | `string` | [recipe/webauthn/types.ts:671](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L671) |
| `user.id` | `string` | [recipe/webauthn/types.ts:669](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L669) |
| `user.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) \| `undefined` | [recipe/webauthn/types.ts:670](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L670) |

***

### UserVerification

```ts
type UserVerification = "required" | "preferred" | "discouraged";
```

Defined in: [recipe/webauthn/types.ts:172](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/types.ts#L172)

# References - Backend SDKs - Node.js SDK Reference -  WebAuthn
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-webauthn

## Classes

### default

Defined in: [recipe/webauthn/index.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L33)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="error"></a> `Error` | `static` | *typeof* `default` | `SuperTokensError` | [recipe/webauthn/index.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L36) |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/webauthn/index.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L34) |

#### Methods

##### consumeRecoverAccountToken()

```ts
static consumeRecoverAccountToken(input): Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
| ConsumeRecoverAccountTokenErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:191](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L191)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
  `userId`: `string`;
\}
  \| `ConsumeRecoverAccountTokenErrorResponse`\>

##### createRecoverAccountLink()

```ts
static createRecoverAccountLink(__namedParameters): Promise<
  | GenerateRecoverAccountTokenErrorResponse
  | {
  link: string;
  status: string;
}>;
```

Defined in: [recipe/webauthn/index.ts:210](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L210)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; \} |
| `__namedParameters.email` | `string` |
| `__namedParameters.tenantId` | `string` |
| `__namedParameters.userContext?` | `Record`\<`string`, `any`\> |
| `__namedParameters.userId` | `string` |

###### Returns

`Promise`\<
  \| `GenerateRecoverAccountTokenErrorResponse`
  \| \{
  `link`: `string`;
  `status`: `string`;
\}\>

##### generateRecoverAccountToken()

```ts
static generateRecoverAccountToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
| GenerateRecoverAccountTokenErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:150](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L150)

We do not make email optional here because we want to
allow passing in primaryUserId. If we make email optional,
and if the user provides a primaryUserId, then it may result in two problems:
 - there is no recipeUserId = input primaryUserId, in this case,
   this function will throw an error
 - There is a recipe userId = input primaryUserId, but that recipe has no email,
   or has wrong email compared to what the user wanted to generate a reset token for.

And we want to allow primaryUserId being passed in.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; \} |
| `input.email` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| `GenerateRecoverAccountTokenErrorResponse`\>

##### getCredential()

```ts
static getCredential(input): Promise<
  | {
  createdAt: number;
  recipeUserId: RecipeUserId;
  relyingPartyId: string;
  status: "OK";
  webauthnCredentialId: string;
}
| GetCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:322](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L322)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnCredentialId`: `string`; \} |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnCredentialId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `createdAt`: `number`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `relyingPartyId`: `string`;
  `status`: `"OK"`;
  `webauthnCredentialId`: `string`;
\}
  \| `GetCredentialErrorResponse`\>

##### getGeneratedOptions()

```ts
static getGeneratedOptions(input): Promise<
  | {
  challenge: string;
  createdAt: number;
  email?: string;
  expiresAt: number;
  origin: string;
  relyingPartyId: string;
  relyingPartyName: string;
  status: "OK";
  timeout: number;
  userPresence: boolean;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
| GetGeneratedOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:83](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L83)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `challenge`: `string`;
  `createdAt`: `number`;
  `email?`: `string`;
  `expiresAt`: `number`;
  `origin`: `string`;
  `relyingPartyId`: `string`;
  `relyingPartyName`: `string`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userPresence`: `boolean`;
  `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `GetGeneratedOptionsErrorResponse`\>

##### getUserFromRecoverAccountToken()

```ts
static getUserFromRecoverAccountToken(input): Promise<
  | {
  recipeUserId?: RecipeUserId;
  status: "OK";
  user: User;
}
| GetUserFromRecoverAccountTokenErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:289](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L289)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId?`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `GetUserFromRecoverAccountTokenErrorResponse`\>

##### listCredentials()

```ts
static listCredentials(input): Promise<{
  credentials: object[];
  status: "OK";
}>;
```

Defined in: [recipe/webauthn/index.ts:333](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L333)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `credentials`: `object`[];
  `status`: `"OK"`;
\}\>

##### recoverAccount()

```ts
static recoverAccount(__namedParameters): Promise<
  | ConsumeRecoverAccountTokenErrorResponse
  | {
  status: "OK";
}
| RegisterCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:162](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L162)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `credential`: [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload); `tenantId?`: `string`; `token`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `__namedParameters.credential` | [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload) |
| `__namedParameters.tenantId?` | `string` |
| `__namedParameters.token` | `string` |
| `__namedParameters.userContext?` | `Record`\<`string`, `any`\> |
| `__namedParameters.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| `ConsumeRecoverAccountTokenErrorResponse`
  \| \{
  `status`: `"OK"`;
\}
  \| `RegisterCredentialErrorResponse`\>

##### registerCredential()

```ts
static registerCredential(input): Promise<
  | {
  status: "OK";
}
| RegisterCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L198)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload); `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload) |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RegisterCredentialErrorResponse`\>

##### registerOptions()

```ts
static registerOptions(input): Promise<
  | {
  attestation: Attestation;
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: number;
  excludeCredentials: object[];
  expiresAt: number;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
| RegisterOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L38)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `recoverAccountToken`: `string`; \} \| \{ `displayName`: `string`; `email`: `string`; \} |

###### Returns

`Promise`\<
  \| \{
  `attestation`: [`Attestation`](recipe-webauthn-types.mdx#attestation);
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: [`ResidentKey`](recipe-webauthn-types.mdx#residentkey);
     `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification);
  \};
  `challenge`: `string`;
  `createdAt`: `number`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `number`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `RegisterOptionsErrorResponse`\>

##### removeCredential()

```ts
static removeCredential(input): Promise<
  | {
  status: "OK";
}
| RemoveCredentialErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:311](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L311)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnCredentialId`: `string`; \} |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnCredentialId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RemoveCredentialErrorResponse`\>

##### removeGeneratedOptions()

```ts
static removeGeneratedOptions(input): Promise<
  | {
  status: "OK";
}
| RemoveGeneratedOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:300](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L300)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RemoveGeneratedOptionsErrorResponse`\>

##### sendEmail()

```ts
static sendEmail(input): Promise<void>;
```

Defined in: [recipe/webauthn/index.ts:281](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L281)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypeWebauthnRecoverAccountEmailDeliveryInput`](recipe-webauthn-types.mdx#typewebauthnrecoveraccountemaildeliveryinput) & `object` |

###### Returns

`Promise`\<`void`\>

##### sendRecoverAccountEmail()

```ts
static sendRecoverAccountEmail(__namedParameters): Promise<
  | {
  link: string;
  status: string;
}
  | {
  status: string;
}>;
```

Defined in: [recipe/webauthn/index.ts:240](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L240)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; \} |
| `__namedParameters.email` | `string` |
| `__namedParameters.tenantId` | `string` |
| `__namedParameters.userContext?` | `Record`\<`string`, `any`\> |
| `__namedParameters.userId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `link`: `string`;
  `status`: `string`;
\}
  \| \{
  `status`: `string`;
\}\>

##### signIn()

```ts
static signIn(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
| SignInErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:108](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L108)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload); `session`: `SessionContainerInterface`; `shouldTryLinkingWithSessionUser`: `boolean`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload) |
| `input.session` | `SessionContainerInterface` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `SignInErrorResponse`\>

##### signInOptions()

```ts
static signInOptions(input): Promise<
  | {
  challenge: string;
  createdAt: number;
  expiresAt: number;
  status: "OK";
  timeout: number;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
| SignInOptionsErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:67](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L67)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `origin`: `string`; `relyingPartyId`: `string`; `relyingPartyName`: `string`; `tenantId`: `string`; `timeout`: `number`; `userContext?`: `Record`\<`string`, `any`\>; `userPresence`: `boolean`; `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification); \} |
| `input.origin` | `string` |
| `input.relyingPartyId` | `string` |
| `input.relyingPartyName` | `string` |
| `input.tenantId` | `string` |
| `input.timeout` | `number` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userPresence` | `boolean` |
| `input.userVerification` | [`UserVerification`](recipe-webauthn-types.mdx#userverification) |

###### Returns

`Promise`\<
  \| \{
  `challenge`: `string`;
  `createdAt`: `number`;
  `expiresAt`: `number`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `SignInOptionsErrorResponse`\>

##### signUp()

```ts
static signUp(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
| SignUpErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L94)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload); `session`: `SessionContainerInterface`; `shouldTryLinkingWithSessionUser`: `boolean`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload) |
| `input.session` | `SessionContainerInterface` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `SignUpErrorResponse`\>

##### updateUserEmail()

```ts
static updateUserEmail(input): Promise<
  | {
  status: "OK";
}
| UpdateUserEmailErrorResponse>;
```

Defined in: [recipe/webauthn/index.ts:340](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L340)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.email` | `string` |
| `input.recipeUserId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `UpdateUserEmailErrorResponse`\>

##### verifyCredentials()

```ts
static verifyCredentials(input): Promise<{
  status:   | "OK"
     | "UNKNOWN_USER_ID_ERROR"
     | "INVALID_CREDENTIALS_ERROR"
     | "INVALID_OPTIONS_ERROR"
     | "INVALID_AUTHENTICATOR_ERROR"
     | "CREDENTIAL_NOT_FOUND_ERROR"
     | "OPTIONS_NOT_FOUND_ERROR";
}>;
```

Defined in: [recipe/webauthn/index.ts:122](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L122)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload); `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload) |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

###### Returns

`Promise`\<\{
  `status`:   \| `"OK"`
     \| `"UNKNOWN_USER_ID_ERROR"`
     \| `"INVALID_CREDENTIALS_ERROR"`
     \| `"INVALID_OPTIONS_ERROR"`
     \| `"INVALID_AUTHENTICATOR_ERROR"`
     \| `"CREDENTIAL_NOT_FOUND_ERROR"`
     \| `"OPTIONS_NOT_FOUND_ERROR"`;
\}\>

## Variables

### consumeRecoverAccountToken()

```ts
consumeRecoverAccountToken: (input) => Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
  | ConsumeRecoverAccountTokenErrorResponse> = Wrapper.consumeRecoverAccountToken;
```

Defined in: [recipe/webauthn/index.ts:371](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L371)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
  `userId`: `string`;
\}
  \| `ConsumeRecoverAccountTokenErrorResponse`\>

***

### createRecoverAccountLink()

```ts
createRecoverAccountLink: (__namedParameters) => Promise<
  | GenerateRecoverAccountTokenErrorResponse
  | {
  link: string;
  status: string;
}> = Wrapper.createRecoverAccountLink;
```

Defined in: [recipe/webauthn/index.ts:375](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L375)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; \} |
| `__namedParameters.email` | `string` |
| `__namedParameters.tenantId` | `string` |
| `__namedParameters.userContext?` | `Record`\<`string`, `any`\> |
| `__namedParameters.userId` | `string` |

#### Returns

`Promise`\<
  \| `GenerateRecoverAccountTokenErrorResponse`
  \| \{
  `link`: `string`;
  `status`: `string`;
\}\>

***

### Error

```ts
Error: typeof default = Wrapper.Error;
```

Defined in: [recipe/webauthn/index.ts:355](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L355)

***

### generateRecoverAccountToken()

```ts
generateRecoverAccountToken: (input) => Promise<
  | {
  status: "OK";
  token: string;
}
  | GenerateRecoverAccountTokenErrorResponse> = Wrapper.generateRecoverAccountToken;
```

Defined in: [recipe/webauthn/index.ts:367](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L367)

We do not make email optional here because we want to
allow passing in primaryUserId. If we make email optional,
and if the user provides a primaryUserId, then it may result in two problems:
 - there is no recipeUserId = input primaryUserId, in this case,
   this function will throw an error
 - There is a recipe userId = input primaryUserId, but that recipe has no email,
   or has wrong email compared to what the user wanted to generate a reset token for.

And we want to allow primaryUserId being passed in.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; \} |
| `input.email` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| `GenerateRecoverAccountTokenErrorResponse`\>

***

### getCredential()

```ts
getCredential: (input) => Promise<
  | {
  createdAt: number;
  recipeUserId: RecipeUserId;
  relyingPartyId: string;
  status: "OK";
  webauthnCredentialId: string;
}
  | GetCredentialErrorResponse> = Wrapper.getCredential;
```

Defined in: [recipe/webauthn/index.ts:389](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L389)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnCredentialId`: `string`; \} |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnCredentialId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `createdAt`: `number`;
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `relyingPartyId`: `string`;
  `status`: `"OK"`;
  `webauthnCredentialId`: `string`;
\}
  \| `GetCredentialErrorResponse`\>

***

### getGeneratedOptions()

```ts
getGeneratedOptions: (input) => Promise<
  | {
  challenge: string;
  createdAt: number;
  email?: string;
  expiresAt: number;
  origin: string;
  relyingPartyId: string;
  relyingPartyName: string;
  status: "OK";
  timeout: number;
  userPresence: boolean;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
  | GetGeneratedOptionsErrorResponse> = Wrapper.getGeneratedOptions;
```

Defined in: [recipe/webauthn/index.ts:381](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L381)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `challenge`: `string`;
  `createdAt`: `number`;
  `email?`: `string`;
  `expiresAt`: `number`;
  `origin`: `string`;
  `relyingPartyId`: `string`;
  `relyingPartyName`: `string`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userPresence`: `boolean`;
  `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `GetGeneratedOptionsErrorResponse`\>

***

### getUserFromRecoverAccountToken()

```ts
getUserFromRecoverAccountToken: (input) => Promise<
  | {
  recipeUserId?: RecipeUserId;
  status: "OK";
  user: User;
}
  | GetUserFromRecoverAccountTokenErrorResponse> = Wrapper.getUserFromRecoverAccountToken;
```

Defined in: [recipe/webauthn/index.ts:383](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L383)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `token`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `recipeUserId?`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `GetUserFromRecoverAccountTokenErrorResponse`\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/webauthn/index.ts:353](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L353)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-webauthn-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### listCredentials()

```ts
listCredentials: (input) => Promise<{
  credentials: object[];
  status: "OK";
}> = Wrapper.listCredentials;
```

Defined in: [recipe/webauthn/index.ts:391](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L391)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `credentials`: `object`[];
  `status`: `"OK"`;
\}\>

***

### recoverAccount()

```ts
recoverAccount: (__namedParameters) => Promise<
  | ConsumeRecoverAccountTokenErrorResponse
  | {
  status: "OK";
}
  | RegisterCredentialErrorResponse> = Wrapper.recoverAccount;
```

Defined in: [recipe/webauthn/index.ts:369](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L369)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `credential`: [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload); `tenantId?`: `string`; `token`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `__namedParameters.credential` | [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload) |
| `__namedParameters.tenantId?` | `string` |
| `__namedParameters.token` | `string` |
| `__namedParameters.userContext?` | `Record`\<`string`, `any`\> |
| `__namedParameters.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| `ConsumeRecoverAccountTokenErrorResponse`
  \| \{
  `status`: `"OK"`;
\}
  \| `RegisterCredentialErrorResponse`\>

***

### registerCredential()

```ts
registerCredential: (input) => Promise<
  | {
  status: "OK";
}
  | RegisterCredentialErrorResponse> = Wrapper.registerCredential;
```

Defined in: [recipe/webauthn/index.ts:373](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L373)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload); `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload) |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RegisterCredentialErrorResponse`\>

***

### registerOptions()

```ts
registerOptions: (input) => Promise<
  | {
  attestation: Attestation;
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: number;
  excludeCredentials: object[];
  expiresAt: number;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
  | RegisterOptionsErrorResponse> = Wrapper.registerOptions;
```

Defined in: [recipe/webauthn/index.ts:357](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L357)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `recoverAccountToken`: `string`; \} \| \{ `displayName`: `string`; `email`: `string`; \} |

#### Returns

`Promise`\<
  \| \{
  `attestation`: [`Attestation`](recipe-webauthn-types.mdx#attestation);
  `authenticatorSelection`: \{
     `requireResidentKey`: `boolean`;
     `residentKey`: [`ResidentKey`](recipe-webauthn-types.mdx#residentkey);
     `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification);
  \};
  `challenge`: `string`;
  `createdAt`: `number`;
  `excludeCredentials`: `object`[];
  `expiresAt`: `number`;
  `pubKeyCredParams`: `object`[];
  `rp`: \{
     `id`: `string`;
     `name`: `string`;
  \};
  `status`: `"OK"`;
  `timeout`: `number`;
  `user`: \{
     `displayName`: `string`;
     `id`: `string`;
     `name`: `string`;
  \};
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `RegisterOptionsErrorResponse`\>

***

### removeCredential()

```ts
removeCredential: (input) => Promise<
  | {
  status: "OK";
}
  | RemoveCredentialErrorResponse> = Wrapper.removeCredential;
```

Defined in: [recipe/webauthn/index.ts:387](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L387)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `recipeUserId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnCredentialId`: `string`; \} |
| `input.recipeUserId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnCredentialId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RemoveCredentialErrorResponse`\>

***

### removeGeneratedOptions()

```ts
removeGeneratedOptions: (input) => Promise<
  | {
  status: "OK";
}
  | RemoveGeneratedOptionsErrorResponse> = Wrapper.removeGeneratedOptions;
```

Defined in: [recipe/webauthn/index.ts:385](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L385)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `RemoveGeneratedOptionsErrorResponse`\>

***

### sendEmail()

```ts
sendEmail: (input) => Promise<void> = Wrapper.sendEmail;
```

Defined in: [recipe/webauthn/index.ts:379](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L379)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypeWebauthnRecoverAccountEmailDeliveryInput`](recipe-webauthn-types.mdx#typewebauthnrecoveraccountemaildeliveryinput) & `object` |

#### Returns

`Promise`\<`void`\>

***

### sendRecoverAccountEmail()

```ts
sendRecoverAccountEmail: (__namedParameters) => Promise<
  | {
  link: string;
  status: string;
}
  | {
  status: string;
}> = Wrapper.sendRecoverAccountEmail;
```

Defined in: [recipe/webauthn/index.ts:377](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L377)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `email`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `userId`: `string`; \} |
| `__namedParameters.email` | `string` |
| `__namedParameters.tenantId` | `string` |
| `__namedParameters.userContext?` | `Record`\<`string`, `any`\> |
| `__namedParameters.userId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `link`: `string`;
  `status`: `string`;
\}
  \| \{
  `status`: `string`;
\}\>

***

### signIn()

```ts
signIn: (input) => Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | SignInErrorResponse> = Wrapper.signIn;
```

Defined in: [recipe/webauthn/index.ts:361](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L361)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload); `session`: `SessionContainerInterface`; `shouldTryLinkingWithSessionUser`: `boolean`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload) |
| `input.session` | `SessionContainerInterface` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `SignInErrorResponse`\>

***

### signInOptions()

```ts
signInOptions: (input) => Promise<
  | {
  challenge: string;
  createdAt: number;
  expiresAt: number;
  status: "OK";
  timeout: number;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
  | SignInOptionsErrorResponse> = Wrapper.signInOptions;
```

Defined in: [recipe/webauthn/index.ts:359](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L359)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `origin`: `string`; `relyingPartyId`: `string`; `relyingPartyName`: `string`; `tenantId`: `string`; `timeout`: `number`; `userContext?`: `Record`\<`string`, `any`\>; `userPresence`: `boolean`; `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification); \} |
| `input.origin` | `string` |
| `input.relyingPartyId` | `string` |
| `input.relyingPartyName` | `string` |
| `input.tenantId` | `string` |
| `input.timeout` | `number` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.userPresence` | `boolean` |
| `input.userVerification` | [`UserVerification`](recipe-webauthn-types.mdx#userverification) |

#### Returns

`Promise`\<
  \| \{
  `challenge`: `string`;
  `createdAt`: `number`;
  `expiresAt`: `number`;
  `status`: `"OK"`;
  `timeout`: `number`;
  `userVerification`: [`UserVerification`](recipe-webauthn-types.mdx#userverification);
  `webauthnGeneratedOptionsId`: `string`;
\}
  \| `SignInOptionsErrorResponse`\>

***

### signUp()

```ts
signUp: (input) => Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
  | SignUpErrorResponse> = Wrapper.signUp;
```

Defined in: [recipe/webauthn/index.ts:363](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L363)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload); `session`: `SessionContainerInterface`; `shouldTryLinkingWithSessionUser`: `boolean`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`RegistrationPayload`](recipe-webauthn-types.mdx#registrationpayload) |
| `input.session` | `SessionContainerInterface` |
| `input.shouldTryLinkingWithSessionUser` | `boolean` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<
  \| \{
  `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1);
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| `SignUpErrorResponse`\>

***

### updateUserEmail()

```ts
updateUserEmail: (input) => Promise<
  | {
  status: "OK";
}
  | UpdateUserEmailErrorResponse> = Wrapper.updateUserEmail;
```

Defined in: [recipe/webauthn/index.ts:393](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L393)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: `string`; `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; \} |
| `input.email` | `string` |
| `input.recipeUserId` | `string` |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| `UpdateUserEmailErrorResponse`\>

***

### verifyCredentials()

```ts
verifyCredentials: (input) => Promise<{
  status:   | "OK"
     | "UNKNOWN_USER_ID_ERROR"
     | "INVALID_CREDENTIALS_ERROR"
     | "INVALID_OPTIONS_ERROR"
     | "INVALID_AUTHENTICATOR_ERROR"
     | "CREDENTIAL_NOT_FOUND_ERROR"
     | "OPTIONS_NOT_FOUND_ERROR";
}> = Wrapper.verifyCredentials;
```

Defined in: [recipe/webauthn/index.ts:365](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/webauthn/index.ts#L365)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `credential`: [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload); `tenantId`: `string`; `userContext?`: `Record`\<`string`, `any`\>; `webauthnGeneratedOptionsId`: `string`; \} |
| `input.credential` | [`AuthenticationPayload`](recipe-webauthn-types.mdx#authenticationpayload) |
| `input.tenantId` | `string` |
| `input.userContext?` | `Record`\<`string`, `any`\> |
| `input.webauthnGeneratedOptionsId` | `string` |

#### Returns

`Promise`\<\{
  `status`:   \| `"OK"`
     \| `"UNKNOWN_USER_ID_ERROR"`
     \| `"INVALID_CREDENTIALS_ERROR"`
     \| `"INVALID_OPTIONS_ERROR"`
     \| `"INVALID_AUTHENTICATOR_ERROR"`
     \| `"CREDENTIAL_NOT_FOUND_ERROR"`
     \| `"OPTIONS_NOT_FOUND_ERROR"`;
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-webauthn-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-webauthn-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-webauthn-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  EmailVerification Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-emailverification-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/emailverification/types.ts:127](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L127)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="generateemailverifytokenpost"></a> `generateEmailVerifyTokenPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; \} \| \{ `newSession?`: `SessionContainerInterface`; `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailverification/types.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L153) |
| <a id="isemailverifiedget"></a> `isEmailVerifiedGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `isVerified`: `boolean`; `newSession?`: `SessionContainerInterface`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailverification/types.ts:142](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L142) |
| <a id="verifyemailpost"></a> `verifyEmailPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `newSession?`: `SessionContainerInterface`; `status`: `"OK"`; `user`: [`UserEmailInfo`](#useremailinfo); \} \| \{ `status`: `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/emailverification/types.ts:128](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L128) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/emailverification/types.ts:116](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L116)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types.mdx#normalisedappinfo) | [recipe/emailverification/types.ts:118](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L118) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/emailverification/types.ts:119](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L119) |
| <a id="emaildelivery"></a> `emailDelivery` | `EmailDeliveryIngredient`\<[`TypeEmailVerificationEmailDeliveryInput`](#typeemailverificationemaildeliveryinput)\> | [recipe/emailverification/types.ts:124](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L124) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/emailverification/types.ts:121](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L121) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/emailverification/types.ts:120](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L120) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/emailverification/types.ts:117](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L117) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/emailverification/types.ts:122](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L122) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/emailverification/types.ts:123](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L123) |

***

### GetEmailForRecipeUserIdFunc()

```ts
type GetEmailForRecipeUserIdFunc = (user, recipeUserId, userContext) => Promise<
  | {
  email: string;
  status: "OK";
}
  | {
  status: "EMAIL_DOES_NOT_EXIST_ERROR" | "UNKNOWN_USER_ID_ERROR";
}>;
```

Defined in: [recipe/emailverification/types.ts:180](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L180)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | [`User`](types.mdx#user) \| `undefined` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<
  \| \{
  `email`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"EMAIL_DOES_NOT_EXIST_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}\>

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/emailverification/types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L79)

#### Methods

##### createEmailVerificationToken()

```ts
createEmailVerificationToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;
```

Defined in: [recipe/emailverification/types.ts:80](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L80)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

##### isEmailVerified()

```ts
isEmailVerified(input): Promise<boolean>;
```

Defined in: [recipe/emailverification/types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L100)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<`boolean`\>

##### revokeEmailVerificationTokens()

```ts
revokeEmailVerificationTokens(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/emailverification/types.ts:102](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L102)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### unverifyEmail()

```ts
unverifyEmail(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/emailverification/types.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L109)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `email`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1); `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.email` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### verifyEmailUsingToken()

```ts
verifyEmailUsingToken(input): Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;
```

Defined in: [recipe/emailverification/types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L93)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `attemptAccountLinking`: `boolean`; `tenantId`: `string`; `token`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.attemptAccountLinking` | `boolean` |
| `input.tenantId` | `string` |
| `input.token` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `user`: [`UserEmailInfo`](#useremailinfo);
\}
  \| \{
  `status`: `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

***

### TypeEmailVerificationEmailDeliveryInput

```ts
type TypeEmailVerificationEmailDeliveryInput = object;
```

Defined in: [recipe/emailverification/types.ts:166](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L166)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emailverifylink"></a> `emailVerifyLink` | `string` | [recipe/emailverification/types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L176) |
| <a id="tenantid"></a> `tenantId` | `string` | [recipe/emailverification/types.ts:177](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L177) |
| <a id="type"></a> `type` | `"EMAIL_VERIFICATION"` | [recipe/emailverification/types.ts:167](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L167) |
| <a id="user"></a> `user` | `object` | [recipe/emailverification/types.ts:168](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L168) |
| `user.email` | `string` | [recipe/emailverification/types.ts:174](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L174) |
| `user.id` | `string` | [recipe/emailverification/types.ts:172](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L172) |
| `user.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) | [recipe/emailverification/types.ts:173](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L173) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/emailverification/types.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L28)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emaildelivery-1"></a> `emailDelivery?` | `EmailDeliveryTypeInput`\<[`TypeEmailVerificationEmailDeliveryInput`](#typeemailverificationemaildeliveryinput)\> | [recipe/emailverification/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L30) |
| <a id="getemailforrecipeuserid"></a> `getEmailForRecipeUserId?` | (`recipeUserId`, `userContext`) => `Promise`\< \| \{ `email`: `string`; `status`: `"OK"`; \} \| \{ `status`: `"EMAIL_DOES_NOT_EXIST_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`; \}\> | [recipe/emailverification/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L31) |
| <a id="mode"></a> `mode` | `"REQUIRED"` \| `"OPTIONAL"` | [recipe/emailverification/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L29) |
| <a id="override"></a> `override?` | `object` | [recipe/emailverification/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L41) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/emailverification/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L46) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/emailverification/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L42) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/emailverification/types.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L50)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getemaildeliveryconfig"></a> `getEmailDeliveryConfig` | (`isInServerlessEnv`) => `EmailDeliveryTypeInputWithService`\<[`TypeEmailVerificationEmailDeliveryInput`](#typeemailverificationemaildeliveryinput)\> | [recipe/emailverification/types.ts:52](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L52) |
| <a id="getemailforrecipeuserid-1"></a> `getEmailForRecipeUserId?` | (`recipeUserId`, `userContext`) => `Promise`\< \| \{ `email`: `string`; `status`: `"OK"`; \} \| \{ `status`: `"EMAIL_DOES_NOT_EXIST_ERROR"` \| `"UNKNOWN_USER_ID_ERROR"`; \}\> | [recipe/emailverification/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L55) |
| <a id="mode-1"></a> `mode` | `"REQUIRED"` \| `"OPTIONAL"` | [recipe/emailverification/types.ts:51](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L51) |
| <a id="override-1"></a> `override` | `object` | [recipe/emailverification/types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L65) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/emailverification/types.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L70) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/emailverification/types.ts:66](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L66) |

***

### UserEmailInfo

```ts
type UserEmailInfo = object;
```

Defined in: [recipe/emailverification/types.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L74)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email"></a> `email` | `string` | [recipe/emailverification/types.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L76) |
| <a id="recipeuserid"></a> `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) | [recipe/emailverification/types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/types.ts#L75) |

# References - Backend SDKs - Node.js SDK Reference -  EmailVerification
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-emailverification

## Classes

### default

Defined in: [recipe/emailverification/index.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L31)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="emailverificationclaim"></a> `EmailVerificationClaim` | `static` | `EmailVerificationClaimClass` | `EmailVerificationClaim` | [recipe/emailverification/index.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L36) |
| <a id="error"></a> `Error` | `static` | *typeof* `default` | `SuperTokensError` | [recipe/emailverification/index.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L34) |
| <a id="init"></a> `init` | `static` | (`config`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/emailverification/index.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L32) |

#### Methods

##### createEmailVerificationLink()

```ts
static createEmailVerificationLink(
   tenantId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<
  | {
  link: string;
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;
```

Defined in: [recipe/emailverification/index.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L74)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `link`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

##### createEmailVerificationToken()

```ts
static createEmailVerificationToken(
   tenantId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;
```

Defined in: [recipe/emailverification/index.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L38)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

##### isEmailVerified()

```ts
static isEmailVerified(
   recipeUserId, 
   email?, 
userContext?): Promise<boolean>;
```

Defined in: [recipe/emailverification/index.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L176)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`boolean`\>

##### revokeEmailVerificationTokens()

```ts
static revokeEmailVerificationTokens(
   tenantId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<{
  status: string;
}>;
```

Defined in: [recipe/emailverification/index.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L198)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `string`;
\}\>

##### sendEmail()

```ts
static sendEmail(input): Promise<void>;
```

Defined in: [recipe/emailverification/index.ts:256](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L256)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypeEmailVerificationEmailDeliveryInput`](recipe-emailverification-types.mdx#typeemailverificationemaildeliveryinput) & `object` |

###### Returns

`Promise`\<`void`\>

##### sendEmailVerificationEmail()

```ts
static sendEmailVerificationEmail(
   tenantId, 
   userId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<
  | {
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;
```

Defined in: [recipe/emailverification/index.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L109)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

##### unverifyEmail()

```ts
static unverifyEmail(
   recipeUserId, 
   email?, 
   userContext?): Promise<{
  status: string;
}>;
```

Defined in: [recipe/emailverification/index.ts:233](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L233)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `string`;
\}\>

##### verifyEmailUsingToken()

```ts
static verifyEmailUsingToken(
   tenantId, 
   token, 
   attemptAccountLinking, 
   userContext?): Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;
```

Defined in: [recipe/emailverification/index.ts:162](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L162)

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `tenantId` | `string` | `undefined` |
| `token` | `string` | `undefined` |
| `attemptAccountLinking` | `boolean` | `true` |
| `userContext?` | `Record`\<`string`, `any`\> | `undefined` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `user`: [`UserEmailInfo`](recipe-emailverification-types.mdx#useremailinfo);
\}
  \| \{
  `status`: `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

## Variables

### createEmailVerificationLink()

```ts
createEmailVerificationLink: (tenantId, recipeUserId, email?, userContext?) => Promise<
  | {
  link: string;
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.createEmailVerificationLink;
```

Defined in: [recipe/emailverification/index.ts:271](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L271)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `link`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

***

### createEmailVerificationToken()

```ts
createEmailVerificationToken: (tenantId, recipeUserId, email?, userContext?) => Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.createEmailVerificationToken;
```

Defined in: [recipe/emailverification/index.ts:269](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L269)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `token`: `string`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

***

### EmailVerificationClaim

```ts
const EmailVerificationClaim: EmailVerificationClaimClass;
```

Defined in: [recipe/emailverification/emailVerificationClaim.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/emailVerificationClaim.ts#L68)

***

### Error

```ts
Error: typeof default = Wrapper.Error;
```

Defined in: [recipe/emailverification/index.ts:267](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L267)

***

### init()

```ts
init: (config) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/emailverification/index.ts:265](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L265)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`TypeInput`](recipe-emailverification-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### isEmailVerified()

```ts
isEmailVerified: (recipeUserId, email?, userContext?) => Promise<boolean> = Wrapper.isEmailVerified;
```

Defined in: [recipe/emailverification/index.ts:277](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L277)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`boolean`\>

***

### revokeEmailVerificationTokens()

```ts
revokeEmailVerificationTokens: (tenantId, recipeUserId, email?, userContext?) => Promise<{
  status: string;
}> = Wrapper.revokeEmailVerificationTokens;
```

Defined in: [recipe/emailverification/index.ts:279](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L279)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `string`;
\}\>

***

### sendEmail()

```ts
sendEmail: (input) => Promise<void> = Wrapper.sendEmail;
```

Defined in: [recipe/emailverification/index.ts:285](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L285)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`TypeEmailVerificationEmailDeliveryInput`](recipe-emailverification-types.mdx#typeemailverificationemaildeliveryinput) & `object` |

#### Returns

`Promise`\<`void`\>

***

### sendEmailVerificationEmail()

```ts
sendEmailVerificationEmail: (tenantId, userId, recipeUserId, email?, userContext?) => Promise<
  | {
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.sendEmailVerificationEmail;
```

Defined in: [recipe/emailverification/index.ts:273](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L273)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"EMAIL_ALREADY_VERIFIED_ERROR"`;
\}\>

***

### unverifyEmail()

```ts
unverifyEmail: (recipeUserId, email?, userContext?) => Promise<{
  status: string;
}> = Wrapper.unverifyEmail;
```

Defined in: [recipe/emailverification/index.ts:281](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L281)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `email?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `string`;
\}\>

***

### verifyEmailUsingToken()

```ts
verifyEmailUsingToken: (tenantId, token, attemptAccountLinking, userContext?) => Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}> = Wrapper.verifyEmailUsingToken;
```

Defined in: [recipe/emailverification/index.ts:275](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/emailverification/index.ts#L275)

#### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `tenantId` | `string` | `undefined` |
| `token` | `string` | `undefined` |
| `attemptAccountLinking` | `boolean` | `true` |
| `userContext?` | `Record`\<`string`, `any`\> | `undefined` |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `user`: [`UserEmailInfo`](recipe-emailverification-types.mdx#useremailinfo);
\}
  \| \{
  `status`: `"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"`;
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-emailverification-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-emailverification-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-emailverification-types.mdx#recipeinterface)

***

### UserEmailInfo

Re-exports [UserEmailInfo](recipe-emailverification-types.mdx#useremailinfo)

# References - Backend SDKs - Node.js SDK Reference -  MFA Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-multifactorauth-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/multifactorauth/types.ts:118](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L118)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="resyncsessionandfetchmfainfoput"></a> `resyncSessionAndFetchMFAInfoPUT` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `emails`: `Record`\<`string`, `string`[] \| `undefined`\>; `factors`: \{ `allowedToSetup`: `string`[]; `alreadySetup`: `string`[]; `next`: `string`[]; \}; `phoneNumbers`: `Record`\<`string`, `string`[] \| `undefined`\>; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/multifactorauth/types.ts:119](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L119) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/multifactorauth/types.ts:108](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L108)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/multifactorauth/types.ts:111](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L111) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/multifactorauth/types.ts:113](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L113) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/multifactorauth/types.ts:112](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L112) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/multifactorauth/types.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L109) |
| <a id="recipeinstance"></a> `recipeInstance` | `Recipe` | [recipe/multifactorauth/types.ts:110](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L110) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/multifactorauth/types.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L114) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/multifactorauth/types.ts:115](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L115) |

***

### GetAllAvailableSecondaryFactorIdsFromOtherRecipesFunc()

```ts
type GetAllAvailableSecondaryFactorIdsFromOtherRecipesFunc = (tenantConfig) => string[];
```

Defined in: [recipe/multifactorauth/types.ts:138](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L138)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantConfig` | [`TenantConfig`](recipe-multitenancy-types.mdx#tenantconfig) |

#### Returns

`string`[]

***

### GetEmailsForFactorFromOtherRecipesFunc()

```ts
type GetEmailsForFactorFromOtherRecipesFunc = (user, sessionRecipeUserId) => 
  | {
  factorIdToEmailsMap: Record<string, string[]>;
  status: "OK";
}
  | {
  status: "UNKNOWN_SESSION_RECIPE_USER_ID";
};
```

Defined in: [recipe/multifactorauth/types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L140)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | [`User`](index.mdx#user-1) |
| `sessionRecipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |

#### Returns

  \| \{
  `factorIdToEmailsMap`: `Record`\<`string`, `string`[]\>;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_SESSION_RECIPE_USER_ID"`;
\}

***

### GetFactorsSetupForUserFromOtherRecipesFunc()

```ts
type GetFactorsSetupForUserFromOtherRecipesFunc = (user, userContext) => Promise<string[]>;
```

Defined in: [recipe/multifactorauth/types.ts:136](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L136)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | [`User`](index.mdx#user-1) |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`string`[]\>

***

### GetPhoneNumbersForFactorsFromOtherRecipesFunc()

```ts
type GetPhoneNumbersForFactorsFromOtherRecipesFunc = (user, sessionRecipeUserId) => 
  | {
  factorIdToPhoneNumberMap: Record<string, string[]>;
  status: "OK";
}
  | {
  status: "UNKNOWN_SESSION_RECIPE_USER_ID";
};
```

Defined in: [recipe/multifactorauth/types.ts:144](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L144)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | [`User`](index.mdx#user-1) |
| `sessionRecipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |

#### Returns

  \| \{
  `factorIdToPhoneNumberMap`: `Record`\<`string`, `string`[]\>;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_SESSION_RECIPE_USER_ID"`;
\}

***

### MFAClaimValue

```ts
type MFAClaimValue = object;
```

Defined in: [recipe/multifactorauth/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L36)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="c"></a> `c` | `Record`\<`string`, `number` \| `undefined`\> | [recipe/multifactorauth/types.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L37) |
| <a id="v"></a> `v` | `boolean` | [recipe/multifactorauth/types.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L38) |

***

### MFARequirementList

```ts
type MFARequirementList = (
  | {
  oneOf: string[];
}
  | {
  allOfInAnyOrder: string[];
}
  | string)[];
```

Defined in: [recipe/multifactorauth/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L26)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/multifactorauth/types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L65)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="addtorequiredsecondaryfactorsforuser"></a> `addToRequiredSecondaryFactorsForUser` | (`input`) => `Promise`\<`void`\> | [recipe/multifactorauth/types.ts:95](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L95) |
| <a id="assertallowedtosetupfactorelsethrowinvalidclaimerror"></a> `assertAllowedToSetupFactorElseThrowInvalidClaimError` | (`input`) => `Promise`\<`void`\> | [recipe/multifactorauth/types.ts:66](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L66) |
| <a id="getfactorssetupforuser"></a> `getFactorsSetupForUser` | (`input`) => `Promise`\<`string`[]\> | [recipe/multifactorauth/types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L91) |
| <a id="getmfarequirementsforauth"></a> `getMFARequirementsForAuth` | (`input`) => \| `Promise`\<[`MFARequirementList`](#mfarequirementlist)\> \| [`MFARequirementList`](#mfarequirementlist) | [recipe/multifactorauth/types.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L74) |
| <a id="getrequiredsecondaryfactorsforuser"></a> `getRequiredSecondaryFactorsForUser` | (`input`) => `Promise`\<`string`[]\> | [recipe/multifactorauth/types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L93) |
| <a id="markfactorascompleteinsession"></a> `markFactorAsCompleteInSession` | (`input`) => `Promise`\<`void`\> | [recipe/multifactorauth/types.ts:85](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L85) |
| <a id="removefromrequiredsecondaryfactorsforuser"></a> `removeFromRequiredSecondaryFactorsForUser` | (`input`) => `Promise`\<`void`\> | [recipe/multifactorauth/types.ts:101](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L101) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/multifactorauth/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L41)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="firstfactors"></a> `firstFactors?` | `string`[] | [recipe/multifactorauth/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L42) |
| <a id="override"></a> `override?` | `object` | [recipe/multifactorauth/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L44) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/multifactorauth/types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L49) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/multifactorauth/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L45) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/multifactorauth/types.ts:53](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L53)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="firstfactors-1"></a> `firstFactors?` | `string`[] | [recipe/multifactorauth/types.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L54) |
| <a id="override-1"></a> `override` | `object` | [recipe/multifactorauth/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L56) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/multifactorauth/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L61) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/multifactorauth/types.ts:57](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L57) |

## Variables

### FactorIds

```ts
const FactorIds: object;
```

Defined in: [recipe/multifactorauth/types.ts:151](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L151)

#### Type Declaration

| Name | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="emailpassword"></a> `EMAILPASSWORD` | `string` | `"emailpassword"` | [recipe/multifactorauth/types.ts:152](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L152) |
| <a id="link_email"></a> `LINK_EMAIL` | `string` | `"link-email"` | [recipe/multifactorauth/types.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L156) |
| <a id="link_phone"></a> `LINK_PHONE` | `string` | `"link-phone"` | [recipe/multifactorauth/types.ts:157](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L157) |
| <a id="otp_email"></a> `OTP_EMAIL` | `string` | `"otp-email"` | [recipe/multifactorauth/types.ts:154](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L154) |
| <a id="otp_phone"></a> `OTP_PHONE` | `string` | `"otp-phone"` | [recipe/multifactorauth/types.ts:155](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L155) |
| <a id="thirdparty"></a> `THIRDPARTY` | `string` | `"thirdparty"` | [recipe/multifactorauth/types.ts:158](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L158) |
| <a id="totp"></a> `TOTP` | `string` | `"totp"` | [recipe/multifactorauth/types.ts:159](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L159) |
| <a id="webauthn"></a> `WEBAUTHN` | `string` | `"webauthn"` | [recipe/multifactorauth/types.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L153) |

# References - Backend SDKs - Node.js SDK Reference -  MFA
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-multifactorauth

## Classes

### default

Defined in: [recipe/multifactorauth/index.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L25)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="factorids"></a> `FactorIds` | `static` | `object` | `FactorIds` | [recipe/multifactorauth/index.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L29) |
| `FactorIds.EMAILPASSWORD` | `public` | `string` | `"emailpassword"` | [recipe/multifactorauth/types.ts:152](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L152) |
| `FactorIds.LINK_EMAIL` | `public` | `string` | `"link-email"` | [recipe/multifactorauth/types.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L156) |
| `FactorIds.LINK_PHONE` | `public` | `string` | `"link-phone"` | [recipe/multifactorauth/types.ts:157](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L157) |
| `FactorIds.OTP_EMAIL` | `public` | `string` | `"otp-email"` | [recipe/multifactorauth/types.ts:154](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L154) |
| `FactorIds.OTP_PHONE` | `public` | `string` | `"otp-phone"` | [recipe/multifactorauth/types.ts:155](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L155) |
| `FactorIds.THIRDPARTY` | `public` | `string` | `"thirdparty"` | [recipe/multifactorauth/types.ts:158](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L158) |
| `FactorIds.TOTP` | `public` | `string` | `"totp"` | [recipe/multifactorauth/types.ts:159](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L159) |
| `FactorIds.WEBAUTHN` | `public` | `string` | `"webauthn"` | [recipe/multifactorauth/types.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/types.ts#L153) |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/multifactorauth/index.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L26) |
| <a id="multifactorauthclaim"></a> `MultiFactorAuthClaim` | `static` | `MultiFactorAuthClaimClass` | `MultiFactorAuthClaim` | [recipe/multifactorauth/index.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L28) |

#### Methods

##### addToRequiredSecondaryFactorsForUser()

```ts
static addToRequiredSecondaryFactorsForUser(
   userId, 
   factorId, 
userContext?): Promise<void>;
```

Defined in: [recipe/multifactorauth/index.ts:101](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L101)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`void`\>

##### assertAllowedToSetupFactorElseThrowInvalidClaimError()

```ts
static assertAllowedToSetupFactorElseThrowInvalidClaimError(
   session, 
   factorId, 
userContext?): Promise<void>;
```

Defined in: [recipe/multifactorauth/index.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`void`\>

##### getFactorsSetupForUser()

```ts
static getFactorsSetupForUser(userId, userContext?): Promise<string[]>;
```

Defined in: [recipe/multifactorauth/index.ts:81](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L81)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`string`[]\>

##### getMFARequirementsForAuth()

```ts
static getMFARequirementsForAuth(session, userContext?): Promise<MFARequirementList>;
```

Defined in: [recipe/multifactorauth/index.ts:58](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L58)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`MFARequirementList`](recipe-multifactorauth-types.mdx#mfarequirementlist)\>

##### getRequiredSecondaryFactorsForUser()

```ts
static getRequiredSecondaryFactorsForUser(userId, userContext?): Promise<string[]>;
```

Defined in: [recipe/multifactorauth/index.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L94)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`string`[]\>

##### markFactorAsCompleteInSession()

```ts
static markFactorAsCompleteInSession(
   session, 
   factorId, 
userContext?): Promise<void>;
```

Defined in: [recipe/multifactorauth/index.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L69)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`void`\>

##### removeFromRequiredSecondaryFactorsForUser()

```ts
static removeFromRequiredSecondaryFactorsForUser(
   userId, 
   factorId, 
userContext?): Promise<void>;
```

Defined in: [recipe/multifactorauth/index.ts:113](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L113)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`void`\>

## Variables

### addToRequiredSecondaryFactorsForUser()

```ts
const addToRequiredSecondaryFactorsForUser: (userId, factorId, userContext?) => Promise<void> = Wrapper.addToRequiredSecondaryFactorsForUser;
```

Defined in: [recipe/multifactorauth/index.ts:134](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L134)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`void`\>

***

### assertAllowedToSetupFactorElseThrowInvalidClaimError()

```ts
assertAllowedToSetupFactorElseThrowInvalidClaimError: (session, factorId, userContext?) => Promise<void> = Wrapper.assertAllowedToSetupFactorElseThrowInvalidClaimError;
```

Defined in: [recipe/multifactorauth/index.ts:128](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L128)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`void`\>

***

### getFactorsSetupForUser()

```ts
getFactorsSetupForUser: (userId, userContext?) => Promise<string[]> = Wrapper.getFactorsSetupForUser;
```

Defined in: [recipe/multifactorauth/index.ts:131](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L131)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`string`[]\>

***

### getMFARequirementsForAuth()

```ts
getMFARequirementsForAuth: (session, userContext?) => Promise<MFARequirementList> = Wrapper.getMFARequirementsForAuth;
```

Defined in: [recipe/multifactorauth/index.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L133)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`MFARequirementList`](recipe-multifactorauth-types.mdx#mfarequirementlist)\>

***

### getRequiredSecondaryFactorsForUser()

```ts
getRequiredSecondaryFactorsForUser: (userId, userContext?) => Promise<string[]> = Wrapper.getRequiredSecondaryFactorsForUser;
```

Defined in: [recipe/multifactorauth/index.ts:132](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L132)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`string`[]\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/multifactorauth/index.ts:126](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L126)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-multifactorauth-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### markFactorAsCompleteInSession()

```ts
markFactorAsCompleteInSession: (session, factorId, userContext?) => Promise<void> = Wrapper.markFactorAsCompleteInSession;
```

Defined in: [recipe/multifactorauth/index.ts:130](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L130)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `session` | `SessionContainerInterface` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`void`\>

***

### MultiFactorAuthClaim

```ts
const MultiFactorAuthClaim: MultiFactorAuthClaimClass;
```

Defined in: [recipe/multifactorauth/multiFactorAuthClaim.ts:247](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts#L247)

***

### removeFromRequiredSecondaryFactorsForUser()

```ts
const removeFromRequiredSecondaryFactorsForUser: (userId, factorId, userContext?) => Promise<void> = Wrapper.removeFromRequiredSecondaryFactorsForUser;
```

Defined in: [recipe/multifactorauth/index.ts:135](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multifactorauth/index.ts#L135)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `factorId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`void`\>

## References

### APIInterface

Re-exports [APIInterface](recipe-multifactorauth-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-multifactorauth-types.mdx#apioptions)

***

### FactorIds

Re-exports [FactorIds](recipe-multifactorauth-types.mdx#factorids)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-multifactorauth-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  Account Linking Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-accountlinking-types

## Type Aliases

### AccountInfo

```ts
type AccountInfo = object;
```

Defined in: [recipe/accountlinking/types.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L175)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email"></a> `email?` | `string` | [recipe/accountlinking/types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L176) |
| <a id="phonenumber"></a> `phoneNumber?` | `string` | [recipe/accountlinking/types.ts:177](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L177) |
| <a id="thirdparty"></a> `thirdParty?` | `object` | [recipe/accountlinking/types.ts:178](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L178) |
| `thirdParty.id` | `string` | [recipe/accountlinking/types.ts:179](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L179) |
| `thirdParty.userId` | `string` | [recipe/accountlinking/types.ts:180](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L180) |
| <a id="webauthn"></a> `webauthn?` | `object` | [recipe/accountlinking/types.ts:182](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L182) |
| `webauthn.credentialIds` | `string`[] | [recipe/accountlinking/types.ts:183](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L183) |

***

### AccountInfoInput

```ts
type AccountInfoInput = Omit<AccountInfo, "webauthn"> & object;
```

Defined in: [recipe/accountlinking/types.ts:187](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L187)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `webauthn?` | `object` | [recipe/accountlinking/types.ts:188](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L188) |
| `webauthn.credentialId` | `string` | [recipe/accountlinking/types.ts:189](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L189) |

***

### AccountInfoWithRecipeId

```ts
type AccountInfoWithRecipeId = object & AccountInfo;
```

Defined in: [recipe/accountlinking/types.ts:193](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L193)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `recipeId` | `"emailpassword"` \| `"thirdparty"` \| `"passwordless"` \| `"webauthn"` | [recipe/accountlinking/types.ts:194](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L194) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/accountlinking/types.ts:71](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L71)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="cancreateprimaryuser"></a> `canCreatePrimaryUser` | (`input`) => `Promise`\< \| \{ `status`: `"OK"`; `wasAlreadyAPrimaryUser`: `boolean`; \} \| \{ `description`: `string`; `primaryUserId`: `string`; `status`: \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"` \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; \}\> | [recipe/accountlinking/types.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L84) |
| <a id="canlinkaccounts"></a> `canLinkAccounts` | (`input`) => `Promise`\< \| \{ `accountsAlreadyLinked`: `boolean`; `status`: `"OK"`; \} \| \{ `description`: `string`; `primaryUserId`: `string`; `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; \} \| \{ `description`: `string`; `primaryUserId`: `string`; `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; \} \| \{ `status`: `"INPUT_USER_IS_NOT_A_PRIMARY_USER"`; \}\> | [recipe/accountlinking/types.ts:113](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L113) |
| <a id="createprimaryuser"></a> `createPrimaryUser` | (`input`) => `Promise`\< \| \{ `status`: `"OK"`; `user`: [`User`](types.mdx#user); `wasAlreadyAPrimaryUser`: `boolean`; \} \| \{ `primaryUserId`: `string`; `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"`; \} \| \{ `description`: `string`; `primaryUserId`: `string`; `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; \}\> | [recipe/accountlinking/types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L97) |
| <a id="deleteuser"></a> `deleteUser` | (`input`) => `Promise`\<\{ `status`: `"OK"`; \}\> | [recipe/accountlinking/types.ts:168](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L168) |
| <a id="getuser"></a> `getUser` | (`input`) => `Promise`\<[`User`](types.mdx#user) \| `undefined`\> | [recipe/accountlinking/types.ts:161](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L161) |
| <a id="getusers"></a> `getUsers` | (`input`) => `Promise`\<\{ `nextPaginationToken?`: `string`; `users`: [`User`](types.mdx#user)[]; \}\> | [recipe/accountlinking/types.ts:72](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L72) |
| <a id="linkaccounts"></a> `linkAccounts` | (`input`) => `Promise`\< \| \{ `accountsAlreadyLinked`: `boolean`; `status`: `"OK"`; `user`: [`User`](types.mdx#user); \} \| \{ `primaryUserId`: `string`; `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; `user`: [`User`](types.mdx#user); \} \| \{ `description`: `string`; `primaryUserId`: `string`; `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`; \} \| \{ `status`: `"INPUT_USER_IS_NOT_A_PRIMARY_USER"`; \}\> | [recipe/accountlinking/types.ts:136](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L136) |
| <a id="listusersbyaccountinfo"></a> `listUsersByAccountInfo` | (`input`) => `Promise`\<[`User`](types.mdx#user)[]\> | [recipe/accountlinking/types.ts:162](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L162) |
| <a id="unlinkaccount"></a> `unlinkAccount` | (`input`) => `Promise`\<\{ `status`: `"OK"`; `wasLinked`: `boolean`; `wasRecipeUserDeleted`: `boolean`; \}\> | [recipe/accountlinking/types.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L156) |

***

### RecipeLevelUser

```ts
type RecipeLevelUser = object & AccountInfoWithRecipeId;
```

Defined in: [recipe/accountlinking/types.ts:197](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L197)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) | [recipe/accountlinking/types.ts:200](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L200) |
| `tenantIds` | `string`[] | [recipe/accountlinking/types.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L198) |
| `timeJoined` | `number` | [recipe/accountlinking/types.ts:199](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L199) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/accountlinking/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L21)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="onaccountlinked"></a> `onAccountLinked?` | (`user`, `newAccountInfo`, `userContext`) => `Promise`\<`void`\> | [recipe/accountlinking/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L22) |
| <a id="override"></a> `override?` | `object` | [recipe/accountlinking/types.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L38) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/accountlinking/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L39) |
| <a id="shoulddoautomaticaccountlinking"></a> `shouldDoAutomaticAccountLinking?` | (`newAccountInfo`, `user`, `session`, `tenantId`, `userContext`) => `Promise`\< \| \{ `shouldAutomaticallyLink`: `false`; \} \| \{ `shouldAutomaticallyLink`: `true`; `shouldRequireVerification`: `boolean`; \}\> | [recipe/accountlinking/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L23) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/accountlinking/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L46)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="onaccountlinked-1"></a> `onAccountLinked` | (`user`, `newAccountInfo`, `userContext`) => `Promise`\<`void`\> | [recipe/accountlinking/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L47) |
| <a id="override-1"></a> `override` | `object` | [recipe/accountlinking/types.ts:63](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L63) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/accountlinking/types.ts:64](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L64) |
| <a id="shoulddoautomaticaccountlinking-1"></a> `shouldDoAutomaticAccountLinking` | (`newAccountInfo`, `user`, `session`, `tenantId`, `userContext`) => `Promise`\< \| \{ `shouldAutomaticallyLink`: `false`; \} \| \{ `shouldAutomaticallyLink`: `true`; `shouldRequireVerification`: `boolean`; \}\> | [recipe/accountlinking/types.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/types.ts#L48) |

# References - Backend SDKs - Node.js SDK Reference -  Account Linking
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-accountlinking

## Classes

### default

Defined in: [recipe/accountlinking/index.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L23)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/accountlinking/index.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L24) |

#### Methods

##### canCreatePrimaryUser()

```ts
static canCreatePrimaryUser(recipeUserId, userContext?): Promise<
  | {
  status: "OK";
  wasAlreadyAPrimaryUser: boolean;
}
  | {
  description: string;
  primaryUserId: string;
  status:   | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR";
}>;
```

Defined in: [recipe/accountlinking/index.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L84)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `wasAlreadyAPrimaryUser`: `boolean`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`:   \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"`;
\}\>

##### canLinkAccounts()

```ts
static canLinkAccounts(
   recipeUserId, 
   primaryUserId, 
   userContext?): Promise<
  | {
  accountsAlreadyLinked: boolean;
  status: "OK";
}
  | {
  description: string;
  primaryUserId: string;
  status: "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}
  | {
  description: string;
  primaryUserId: string;
  status: "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}
  | {
  status: "INPUT_USER_IS_NOT_A_PRIMARY_USER";
}>;
```

Defined in: [recipe/accountlinking/index.ts:98](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L98)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `primaryUserId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `accountsAlreadyLinked`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `status`: `"INPUT_USER_IS_NOT_A_PRIMARY_USER"`;
\}\>

##### createPrimaryUser()

```ts
static createPrimaryUser(recipeUserId, userContext?): Promise<
  | {
  status: "OK";
  user: User;
  wasAlreadyAPrimaryUser: boolean;
}
  | {
  primaryUserId: string;
  status: "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR";
}
  | {
  description: string;
  primaryUserId: string;
  status: "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}>;
```

Defined in: [recipe/accountlinking/index.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L91)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
  `wasAlreadyAPrimaryUser`: `boolean`;
\}
  \| \{
  `primaryUserId`: `string`;
  `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}\>

##### createPrimaryUserIdOrLinkAccounts()

```ts
static createPrimaryUserIdOrLinkAccounts(
   tenantId, 
   recipeUserId, 
   session?, 
userContext?): Promise<User>;
```

Defined in: [recipe/accountlinking/index.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L35)

This is a function which is a combination of createPrimaryUser and
linkAccounts where the input recipeUserId is either linked to a user that it can be
linked to, or is made into a primary user.

The output will be the user ID of the user that it was linked to, or it will be the
same as the input recipeUserId if it was made into a primary user, or if there was
no linking that happened.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`User`](types.mdx#user)\>

##### getPrimaryUserThatCanBeLinkedToRecipeUserId()

```ts
static getPrimaryUserThatCanBeLinkedToRecipeUserId(
   tenantId, 
   recipeUserId, 
userContext?): Promise<User>;
```

Defined in: [recipe/accountlinking/index.ts:67](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L67)

This function returns the primary user that the input recipe ID can be
linked to. It can be used to determine which primary account the linking
will happen to if the input recipe user ID was to be linked.

If the function returns undefined, it means that there is no primary user
that the input recipe ID can be linked to, and therefore it can be made
into a primary user itself.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<[`User`](types.mdx#user)\>

##### isEmailChangeAllowed()

```ts
static isEmailChangeAllowed(
   recipeUserId, 
   newEmail, 
   isVerified, 
   session?, 
userContext?): Promise<boolean>;
```

Defined in: [recipe/accountlinking/index.ts:159](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L159)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `newEmail` | `string` |
| `isVerified` | `boolean` |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`boolean`\>

##### isSignInAllowed()

```ts
static isSignInAllowed(
   tenantId, 
   recipeUserId, 
   session?, 
userContext?): Promise<boolean>;
```

Defined in: [recipe/accountlinking/index.ts:137](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L137)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`boolean`\>

##### isSignUpAllowed()

```ts
static isSignUpAllowed(
   tenantId, 
   newUser, 
   isVerified, 
   session?, 
userContext?): Promise<boolean>;
```

Defined in: [recipe/accountlinking/index.ts:121](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L121)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `newUser` | [`AccountInfoWithRecipeId`](recipe-accountlinking-types.mdx#accountinfowithrecipeid) |
| `isVerified` | `boolean` |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`boolean`\>

##### linkAccounts()

```ts
static linkAccounts(
   recipeUserId, 
   primaryUserId, 
   userContext?): Promise<
  | {
  accountsAlreadyLinked: boolean;
  status: "OK";
  user: User;
}
  | {
  primaryUserId: string;
  status: "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  user: User;
}
  | {
  description: string;
  primaryUserId: string;
  status: "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}
  | {
  status: "INPUT_USER_IS_NOT_A_PRIMARY_USER";
}>;
```

Defined in: [recipe/accountlinking/index.ts:106](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L106)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `primaryUserId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `accountsAlreadyLinked`: `boolean`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `primaryUserId`: `string`;
  `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `status`: `"INPUT_USER_IS_NOT_A_PRIMARY_USER"`;
\}\>

##### unlinkAccount()

```ts
static unlinkAccount(recipeUserId, userContext?): Promise<{
  status: "OK";
  wasLinked: boolean;
  wasRecipeUserDeleted: boolean;
}>;
```

Defined in: [recipe/accountlinking/index.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L114)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
  `wasLinked`: `boolean`;
  `wasRecipeUserDeleted`: `boolean`;
\}\>

## Variables

### canCreatePrimaryUser()

```ts
const canCreatePrimaryUser: (recipeUserId, userContext?) => Promise<
  | {
  status: "OK";
  wasAlreadyAPrimaryUser: boolean;
}
  | {
  description: string;
  primaryUserId: string;
  status:   | "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
     | "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR";
}> = Wrapper.canCreatePrimaryUser;
```

Defined in: [recipe/accountlinking/index.ts:184](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L184)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `wasAlreadyAPrimaryUser`: `boolean`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`:   \| `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`
     \| `"RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"`;
\}\>

***

### canLinkAccounts()

```ts
const canLinkAccounts: (recipeUserId, primaryUserId, userContext?) => Promise<
  | {
  accountsAlreadyLinked: boolean;
  status: "OK";
}
  | {
  description: string;
  primaryUserId: string;
  status: "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}
  | {
  description: string;
  primaryUserId: string;
  status: "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}
  | {
  status: "INPUT_USER_IS_NOT_A_PRIMARY_USER";
}> = Wrapper.canLinkAccounts;
```

Defined in: [recipe/accountlinking/index.ts:186](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L186)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `primaryUserId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `accountsAlreadyLinked`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `status`: `"INPUT_USER_IS_NOT_A_PRIMARY_USER"`;
\}\>

***

### createPrimaryUser()

```ts
const createPrimaryUser: (recipeUserId, userContext?) => Promise<
  | {
  status: "OK";
  user: User;
  wasAlreadyAPrimaryUser: boolean;
}
  | {
  primaryUserId: string;
  status: "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR";
}
  | {
  description: string;
  primaryUserId: string;
  status: "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}> = Wrapper.createPrimaryUser;
```

Defined in: [recipe/accountlinking/index.ts:185](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L185)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
  `wasAlreadyAPrimaryUser`: `boolean`;
\}
  \| \{
  `primaryUserId`: `string`;
  `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}\>

***

### createPrimaryUserIdOrLinkAccounts()

```ts
const createPrimaryUserIdOrLinkAccounts: (tenantId, recipeUserId, session?, userContext?) => Promise<User> = Wrapper.createPrimaryUserIdOrLinkAccounts;
```

Defined in: [recipe/accountlinking/index.ts:189](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L189)

This is a function which is a combination of createPrimaryUser and
linkAccounts where the input recipeUserId is either linked to a user that it can be
linked to, or is made into a primary user.

The output will be the user ID of the user that it was linked to, or it will be the
same as the input recipeUserId if it was made into a primary user, or if there was
no linking that happened.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`User`](types.mdx#user)\>

***

### getPrimaryUserThatCanBeLinkedToRecipeUserId()

```ts
const getPrimaryUserThatCanBeLinkedToRecipeUserId: (tenantId, recipeUserId, userContext?) => Promise<User> = Wrapper.getPrimaryUserThatCanBeLinkedToRecipeUserId;
```

Defined in: [recipe/accountlinking/index.ts:190](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L190)

This function returns the primary user that the input recipe ID can be
linked to. It can be used to determine which primary account the linking
will happen to if the input recipe user ID was to be linked.

If the function returns undefined, it means that there is no primary user
that the input recipe ID can be linked to, and therefore it can be made
into a primary user itself.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<[`User`](types.mdx#user)\>

***

### init()

```ts
const init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/accountlinking/index.ts:183](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L183)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-accountlinking-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### isEmailChangeAllowed()

```ts
const isEmailChangeAllowed: (recipeUserId, newEmail, isVerified, session?, userContext?) => Promise<boolean> = Wrapper.isEmailChangeAllowed;
```

Defined in: [recipe/accountlinking/index.ts:193](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L193)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `newEmail` | `string` |
| `isVerified` | `boolean` |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`boolean`\>

***

### isSignInAllowed()

```ts
const isSignInAllowed: (tenantId, recipeUserId, session?, userContext?) => Promise<boolean> = Wrapper.isSignInAllowed;
```

Defined in: [recipe/accountlinking/index.ts:192](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L192)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`boolean`\>

***

### isSignUpAllowed()

```ts
const isSignUpAllowed: (tenantId, newUser, isVerified, session?, userContext?) => Promise<boolean> = Wrapper.isSignUpAllowed;
```

Defined in: [recipe/accountlinking/index.ts:191](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L191)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `newUser` | [`AccountInfoWithRecipeId`](recipe-accountlinking-types.mdx#accountinfowithrecipeid) |
| `isVerified` | `boolean` |
| `session?` | `SessionContainerInterface` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`boolean`\>

***

### linkAccounts()

```ts
const linkAccounts: (recipeUserId, primaryUserId, userContext?) => Promise<
  | {
  accountsAlreadyLinked: boolean;
  status: "OK";
  user: User;
}
  | {
  primaryUserId: string;
  status: "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
  user: User;
}
  | {
  description: string;
  primaryUserId: string;
  status: "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR";
}
  | {
  status: "INPUT_USER_IS_NOT_A_PRIMARY_USER";
}> = Wrapper.linkAccounts;
```

Defined in: [recipe/accountlinking/index.ts:187](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L187)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `primaryUserId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `accountsAlreadyLinked`: `boolean`;
  `status`: `"OK"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `primaryUserId`: `string`;
  `status`: `"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
  `user`: [`User`](types.mdx#user);
\}
  \| \{
  `description`: `string`;
  `primaryUserId`: `string`;
  `status`: `"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"`;
\}
  \| \{
  `status`: `"INPUT_USER_IS_NOT_A_PRIMARY_USER"`;
\}\>

***

### unlinkAccount()

```ts
const unlinkAccount: (recipeUserId, userContext?) => Promise<{
  status: "OK";
  wasLinked: boolean;
  wasRecipeUserDeleted: boolean;
}> = Wrapper.unlinkAccount;
```

Defined in: [recipe/accountlinking/index.ts:188](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/accountlinking/index.ts#L188)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
  `wasLinked`: `boolean`;
  `wasRecipeUserDeleted`: `boolean`;
\}\>

## References

### RecipeInterface

Re-exports [RecipeInterface](recipe-accountlinking-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  JWT Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-jwt-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/jwt/types.ts:82](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L82)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getjwksget"></a> `getJWKSGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `keys`: [`JsonWebKey`](#jsonwebkey)[]; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/jwt/types.ts:83](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L83) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/jwt/types.ts:51](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L51)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/jwt/types.ts:53](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L53) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/jwt/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L55) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/jwt/types.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L54) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/jwt/types.ts:52](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L52) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/jwt/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L56) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/jwt/types.ts:57](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L57) |

***

### JsonWebKey

```ts
type JsonWebKey = object;
```

Defined in: [recipe/jwt/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L20)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="alg"></a> `alg` | `string` | [recipe/jwt/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L25) |
| <a id="e"></a> `e` | `string` | [recipe/jwt/types.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L24) |
| <a id="kid"></a> `kid` | `string` | [recipe/jwt/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L22) |
| <a id="kty"></a> `kty` | `string` | [recipe/jwt/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L21) |
| <a id="n"></a> `n` | `string` | [recipe/jwt/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L23) |
| <a id="use"></a> `use` | `string` | [recipe/jwt/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L26) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/jwt/types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L60)

#### Methods

##### createJWT()

```ts
createJWT(input): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;
```

Defined in: [recipe/jwt/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L61)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `payload?`: `any`; `userContext`: [`UserContext`](types.mdx#usercontext); `useStaticSigningKey?`: `boolean`; `validitySeconds?`: `number`; \} |
| `input.payload?` | `any` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.useStaticSigningKey?` | `boolean` |
| `input.validitySeconds?` | `number` |

###### Returns

`Promise`\<
  \| \{
  `jwt`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNSUPPORTED_ALGORITHM_ERROR"`;
\}\>

##### getJWKS()

```ts
getJWKS(input): Promise<{
  keys: JsonWebKey[];
  validityInSeconds?: number;
}>;
```

Defined in: [recipe/jwt/types.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L76)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `keys`: [`JsonWebKey`](#jsonwebkey)[];
  `validityInSeconds?`: `number`;
\}\>

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/jwt/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="jwtvalidityseconds"></a> `jwtValiditySeconds?` | `number` | [recipe/jwt/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L30) |
| <a id="override"></a> `override?` | `object` | [recipe/jwt/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L31) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/jwt/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L36) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/jwt/types.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L32) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/jwt/types.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L40)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="jwtvalidityseconds-1"></a> `jwtValiditySeconds` | `number` | [recipe/jwt/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L41) |
| <a id="override-1"></a> `override` | `object` | [recipe/jwt/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L42) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/jwt/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L47) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/jwt/types.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/types.ts#L43) |

# References - Backend SDKs - Node.js SDK Reference -  JWT
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-jwt

## Classes

### default

Defined in: [recipe/jwt/index.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L20)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/jwt/index.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L21) |

#### Methods

##### createJWT()

```ts
static createJWT(
   payload, 
   validitySeconds?, 
   useStaticSigningKey?, 
   userContext?): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;
```

Defined in: [recipe/jwt/index.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L23)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `validitySeconds?` | `number` |
| `useStaticSigningKey?` | `boolean` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `jwt`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNSUPPORTED_ALGORITHM_ERROR"`;
\}\>

##### getJWKS()

```ts
static getJWKS(userContext?): Promise<{
  keys: JsonWebKey[];
  validityInSeconds?: number;
}>;
```

Defined in: [recipe/jwt/index.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L37)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `keys`: [`JsonWebKey`](recipe-jwt-types.mdx#jsonwebkey)[];
  `validityInSeconds?`: `number`;
\}\>

## Variables

### createJWT()

```ts
createJWT: (payload, validitySeconds?, useStaticSigningKey?, userContext?) => Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}> = Wrapper.createJWT;
```

Defined in: [recipe/jwt/index.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L45)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `validitySeconds?` | `number` |
| `useStaticSigningKey?` | `boolean` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `jwt`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNSUPPORTED_ALGORITHM_ERROR"`;
\}\>

***

### getJWKS()

```ts
getJWKS: (userContext?) => Promise<{
  keys: JsonWebKey[];
  validityInSeconds?: number;
}> = Wrapper.getJWKS;
```

Defined in: [recipe/jwt/index.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L46)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `keys`: [`JsonWebKey`](recipe-jwt-types.mdx#jsonwebkey)[];
  `validityInSeconds?`: `number`;
\}\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/jwt/index.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/jwt/index.ts#L44)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-jwt-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

## References

### APIInterface

Re-exports [APIInterface](recipe-jwt-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-jwt-types.mdx#apioptions)

***

### JsonWebKey

Re-exports [JsonWebKey](recipe-jwt-types.mdx#jsonwebkey)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-jwt-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  MultiTenancy Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-multitenancy-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/multitenancy/types.ts:145](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L145)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="loginmethodsget"></a> `loginMethodsGET` | (`input`) => `Promise`\< \| \{ `emailPassword`: \{ `enabled`: `boolean`; \}; `firstFactors`: `string`[]; `passwordless`: \{ `enabled`: `boolean`; \}; `status`: `"OK"`; `thirdParty`: \{ `enabled`: `boolean`; `providers`: `object`[]; \}; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/multitenancy/types.ts:146](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L146) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/multitenancy/types.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L133)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="allavailablefirstfactors"></a> `allAvailableFirstFactors` | `string`[] | [recipe/multitenancy/types.ts:141](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L141) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/multitenancy/types.ts:135](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L135) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/multitenancy/types.ts:137](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L137) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/multitenancy/types.ts:136](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L136) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/multitenancy/types.ts:134](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L134) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/multitenancy/types.ts:138](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L138) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/multitenancy/types.ts:139](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L139) |
| <a id="staticfirstfactors"></a> `staticFirstFactors` | `string`[] \| `undefined` | [recipe/multitenancy/types.ts:142](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L142) |
| <a id="staticthirdpartyproviders"></a> `staticThirdPartyProviders` | [`ProviderInput`](recipe-thirdparty-types.mdx#providerinput)[] | [recipe/multitenancy/types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L140) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/multitenancy/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L55)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="associateusertotenant"></a> `associateUserToTenant` | (`input`) => `Promise`\< \| \{ `status`: `"OK"`; `wasAlreadyAssociated`: `boolean`; \} \| \{ `status`: \| `"UNKNOWN_USER_ID_ERROR"` \| `"EMAIL_ALREADY_EXISTS_ERROR"` \| `"PHONE_NUMBER_ALREADY_EXISTS_ERROR"` \| `"THIRD_PARTY_USER_ALREADY_EXISTS_ERROR"`; \} \| \{ `reason`: `string`; `status`: `"ASSOCIATION_NOT_ALLOWED_ERROR"`; \}\> | [recipe/multitenancy/types.ts:102](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L102) |
| <a id="createorupdatetenant"></a> `createOrUpdateTenant` | (`input`) => `Promise`\<\{ `createdNew`: `boolean`; `status`: `"OK"`; \}\> | [recipe/multitenancy/types.ts:59](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L59) |
| <a id="createorupdatethirdpartyconfig"></a> `createOrUpdateThirdPartyConfig` | (`input`) => `Promise`\<\{ `createdNew`: `boolean`; `status`: `"OK"`; \}\> | [recipe/multitenancy/types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L87) |
| <a id="deletetenant"></a> `deleteTenant` | (`input`) => `Promise`\<\{ `didExist`: `boolean`; `status`: `"OK"`; \}\> | [recipe/multitenancy/types.ts:71](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L71) |
| <a id="deletethirdpartyconfig"></a> `deleteThirdPartyConfig` | (`input`) => `Promise`\<\{ `didConfigExist`: `boolean`; `status`: `"OK"`; \}\> | [recipe/multitenancy/types.ts:96](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L96) |
| <a id="disassociateuserfromtenant"></a> `disassociateUserFromTenant` | (`input`) => `Promise`\<\{ `status`: `"OK"`; `wasAssociated`: `boolean`; \}\> | [recipe/multitenancy/types.ts:123](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L123) |
| <a id="gettenant"></a> `getTenant` | (`input`) => `Promise`\<`object` & [`TenantConfig`](#tenantconfig) \| `undefined`\> | [recipe/multitenancy/types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L75) |
| <a id="gettenantid"></a> `getTenantId` | (`input`) => `Promise`\<`string`\> | [recipe/multitenancy/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L56) |
| <a id="listalltenants"></a> `listAllTenants` | (`input`) => `Promise`\<\{ `status`: `"OK"`; `tenants`: [`TenantConfig`](#tenantconfig) & `object`[]; \}\> | [recipe/multitenancy/types.ts:81](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L81) |

***

### TenantConfig

```ts
type TenantConfig = object;
```

Defined in: [recipe/multitenancy/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L46)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="coreconfig"></a> `coreConfig` | `object` | [recipe/multitenancy/types.ts:52](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L52) |
| <a id="firstfactors"></a> `firstFactors?` | `string`[] | [recipe/multitenancy/types.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L50) |
| <a id="requiredsecondaryfactors"></a> `requiredSecondaryFactors?` | `string`[] | [recipe/multitenancy/types.ts:51](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L51) |
| <a id="thirdparty"></a> `thirdParty` | `object` | [recipe/multitenancy/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L47) |
| `thirdParty.providers` | [`ProviderConfig`](recipe-thirdparty-types.mdx#providerconfig)[] | [recipe/multitenancy/types.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L48) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/multitenancy/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L22)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getalloweddomainsfortenantid"></a> `getAllowedDomainsForTenantId?` | (`tenantId`, `userContext`) => `Promise`\<`string`[] \| `undefined`\> | [recipe/multitenancy/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L23) |
| <a id="override"></a> `override?` | `object` | [recipe/multitenancy/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L25) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/multitenancy/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L30) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/multitenancy/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L26) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/multitenancy/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L34)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getalloweddomainsfortenantid-1"></a> `getAllowedDomainsForTenantId?` | (`tenantId`, `userContext`) => `Promise`\<`string`[] \| `undefined`\> | [recipe/multitenancy/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L35) |
| <a id="override-1"></a> `override` | `object` | [recipe/multitenancy/types.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L37) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/multitenancy/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L42) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/multitenancy/types.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/types.ts#L38) |

# References - Backend SDKs - Node.js SDK Reference -  MultiTenancy
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-multitenancy

## Classes

### default

Defined in: [recipe/multitenancy/index.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L23)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/multitenancy/index.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L24) |

#### Methods

##### associateUserToTenant()

```ts
static associateUserToTenant(
   tenantId, 
   recipeUserId, 
   userContext?): Promise<
  | {
  status: "OK";
  wasAlreadyAssociated: boolean;
}
  | {
  status:   | "EMAIL_ALREADY_EXISTS_ERROR"
     | "UNKNOWN_USER_ID_ERROR"
     | "PHONE_NUMBER_ALREADY_EXISTS_ERROR"
     | "THIRD_PARTY_USER_ALREADY_EXISTS_ERROR";
}
  | {
  reason: string;
  status: "ASSOCIATION_NOT_ALLOWED_ERROR";
}>;
```

Defined in: [recipe/multitenancy/index.ts:124](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L124)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `wasAlreadyAssociated`: `boolean`;
\}
  \| \{
  `status`:   \| `"EMAIL_ALREADY_EXISTS_ERROR"`
     \| `"UNKNOWN_USER_ID_ERROR"`
     \| `"PHONE_NUMBER_ALREADY_EXISTS_ERROR"`
     \| `"THIRD_PARTY_USER_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"ASSOCIATION_NOT_ALLOWED_ERROR"`;
\}\>

##### createOrUpdateTenant()

```ts
static createOrUpdateTenant(
   tenantId, 
   config?, 
   userContext?): Promise<{
  createdNew: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/multitenancy/index.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L26)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `config?` | \{ `coreConfig?`: \{ \[`key`: `string`\]: `any`; \}; `firstFactors?`: `string`[]; `requiredSecondaryFactors?`: `string`[]; \} |
| `config.coreConfig?` | \{ \[`key`: `string`\]: `any`; \} |
| `config.firstFactors?` | `string`[] |
| `config.requiredSecondaryFactors?` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `createdNew`: `boolean`;
  `status`: `"OK"`;
\}\>

##### createOrUpdateThirdPartyConfig()

```ts
static createOrUpdateThirdPartyConfig(
   tenantId, 
   config, 
   skipValidation?, 
   userContext?): Promise<{
  createdNew: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/multitenancy/index.ts:90](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L90)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `config` | [`ProviderConfig`](recipe-thirdparty-types.mdx#providerconfig) |
| `skipValidation?` | `boolean` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `createdNew`: `boolean`;
  `status`: `"OK"`;
\}\>

##### deleteTenant()

```ts
static deleteTenant(tenantId, userContext?): Promise<{
  didExist: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/multitenancy/index.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L46)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `didExist`: `boolean`;
  `status`: `"OK"`;
\}\>

##### deleteThirdPartyConfig()

```ts
static deleteThirdPartyConfig(
   tenantId, 
   thirdPartyId, 
   userContext?): Promise<{
  didConfigExist: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/multitenancy/index.ts:108](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L108)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `didConfigExist`: `boolean`;
  `status`: `"OK"`;
\}\>

##### disassociateUserFromTenant()

```ts
static disassociateUserFromTenant(
   tenantId, 
   recipeUserId, 
   userContext?): Promise<{
  status: "OK";
  wasAssociated: boolean;
}>;
```

Defined in: [recipe/multitenancy/index.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L153)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
  `wasAssociated`: `boolean`;
\}\>

##### getTenant()

```ts
static getTenant(tenantId, userContext?): Promise<object & TenantConfig>;
```

Defined in: [recipe/multitenancy/index.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L60)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<`object` & [`TenantConfig`](recipe-multitenancy-types.mdx#tenantconfig)\>

##### listAllTenants()

```ts
static listAllTenants(userContext?): Promise<{
  status: "OK";
  tenants: object & TenantConfig[];
}>;
```

Defined in: [recipe/multitenancy/index.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L76)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
  `tenants`: `object` & [`TenantConfig`](recipe-multitenancy-types.mdx#tenantconfig)[];
\}\>

## Variables

### AllowedDomainsClaim

```ts
const AllowedDomainsClaim: AllowedDomainsClaimClass;
```

Defined in: [recipe/multitenancy/allowedDomainsClaim.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/allowedDomainsClaim.ts#L23)

***

### associateUserToTenant()

```ts
associateUserToTenant: (tenantId, recipeUserId, userContext?) => Promise<
  | {
  status: "OK";
  wasAlreadyAssociated: boolean;
}
  | {
  status:   | "EMAIL_ALREADY_EXISTS_ERROR"
     | "UNKNOWN_USER_ID_ERROR"
     | "PHONE_NUMBER_ALREADY_EXISTS_ERROR"
     | "THIRD_PARTY_USER_ALREADY_EXISTS_ERROR";
}
  | {
  reason: string;
  status: "ASSOCIATION_NOT_ALLOWED_ERROR";
}> = Wrapper.associateUserToTenant;
```

Defined in: [recipe/multitenancy/index.ts:180](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L180)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `wasAlreadyAssociated`: `boolean`;
\}
  \| \{
  `status`:   \| `"EMAIL_ALREADY_EXISTS_ERROR"`
     \| `"UNKNOWN_USER_ID_ERROR"`
     \| `"PHONE_NUMBER_ALREADY_EXISTS_ERROR"`
     \| `"THIRD_PARTY_USER_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `reason`: `string`;
  `status`: `"ASSOCIATION_NOT_ALLOWED_ERROR"`;
\}\>

***

### createOrUpdateTenant()

```ts
createOrUpdateTenant: (tenantId, config?, userContext?) => Promise<{
  createdNew: boolean;
  status: "OK";
}> = Wrapper.createOrUpdateTenant;
```

Defined in: [recipe/multitenancy/index.ts:172](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L172)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `config?` | \{ `coreConfig?`: \{ \[`key`: `string`\]: `any`; \}; `firstFactors?`: `string`[]; `requiredSecondaryFactors?`: `string`[]; \} |
| `config.coreConfig?` | \{ \[`key`: `string`\]: `any`; \} |
| `config.firstFactors?` | `string`[] |
| `config.requiredSecondaryFactors?` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `createdNew`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### createOrUpdateThirdPartyConfig()

```ts
createOrUpdateThirdPartyConfig: (tenantId, config, skipValidation?, userContext?) => Promise<{
  createdNew: boolean;
  status: "OK";
}> = Wrapper.createOrUpdateThirdPartyConfig;
```

Defined in: [recipe/multitenancy/index.ts:177](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L177)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `config` | [`ProviderConfig`](recipe-thirdparty-types.mdx#providerconfig) |
| `skipValidation?` | `boolean` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `createdNew`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### deleteTenant()

```ts
deleteTenant: (tenantId, userContext?) => Promise<{
  didExist: boolean;
  status: "OK";
}> = Wrapper.deleteTenant;
```

Defined in: [recipe/multitenancy/index.ts:173](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L173)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `didExist`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### deleteThirdPartyConfig()

```ts
deleteThirdPartyConfig: (tenantId, thirdPartyId, userContext?) => Promise<{
  didConfigExist: boolean;
  status: "OK";
}> = Wrapper.deleteThirdPartyConfig;
```

Defined in: [recipe/multitenancy/index.ts:178](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L178)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `thirdPartyId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `didConfigExist`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### disassociateUserFromTenant()

```ts
disassociateUserFromTenant: (tenantId, recipeUserId, userContext?) => Promise<{
  status: "OK";
  wasAssociated: boolean;
}> = Wrapper.disassociateUserFromTenant;
```

Defined in: [recipe/multitenancy/index.ts:181](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L181)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
  `wasAssociated`: `boolean`;
\}\>

***

### getTenant()

```ts
getTenant: (tenantId, userContext?) => Promise<object & TenantConfig> = Wrapper.getTenant;
```

Defined in: [recipe/multitenancy/index.ts:174](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L174)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<`object` & [`TenantConfig`](recipe-multitenancy-types.mdx#tenantconfig)\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/multitenancy/index.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L170)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-multitenancy-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### listAllTenants()

```ts
listAllTenants: (userContext?) => Promise<{
  status: "OK";
  tenants: object & TenantConfig[];
}> = Wrapper.listAllTenants;
```

Defined in: [recipe/multitenancy/index.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/multitenancy/index.ts#L175)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
  `tenants`: `object` & [`TenantConfig`](recipe-multitenancy-types.mdx#tenantconfig)[];
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-multitenancy-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-multitenancy-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-multitenancy-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  Dashboard Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-dashboard-types

## Type Aliases

### APIFunction()

```ts
type APIFunction = (apiImplementation, tenantId, options, userContext) => Promise<any>;
```

Defined in: [recipe/dashboard/types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L68)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `apiImplementation` | [`APIInterface`](#apiinterface) |
| `tenantId` | `string` |
| `options` | [`APIOptions`](#apioptions) |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<`any`\>

***

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/dashboard/types.ts:64](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L64)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="dashboardget"></a> `dashboardGET` | `undefined` \| (`input`) => `Promise`\<`string`\> | [recipe/dashboard/types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L65) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/dashboard/types.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L54)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types.mdx#normalisedappinfo) | [recipe/dashboard/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L61) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/dashboard/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L56) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/dashboard/types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L60) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/dashboard/types.ts:57](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L57) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/dashboard/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L55) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/dashboard/types.ts:58](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L58) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/dashboard/types.ts:59](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L59) |

***

### AuthMode

```ts
type AuthMode = "api-key" | "email-password";
```

Defined in: [recipe/dashboard/types.ts:77](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L77)

***

### CoreConfigFieldInfo

```ts
type CoreConfigFieldInfo = object;
```

Defined in: [recipe/dashboard/types.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L84)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultvalue"></a> `defaultValue` | `string` \| `number` \| `boolean` \| `null` | [recipe/dashboard/types.ts:92](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L92) |
| <a id="description"></a> `description` | `string` | [recipe/dashboard/types.ts:88](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L88) |
| <a id="isdifferentacrosstenants"></a> `isDifferentAcrossTenants` | `boolean` | [recipe/dashboard/types.ts:89](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L89) |
| <a id="isnullable"></a> `isNullable` | `boolean` | [recipe/dashboard/types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L91) |
| <a id="ispluginproperty"></a> `isPluginProperty` | `boolean` | [recipe/dashboard/types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L93) |
| <a id="ispluginpropertyeditable"></a> `isPluginPropertyEditable` | `boolean` | [recipe/dashboard/types.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L94) |
| <a id="key"></a> `key` | `string` | [recipe/dashboard/types.ts:85](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L85) |
| <a id="possiblevalues"></a> `possibleValues?` | `string`[] | [recipe/dashboard/types.ts:90](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L90) |
| <a id="value"></a> `value` | `string` \| `number` \| `boolean` \| `null` | [recipe/dashboard/types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L87) |
| <a id="valuetype"></a> `valueType` | `"string"` \| `"boolean"` \| `"number"` | [recipe/dashboard/types.ts:86](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L86) |

***

### RecipeIdForUser

```ts
type RecipeIdForUser = "emailpassword" | "thirdparty" | "passwordless" | "webauthn";
```

Defined in: [recipe/dashboard/types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L75)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/dashboard/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L45)

#### Methods

##### getDashboardBundleLocation()

```ts
getDashboardBundleLocation(input): Promise<string>;
```

Defined in: [recipe/dashboard/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L46)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<`string`\>

##### shouldAllowAccess()

```ts
shouldAllowAccess(input): Promise<boolean>;
```

Defined in: [recipe/dashboard/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L47)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `config`: [`TypeNormalisedInput`](#typenormalisedinput); `req`: `BaseRequest`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.config` | [`TypeNormalisedInput`](#typenormalisedinput) |
| `input.req` | `BaseRequest` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<`boolean`\>

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/dashboard/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L20)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="admins"></a> `admins?` | `string`[] | [recipe/dashboard/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L22) |
| <a id="apikey"></a> `apiKey?` | `string` | [recipe/dashboard/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L21) |
| <a id="override"></a> `override?` | `object` | [recipe/dashboard/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L23) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/dashboard/types.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L28) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/dashboard/types.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L24) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/dashboard/types.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L32)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="admins-1"></a> `admins?` | `string`[] | [recipe/dashboard/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L34) |
| <a id="apikey-1"></a> `apiKey?` | `string` | [recipe/dashboard/types.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L33) |
| <a id="authmode-1"></a> `authMode` | [`AuthMode`](#authmode) | [recipe/dashboard/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L35) |
| <a id="override-1"></a> `override` | `object` | [recipe/dashboard/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L36) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/dashboard/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L41) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/dashboard/types.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L37) |

***

### UserWithFirstAndLastName

```ts
type UserWithFirstAndLastName = User & object;
```

Defined in: [recipe/dashboard/types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L79)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `firstName?` | `string` | [recipe/dashboard/types.ts:80](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L80) |
| `lastName?` | `string` | [recipe/dashboard/types.ts:81](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L81) |

# References - Backend SDKs - Node.js SDK Reference -  Dashboard
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-dashboard

## Classes

### default

Defined in: [recipe/dashboard/index.ts:18](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/index.ts#L18)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/dashboard/index.ts:19](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/index.ts#L19) |

## Variables

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/dashboard/index.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/index.ts#L22)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-dashboard-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

## References

### APIInterface

Re-exports [APIInterface](recipe-dashboard-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-dashboard-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-dashboard-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  OAuth Provider Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-oauth2provider-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/oauth2provider/types.ts:419](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L419)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authget"></a> `authGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `cookies?`: `string`[]; `redirectTo`: `string`; \} \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:430](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L430) |
| <a id="endsessionget"></a> `endSessionGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `redirectTo`: `string`; \} \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:482](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L482) |
| <a id="endsessionpost"></a> `endSessionPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `redirectTo`: `string`; \} \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:491](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L491) |
| <a id="introspecttokenpost"></a> `introspectTokenPOST` | \| `undefined` \| (`input`) => `Promise`\< \| [`InstrospectTokenResponse`](#instrospecttokenresponse) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse) \| [`ErrorOAuth2`](#erroroauth2)\> | [recipe/oauth2provider/types.ts:474](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L474) |
| <a id="loginget"></a> `loginGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `cookies?`: `string`[]; `frontendRedirectTo`: `string`; \} \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:420](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L420) |
| <a id="logininfoget"></a> `loginInfoGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `info`: [`LoginInfo`](#logininfo); `status`: `"OK"`; \} \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:448](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L448) |
| <a id="logoutpost"></a> `logoutPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `frontendRedirectTo`: `string`; `status`: `"OK"`; \} \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:500](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L500) |
| <a id="revoketokenpost"></a> `revokeTokenPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; \} \| [`ErrorOAuth2`](#erroroauth2)\> | [recipe/oauth2provider/types.ts:465](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L465) |
| <a id="tokenpost"></a> `tokenPOST` | \| `undefined` \| (`input`) => `Promise`\< \| [`TokenInfo`](#tokeninfo) \| [`ErrorOAuth2`](#erroroauth2) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:440](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L440) |
| <a id="userinfoget"></a> `userInfoGET` | \| `undefined` \| (`input`) => `Promise`\< \| [`JSONObject`](types.mdx#jsonobject) \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/oauth2provider/types.ts:455](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L455) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/oauth2provider/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L44)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/oauth2provider/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L46) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/oauth2provider/types.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L48) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/oauth2provider/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L47) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/oauth2provider/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L45) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/oauth2provider/types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L49) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/oauth2provider/types.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L50) |

***

### ConsentRequest

```ts
type ConsentRequest = object;
```

Defined in: [recipe/oauth2provider/types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L68)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="acr"></a> `acr?` | `string` | [recipe/oauth2provider/types.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L70) |
| <a id="amr"></a> `amr?` | `string`[] | [recipe/oauth2provider/types.ts:73](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L73) |
| <a id="challenge"></a> `challenge` | `string` | [recipe/oauth2provider/types.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L76) |
| <a id="client"></a> `client?` | `OAuth2Client` | [recipe/oauth2provider/types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L79) |
| <a id="context"></a> `context?` | [`JSONObject`](types.mdx#jsonobject) | [recipe/oauth2provider/types.ts:82](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L82) |
| <a id="loginchallenge"></a> `loginChallenge?` | `string` | [recipe/oauth2provider/types.ts:85](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L85) |
| <a id="loginsessionid"></a> `loginSessionId?` | `string` | [recipe/oauth2provider/types.ts:88](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L88) |
| <a id="oidccontext"></a> `oidcContext?` | `any` | [recipe/oauth2provider/types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L91) |
| <a id="requestedaccesstokenaudience"></a> `requestedAccessTokenAudience?` | `string`[] | [recipe/oauth2provider/types.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L94) |
| <a id="requestedscope"></a> `requestedScope?` | `string`[] | [recipe/oauth2provider/types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L97) |
| <a id="skip"></a> `skip?` | `boolean` | [recipe/oauth2provider/types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L100) |
| <a id="subject"></a> `subject?` | `string` | [recipe/oauth2provider/types.ts:103](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L103) |

***

### CreateOAuth2ClientInput

```ts
type CreateOAuth2ClientInput = Partial<Omit<OAuth2ClientOptions, "createdAt" | "updatedAt">>;
```

Defined in: [recipe/oauth2provider/types.ts:563](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L563)

***

### DeleteOAuth2ClientInput

```ts
type DeleteOAuth2ClientInput = object;
```

Defined in: [recipe/oauth2provider/types.ts:575](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L575)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clientid"></a> `clientId` | `string` | [recipe/oauth2provider/types.ts:576](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L576) |

***

### ErrorOAuth2

```ts
type ErrorOAuth2 = object;
```

Defined in: [recipe/oauth2provider/types.ts:53](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L53)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="error"></a> `error` | `string` | [recipe/oauth2provider/types.ts:58](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L58) |
| <a id="errordescription"></a> `errorDescription` | `string` | [recipe/oauth2provider/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L61) |
| <a id="status"></a> `status` | `"ERROR"` | [recipe/oauth2provider/types.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L54) |
| <a id="statuscode"></a> `statusCode?` | `number` | [recipe/oauth2provider/types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L65) |

***

### GetOAuth2ClientsInput

```ts
type GetOAuth2ClientsInput = object;
```

Defined in: [recipe/oauth2provider/types.ts:546](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L546)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="clientname"></a> `clientName?` | `string` | The name of the clients to filter by. | [recipe/oauth2provider/types.ts:560](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L560) |
| <a id="pagesize"></a> `pageSize?` | `number` | Items per Page. Defaults to 250. | [recipe/oauth2provider/types.ts:550](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L550) |
| <a id="paginationtoken"></a> `paginationToken?` | `string` | Next Page Token. Defaults to "1". | [recipe/oauth2provider/types.ts:555](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L555) |

***

### InstrospectTokenResponse

```ts
type InstrospectTokenResponse = 
  | {
  active: false;
}
  | object & JSONObject;
```

Defined in: [recipe/oauth2provider/types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L176)

***

### LoginInfo

```ts
type LoginInfo = object;
```

Defined in: [recipe/oauth2provider/types.ts:151](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L151)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="clientid-1"></a> `clientId` | `string` | [recipe/oauth2provider/types.ts:152](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L152) |
| <a id="clientname-1"></a> `clientName` | `string` | [recipe/oauth2provider/types.ts:154](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L154) |
| <a id="clienturi"></a> `clientUri?` | `string` | [recipe/oauth2provider/types.ts:162](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L162) |
| <a id="logouri"></a> `logoUri?` | `string` | [recipe/oauth2provider/types.ts:160](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L160) |
| <a id="metadata"></a> `metadata?` | `Record`\<`string`, `any`\> \| `null` | [recipe/oauth2provider/types.ts:164](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L164) |
| <a id="policyuri"></a> `policyUri?` | `string` | [recipe/oauth2provider/types.ts:158](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L158) |
| <a id="tosuri"></a> `tosUri?` | `string` | [recipe/oauth2provider/types.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L156) |

***

### LoginRequest

```ts
type LoginRequest = object;
```

Defined in: [recipe/oauth2provider/types.ts:106](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L106)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="challenge-1"></a> `challenge` | `string` | [recipe/oauth2provider/types.ts:108](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L108) |
| <a id="client-1"></a> `client` | `OAuth2Client` | [recipe/oauth2provider/types.ts:111](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L111) |
| <a id="oidccontext-1"></a> `oidcContext?` | `any` | [recipe/oauth2provider/types.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L114) |
| <a id="requestedaccesstokenaudience-1"></a> `requestedAccessTokenAudience?` | `string`[] | [recipe/oauth2provider/types.ts:120](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L120) |
| <a id="requestedscope-1"></a> `requestedScope?` | `string`[] | [recipe/oauth2provider/types.ts:123](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L123) |
| <a id="requesturl"></a> `requestUrl` | `string` | [recipe/oauth2provider/types.ts:117](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L117) |
| <a id="sessionid"></a> `sessionId?` | `string` | [recipe/oauth2provider/types.ts:126](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L126) |
| <a id="skip-1"></a> `skip` | `boolean` | [recipe/oauth2provider/types.ts:130](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L130) |
| <a id="subject-1"></a> `subject` | `string` | [recipe/oauth2provider/types.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L133) |

***

### OAuth2ClientOptions

```ts
type OAuth2ClientOptions = object;
```

Defined in: [recipe/oauth2provider/types.ts:510](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L510)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="audience"></a> `audience?` | `string`[] | [recipe/oauth2provider/types.ts:534](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L534) |
| <a id="authorizationcodegrantaccesstokenlifespan"></a> `authorizationCodeGrantAccessTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:522](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L522) |
| <a id="authorizationcodegrantidtokenlifespan"></a> `authorizationCodeGrantIdTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:523](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L523) |
| <a id="authorizationcodegrantrefreshtokenlifespan"></a> `authorizationCodeGrantRefreshTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:524](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L524) |
| <a id="clientcredentialsgrantaccesstokenlifespan"></a> `clientCredentialsGrantAccessTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:525](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L525) |
| <a id="clientid-2"></a> `clientId` | `string` | [recipe/oauth2provider/types.ts:511](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L511) |
| <a id="clientname-2"></a> `clientName` | `string` | [recipe/oauth2provider/types.ts:516](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L516) |
| <a id="clientsecret"></a> `clientSecret?` | `string` | [recipe/oauth2provider/types.ts:512](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L512) |
| <a id="clienturi-1"></a> `clientUri?` | `string` | [recipe/oauth2provider/types.ts:538](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L538) |
| <a id="createdat"></a> `createdAt` | `string` | [recipe/oauth2provider/types.ts:513](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L513) |
| <a id="enablerefreshtokenrotation"></a> `enableRefreshTokenRotation?` | `boolean` | [recipe/oauth2provider/types.ts:543](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L543) |
| <a id="granttypes"></a> `grantTypes?` | `string`[] \| `null` | [recipe/oauth2provider/types.ts:535](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L535) |
| <a id="implicitgrantaccesstokenlifespan"></a> `implicitGrantAccessTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:526](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L526) |
| <a id="implicitgrantidtokenlifespan"></a> `implicitGrantIdTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:527](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L527) |
| <a id="logouri-1"></a> `logoUri?` | `string` | [recipe/oauth2provider/types.ts:539](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L539) |
| <a id="metadata-1"></a> `metadata?` | `Record`\<`string`, `any`\> | [recipe/oauth2provider/types.ts:542](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L542) |
| <a id="policyuri-1"></a> `policyUri?` | `string` | [recipe/oauth2provider/types.ts:540](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L540) |
| <a id="postlogoutredirecturis"></a> `postLogoutRedirectUris?` | `string`[] | [recipe/oauth2provider/types.ts:520](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L520) |
| <a id="redirecturis"></a> `redirectUris?` | `string`[] \| `null` | [recipe/oauth2provider/types.ts:519](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L519) |
| <a id="refreshtokengrantaccesstokenlifespan"></a> `refreshTokenGrantAccessTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:528](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L528) |
| <a id="refreshtokengrantidtokenlifespan"></a> `refreshTokenGrantIdTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:529](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L529) |
| <a id="refreshtokengrantrefreshtokenlifespan"></a> `refreshTokenGrantRefreshTokenLifespan?` | `string` \| `null` | [recipe/oauth2provider/types.ts:530](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L530) |
| <a id="responsetypes"></a> `responseTypes?` | `string`[] \| `null` | [recipe/oauth2provider/types.ts:536](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L536) |
| <a id="scope"></a> `scope` | `string` | [recipe/oauth2provider/types.ts:518](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L518) |
| <a id="tokenendpointauthmethod"></a> `tokenEndpointAuthMethod` | `string` | [recipe/oauth2provider/types.ts:532](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L532) |
| <a id="tosuri-1"></a> `tosUri?` | `string` | [recipe/oauth2provider/types.ts:541](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L541) |
| <a id="updatedat"></a> `updatedAt` | `string` | [recipe/oauth2provider/types.ts:514](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L514) |

***

### PayloadBuilderFunction()

```ts
type PayloadBuilderFunction = (user, scopes, sessionHandle, userContext) => Promise<JSONObject>;
```

Defined in: [recipe/oauth2provider/types.ts:579](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L579)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | [`User`](index.mdx#user-1) |
| `scopes` | `string`[] |
| `sessionHandle` | `string` |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<[`JSONObject`](types.mdx#jsonobject)\>

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/oauth2provider/types.ts:178](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L178)

#### Methods

##### acceptConsentRequest()

```ts
acceptConsentRequest(input): Promise<
  | ErrorOAuth2
  | {
  redirectTo: string;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:191](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L191)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `context?`: `any`; `grantAccessTokenAudience?`: `string`[]; `grantScope?`: `string`[]; `handledAt?`: `string`; `initialAccessTokenPayload`: [`JSONObject`](types.mdx#jsonobject) \| `undefined`; `initialIdTokenPayload`: [`JSONObject`](types.mdx#jsonobject) \| `undefined`; `rsub`: `string`; `sessionHandle`: `string`; `tenantId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.context?` | `any` |
| `input.grantAccessTokenAudience?` | `string`[] |
| `input.grantScope?` | `string`[] |
| `input.handledAt?` | `string` |
| `input.initialAccessTokenPayload` | [`JSONObject`](types.mdx#jsonobject) \| `undefined` |
| `input.initialIdTokenPayload` | [`JSONObject`](types.mdx#jsonobject) \| `undefined` |
| `input.rsub` | `string` |
| `input.sessionHandle` | `string` |
| `input.tenantId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `redirectTo`: `string`;
  `status`: `"OK"`;
\}\>

##### acceptLoginRequest()

```ts
acceptLoginRequest(input): Promise<
  | ErrorOAuth2
  | {
  redirectTo: string;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:222](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L222)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `acr?`: `string`; `amr?`: `string`[]; `challenge`: `string`; `context?`: `any`; `extendSessionLifespan?`: `boolean`; `identityProviderSessionId?`: `string`; `subject`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.acr?` | `string` |
| `input.amr?` | `string`[] |
| `input.challenge` | `string` |
| `input.context?` | `any` |
| `input.extendSessionLifespan?` | `boolean` |
| `input.identityProviderSessionId?` | `string` |
| `input.subject` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `redirectTo`: `string`;
  `status`: `"OK"`;
\}\>

##### acceptLogoutRequest()

```ts
acceptLogoutRequest(input): Promise<
  | ErrorOAuth2
  | {
  redirectTo: string;
}>;
```

Defined in: [recipe/oauth2provider/types.ts:412](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L412)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `redirectTo`: `string`;
\}\>

##### authorization()

```ts
authorization(input): Promise<
  | ErrorOAuth2
  | {
  cookies: string[] | undefined;
  redirectTo: string;
}>;
```

Defined in: [recipe/oauth2provider/types.ts:179](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L179)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `cookies`: `string` \| `undefined`; `params`: `Record`\<`string`, `string`\>; `session`: `SessionContainerInterface` \| `undefined`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.cookies` | `string` \| `undefined` |
| `input.params` | `Record`\<`string`, `string`\> |
| `input.session` | `SessionContainerInterface` \| `undefined` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `cookies`: `string`[] \| `undefined`;
  `redirectTo`: `string`;
\}\>

##### buildAccessTokenPayload()

```ts
buildAccessTokenPayload(input): Promise<JSONObject>;
```

Defined in: [recipe/oauth2provider/types.ts:342](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L342)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `client`: `OAuth2Client`; `scopes`: `string`[]; `sessionHandle`: `string` \| `undefined`; `user`: [`User`](index.mdx#user-1) \| `undefined`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.client` | `OAuth2Client` |
| `input.scopes` | `string`[] |
| `input.sessionHandle` | `string` \| `undefined` |
| `input.user` | [`User`](index.mdx#user-1) \| `undefined` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<[`JSONObject`](types.mdx#jsonobject)\>

##### buildIdTokenPayload()

```ts
buildIdTokenPayload(input): Promise<JSONObject>;
```

Defined in: [recipe/oauth2provider/types.ts:349](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L349)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `client`: `OAuth2Client`; `scopes`: `string`[]; `sessionHandle`: `string` \| `undefined`; `user`: [`User`](index.mdx#user-1) \| `undefined`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.client` | `OAuth2Client` |
| `input.scopes` | `string`[] |
| `input.sessionHandle` | `string` \| `undefined` |
| `input.user` | [`User`](index.mdx#user-1) \| `undefined` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<[`JSONObject`](types.mdx#jsonobject)\>

##### buildUserInfo()

```ts
buildUserInfo(input): Promise<JSONObject>;
```

Defined in: [recipe/oauth2provider/types.ts:356](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L356)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `accessTokenPayload`: [`JSONObject`](types.mdx#jsonobject); `scopes`: `string`[]; `tenantId`: `string`; `user`: [`User`](index.mdx#user-1); `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.accessTokenPayload` | [`JSONObject`](types.mdx#jsonobject) |
| `input.scopes` | `string`[] |
| `input.tenantId` | `string` |
| `input.user` | [`User`](index.mdx#user-1) |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<[`JSONObject`](types.mdx#jsonobject)\>

##### createOAuth2Client()

```ts
createOAuth2Client(input): Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:279](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L279)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `Partial`\<`Omit`\<[`OAuth2ClientOptions`](#oauth2clientoptions), `"createdAt"` \| `"updatedAt"`\>\> & `object` |

###### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### deleteOAuth2Client()

```ts
deleteOAuth2Client(input): Promise<
  | {
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:309](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L309)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`DeleteOAuth2ClientInput`](#deleteoauth2clientinput) & `object` |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### endSession()

```ts
endSession(input): Promise<
  | ErrorOAuth2
  | {
  redirectTo: string;
}>;
```

Defined in: [recipe/oauth2provider/types.ts:406](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L406)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `params`: `Record`\<`string`, `string`\>; `session?`: `SessionContainerInterface`; `shouldTryRefresh`: `boolean`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.params` | `Record`\<`string`, `string`\> |
| `input.session?` | `SessionContainerInterface` |
| `input.shouldTryRefresh` | `boolean` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `redirectTo`: `string`;
\}\>

##### getConsentRequest()

```ts
getConsentRequest(input): Promise<ErrorOAuth2 | ConsentRequest>;
```

Defined in: [recipe/oauth2provider/types.ts:190](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L190)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<[`ErrorOAuth2`](#erroroauth2) \| [`ConsentRequest`](#consentrequest)\>

##### getFrontendRedirectionURL()

```ts
getFrontendRedirectionURL(input): Promise<string>;
```

Defined in: [recipe/oauth2provider/types.ts:363](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L363)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \| \{ `forceFreshAuth`: `boolean`; `hint`: `string` \| `undefined`; `loginChallenge`: `string`; `tenantId`: `string`; `type`: `"login"`; `userContext`: [`UserContext`](types.mdx#usercontext); \} \| \{ `loginChallenge`: `string`; `type`: `"try-refresh"`; `userContext`: [`UserContext`](types.mdx#usercontext); \} \| \{ `logoutChallenge`: `string`; `type`: `"logout-confirmation"`; `userContext`: [`UserContext`](types.mdx#usercontext); \} \| \{ `type`: `"post-logout-fallback"`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |

###### Returns

`Promise`\<`string`\>

##### getLoginRequest()

```ts
getLoginRequest(input): Promise<
  | ErrorOAuth2
| LoginRequest & object>;
```

Defined in: [recipe/oauth2provider/types.ts:218](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L218)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| [`LoginRequest`](#loginrequest) & `object`\>

##### getOAuth2Client()

```ts
getOAuth2Client(input): Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:252](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L252)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `clientId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.clientId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### getOAuth2Clients()

```ts
getOAuth2Clients(input): Promise<
  | {
  clients: OAuth2Client[];
  nextPaginationToken?: string;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:263](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L263)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`GetOAuth2ClientsInput`](#getoauth2clientsinput) & `object` |

###### Returns

`Promise`\<
  \| \{
  `clients`: `OAuth2Client`[];
  `nextPaginationToken?`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### getRequestedScopes()

```ts
getRequestedScopes(input): Promise<string[]>;
```

Defined in: [recipe/oauth2provider/types.ts:335](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L335)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `clientId`: `string`; `recipeUserId`: [`RecipeUserId`](index.mdx#recipeuserid-1) \| `undefined`; `scopeParam`: `string`[]; `sessionHandle`: `string` \| `undefined`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.clientId` | `string` |
| `input.recipeUserId` | [`RecipeUserId`](index.mdx#recipeuserid-1) \| `undefined` |
| `input.scopeParam` | `string`[] |
| `input.sessionHandle` | `string` \| `undefined` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<`string`[]\>

##### introspectToken()

```ts
introspectToken(input): Promise<
  | InstrospectTokenResponse & { status: "OK"; }
| ErrorOAuth2>;
```

Defined in: [recipe/oauth2provider/types.ts:401](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L401)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `scopes?`: `string`[]; `token`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.scopes?` | `string`[] |
| `input.token` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| InstrospectTokenResponse & \{ status: "OK"; \}
  \| [`ErrorOAuth2`](#erroroauth2)\>

##### rejectConsentRequest()

```ts
rejectConsentRequest(input): Promise<
  | ErrorOAuth2
  | {
  redirectTo: string;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:212](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L212)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `error`: [`ErrorOAuth2`](#erroroauth2); `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.error` | [`ErrorOAuth2`](#erroroauth2) |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `redirectTo`: `string`;
  `status`: `"OK"`;
\}\>

##### rejectLoginRequest()

```ts
rejectLoginRequest(input): Promise<
  | ErrorOAuth2
  | {
  redirectTo: string;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:246](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L246)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `error`: [`ErrorOAuth2`](#erroroauth2); `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.error` | [`ErrorOAuth2`](#erroroauth2) |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `redirectTo`: `string`;
  `status`: `"OK"`;
\}\>

##### rejectLogoutRequest()

```ts
rejectLogoutRequest(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:416](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L416)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `challenge`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.challenge` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### revokeToken()

```ts
revokeToken(input): Promise<
  | ErrorOAuth2
  | {
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:388](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L388)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | `object` & \| \{ `authorizationHeader`: `string`; \} \| \{ `clientId`: `string`; `clientSecret?`: `string`; \} |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](#erroroauth2)
  \| \{
  `status`: `"OK"`;
\}\>

##### revokeTokensByClientId()

```ts
revokeTokensByClientId(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:399](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L399)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `clientId`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.clientId` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### revokeTokensBySessionHandle()

```ts
revokeTokensBySessionHandle(input): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:400](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L400)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `sessionHandle`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.sessionHandle` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### tokenExchange()

```ts
tokenExchange(input): Promise<ErrorOAuth2 | TokenInfo>;
```

Defined in: [recipe/oauth2provider/types.ts:185](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L185)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `authorizationHeader?`: `string`; `body`: `Record`\<`string`, `string` \| `undefined`\>; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.authorizationHeader?` | `string` |
| `input.body` | `Record`\<`string`, `string` \| `undefined`\> |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<[`ErrorOAuth2`](#erroroauth2) \| [`TokenInfo`](#tokeninfo)\>

##### updateOAuth2Client()

```ts
updateOAuth2Client(input): Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:294](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L294)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`NonNullableProperties`](types.mdx#nonnullableproperties)\<`Omit`\<`Partial`\<`Omit`\<[`OAuth2ClientOptions`](#oauth2clientoptions), `"createdAt"` \| `"updatedAt"`\>\>, `"redirectUris"` \| `"grantTypes"` \| `"responseTypes"` \| `"metadata"`\>\> & `object` & `object` |

###### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### validateOAuth2AccessToken()

```ts
validateOAuth2AccessToken(input): Promise<{
  payload: JSONObject;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/types.ts:324](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L324)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `checkDatabase?`: `boolean`; `requirements?`: \{ `audience?`: `string`; `clientId?`: `string`; `scopes?`: `string`[]; \}; `token`: `string`; `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.checkDatabase?` | `boolean` |
| `input.requirements?` | \{ `audience?`: `string`; `clientId?`: `string`; `scopes?`: `string`[]; \} |
| `input.requirements.audience?` | `string` |
| `input.requirements.clientId?` | `string` |
| `input.requirements.scopes?` | `string`[] |
| `input.token` | `string` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `payload`: [`JSONObject`](types.mdx#jsonobject);
  `status`: `"OK"`;
\}\>

***

### TokenInfo

```ts
type TokenInfo = object;
```

Defined in: [recipe/oauth2provider/types.ts:136](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L136)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="access_token"></a> `access_token?` | `string` | [recipe/oauth2provider/types.ts:138](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L138) |
| <a id="expires_in"></a> `expires_in` | `number` | [recipe/oauth2provider/types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L140) |
| <a id="id_token"></a> `id_token?` | `string` | [recipe/oauth2provider/types.ts:142](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L142) |
| <a id="refresh_token"></a> `refresh_token?` | `string` | [recipe/oauth2provider/types.ts:144](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L144) |
| <a id="scope-1"></a> `scope` | `string` | [recipe/oauth2provider/types.ts:146](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L146) |
| <a id="token_type"></a> `token_type` | `string` | [recipe/oauth2provider/types.ts:148](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L148) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/oauth2provider/types.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L24)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override"></a> `override?` | `object` | [recipe/oauth2provider/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L25) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/oauth2provider/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L30) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/oauth2provider/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L26) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/oauth2provider/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L34)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override` | `object` | [recipe/oauth2provider/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L35) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/oauth2provider/types.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L40) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/oauth2provider/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L36) |

***

### UpdateOAuth2ClientInput

```ts
type UpdateOAuth2ClientInput = NonNullableProperties<Omit<CreateOAuth2ClientInput, "redirectUris" | "grantTypes" | "responseTypes" | "metadata">> & object;
```

Defined in: [recipe/oauth2provider/types.ts:565](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L565)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `clientId` | `string` | [recipe/oauth2provider/types.ts:568](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L568) |
| `grantTypes?` | `string`[] \| `null` | [recipe/oauth2provider/types.ts:570](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L570) |
| `metadata?` | `Record`\<`string`, `any`\> \| `null` | [recipe/oauth2provider/types.ts:572](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L572) |
| `redirectUris?` | `string`[] \| `null` | [recipe/oauth2provider/types.ts:569](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L569) |
| `responseTypes?` | `string`[] \| `null` | [recipe/oauth2provider/types.ts:571](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L571) |

***

### UserInfo

```ts
type UserInfo = object;
```

Defined in: [recipe/oauth2provider/types.ts:167](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L167)

#### Indexable

```ts
[key: string]: JSONValue
```

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="email"></a> `email?` | `string` | [recipe/oauth2provider/types.ts:169](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L169) |
| <a id="email_verified"></a> `email_verified?` | `boolean` | [recipe/oauth2provider/types.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L170) |
| <a id="phonenumber"></a> `phoneNumber?` | `string` | [recipe/oauth2provider/types.ts:171](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L171) |
| <a id="phonenumber_verified"></a> `phoneNumber_verified?` | `boolean` | [recipe/oauth2provider/types.ts:172](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L172) |
| <a id="sub"></a> `sub` | `string` | [recipe/oauth2provider/types.ts:168](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L168) |

***

### UserInfoBuilderFunction()

```ts
type UserInfoBuilderFunction = (user, accessTokenPayload, scopes, tenantId, userContext) => Promise<JSONObject>;
```

Defined in: [recipe/oauth2provider/types.ts:585](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/types.ts#L585)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `user` | [`User`](index.mdx#user-1) |
| `accessTokenPayload` | [`JSONObject`](types.mdx#jsonobject) |
| `scopes` | `string`[] |
| `tenantId` | `string` |
| `userContext` | [`UserContext`](types.mdx#usercontext) |

#### Returns

`Promise`\<[`JSONObject`](types.mdx#jsonobject)\>

# References - Backend SDKs - Node.js SDK Reference -  OAuth Provider
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-oauth2provider

## Classes

### default

Defined in: [recipe/oauth2provider/index.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L28)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/oauth2provider/index.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L29) |

#### Methods

##### createOAuth2Client()

```ts
static createOAuth2Client(input, userContext?): Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L43)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`CreateOAuth2ClientInput`](recipe-oauth2provider-types.mdx#createoauth2clientinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### createTokenForClientCredentials()

```ts
static createTokenForClientCredentials(
   clientId, 
   clientSecret, 
   scope?, 
   audience?, 
   userContext?): Promise<
  | ErrorOAuth2
| TokenInfo>;
```

Defined in: [recipe/oauth2provider/index.ts:80](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L80)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `clientId` | `string` |
| `clientSecret` | `string` |
| `scope?` | `string`[] |
| `audience?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](recipe-oauth2provider-types.mdx#erroroauth2)
  \| [`TokenInfo`](recipe-oauth2provider-types.mdx#tokeninfo)\>

##### deleteOAuth2Client()

```ts
static deleteOAuth2Client(input, userContext?): Promise<
  | {
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L55)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`DeleteOAuth2ClientInput`](recipe-oauth2provider-types.mdx#deleteoauth2clientinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### getOAuth2Client()

```ts
static getOAuth2Client(clientId, userContext?): Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `clientId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### getOAuth2Clients()

```ts
static getOAuth2Clients(input, userContext?): Promise<
  | {
  clients: OAuth2Client[];
  nextPaginationToken?: string;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L37)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`GetOAuth2ClientsInput`](recipe-oauth2provider-types.mdx#getoauth2clientsinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `clients`: `OAuth2Client`[];
  `nextPaginationToken?`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### revokeToken()

```ts
static revokeToken(
   token, 
   clientId, 
   clientSecret?, 
   userContext?): Promise<
  | ErrorOAuth2
  | {
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:99](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L99)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `clientId` | `string` |
| `clientSecret?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| [`ErrorOAuth2`](recipe-oauth2provider-types.mdx#erroroauth2)
  \| \{
  `status`: `"OK"`;
\}\>

##### revokeTokensByClientId()

```ts
static revokeTokensByClientId(clientId, userContext?): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L140)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `clientId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### revokeTokensBySessionHandle()

```ts
static revokeTokensBySessionHandle(sessionHandle, userContext?): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:147](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L147)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `sessionHandle` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### updateOAuth2Client()

```ts
static updateOAuth2Client(input, userContext?): Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L49)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`UpdateOAuth2ClientInput`](recipe-oauth2provider-types.mdx#updateoauth2clientinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

##### validateOAuth2AccessToken()

```ts
static validateOAuth2AccessToken(
   token, 
   requirements?, 
   checkDatabase?, 
   userContext?): Promise<{
  payload: JSONObject;
  status: "OK";
}>;
```

Defined in: [recipe/oauth2provider/index.ts:62](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L62)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `requirements?` | \{ `audience?`: `string`; `clientId?`: `string`; `scopes?`: `string`[]; \} |
| `requirements.audience?` | `string` |
| `requirements.clientId?` | `string` |
| `requirements.scopes?` | `string`[] |
| `checkDatabase?` | `boolean` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `payload`: [`JSONObject`](types.mdx#jsonobject);
  `status`: `"OK"`;
\}\>

##### validateOAuth2RefreshToken()

```ts
static validateOAuth2RefreshToken(
   token, 
   scopes?, 
   userContext?): Promise<
  | InstrospectTokenResponse & { status: "OK"; }
| ErrorOAuth2>;
```

Defined in: [recipe/oauth2provider/index.ts:154](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L154)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `scopes?` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| InstrospectTokenResponse & \{ status: "OK"; \}
  \| [`ErrorOAuth2`](recipe-oauth2provider-types.mdx#erroroauth2)\>

## Variables

### createOAuth2Client()

```ts
createOAuth2Client: (input, userContext?) => Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}> = Wrapper.createOAuth2Client;
```

Defined in: [recipe/oauth2provider/index.ts:168](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L168)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`CreateOAuth2ClientInput`](recipe-oauth2provider-types.mdx#createoauth2clientinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

***

### createTokenForClientCredentials()

```ts
createTokenForClientCredentials: (clientId, clientSecret, scope?, audience?, userContext?) => Promise<
  | ErrorOAuth2
  | TokenInfo> = Wrapper.createTokenForClientCredentials;
```

Defined in: [recipe/oauth2provider/index.ts:177](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L177)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `clientId` | `string` |
| `clientSecret` | `string` |
| `scope?` | `string`[] |
| `audience?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| [`ErrorOAuth2`](recipe-oauth2provider-types.mdx#erroroauth2)
  \| [`TokenInfo`](recipe-oauth2provider-types.mdx#tokeninfo)\>

***

### deleteOAuth2Client()

```ts
deleteOAuth2Client: (input, userContext?) => Promise<
  | {
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}> = Wrapper.deleteOAuth2Client;
```

Defined in: [recipe/oauth2provider/index.ts:172](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L172)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`DeleteOAuth2ClientInput`](recipe-oauth2provider-types.mdx#deleteoauth2clientinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

***

### getOAuth2Client()

```ts
getOAuth2Client: (clientId, userContext?) => Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}> = Wrapper.getOAuth2Client;
```

Defined in: [recipe/oauth2provider/index.ts:165](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L165)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `clientId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

***

### getOAuth2Clients()

```ts
getOAuth2Clients: (input, userContext?) => Promise<
  | {
  clients: OAuth2Client[];
  nextPaginationToken?: string;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}> = Wrapper.getOAuth2Clients;
```

Defined in: [recipe/oauth2provider/index.ts:166](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L166)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`GetOAuth2ClientsInput`](recipe-oauth2provider-types.mdx#getoauth2clientsinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `clients`: `OAuth2Client`[];
  `nextPaginationToken?`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/oauth2provider/index.ts:163](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L163)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-oauth2provider-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### revokeToken()

```ts
revokeToken: (token, clientId, clientSecret?, userContext?) => Promise<
  | ErrorOAuth2
  | {
  status: "OK";
}> = Wrapper.revokeToken;
```

Defined in: [recipe/oauth2provider/index.ts:179](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L179)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `clientId` | `string` |
| `clientSecret?` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| [`ErrorOAuth2`](recipe-oauth2provider-types.mdx#erroroauth2)
  \| \{
  `status`: `"OK"`;
\}\>

***

### revokeTokensByClientId()

```ts
revokeTokensByClientId: (clientId, userContext?) => Promise<{
  status: "OK";
}> = Wrapper.revokeTokensByClientId;
```

Defined in: [recipe/oauth2provider/index.ts:180](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L180)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `clientId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### revokeTokensBySessionHandle()

```ts
revokeTokensBySessionHandle: (sessionHandle, userContext?) => Promise<{
  status: "OK";
}> = Wrapper.revokeTokensBySessionHandle;
```

Defined in: [recipe/oauth2provider/index.ts:181](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L181)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `sessionHandle` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### updateOAuth2Client()

```ts
updateOAuth2Client: (input, userContext?) => Promise<
  | {
  client: OAuth2Client;
  status: "OK";
}
  | {
  error: string;
  errorDescription: string;
  status: "ERROR";
}> = Wrapper.updateOAuth2Client;
```

Defined in: [recipe/oauth2provider/index.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L170)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | [`UpdateOAuth2ClientInput`](recipe-oauth2provider-types.mdx#updateoauth2clientinput) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `client`: `OAuth2Client`;
  `status`: `"OK"`;
\}
  \| \{
  `error`: `string`;
  `errorDescription`: `string`;
  `status`: `"ERROR"`;
\}\>

***

### validateOAuth2AccessToken()

```ts
validateOAuth2AccessToken: (token, requirements?, checkDatabase?, userContext?) => Promise<{
  payload: JSONObject;
  status: "OK";
}> = Wrapper.validateOAuth2AccessToken;
```

Defined in: [recipe/oauth2provider/index.ts:174](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L174)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `requirements?` | \{ `audience?`: `string`; `clientId?`: `string`; `scopes?`: `string`[]; \} |
| `requirements.audience?` | `string` |
| `requirements.clientId?` | `string` |
| `requirements.scopes?` | `string`[] |
| `checkDatabase?` | `boolean` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `payload`: [`JSONObject`](types.mdx#jsonobject);
  `status`: `"OK"`;
\}\>

***

### validateOAuth2RefreshToken()

```ts
validateOAuth2RefreshToken: (token, scopes?, userContext?) => Promise<
  | InstrospectTokenResponse & { status: "OK"; }
  | ErrorOAuth2> = Wrapper.validateOAuth2RefreshToken;
```

Defined in: [recipe/oauth2provider/index.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/oauth2provider/index.ts#L175)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |
| `scopes?` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| InstrospectTokenResponse & \{ status: "OK"; \}
  \| [`ErrorOAuth2`](recipe-oauth2provider-types.mdx#erroroauth2)\>

## References

### APIInterface

Re-exports [APIInterface](recipe-oauth2provider-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-oauth2provider-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-oauth2provider-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  OpenID Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-openid-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/openid/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L47)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getopeniddiscoveryconfigurationget"></a> `getOpenIdDiscoveryConfigurationGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `authorization_endpoint`: `string`; `end_session_endpoint`: `string`; `id_token_signing_alg_values_supported`: `string`[]; `issuer`: `string`; `jwks_uri`: `string`; `response_types_supported`: `string`[]; `revocation_endpoint`: `string`; `status`: `"OK"`; `subject_types_supported`: `string`[]; `token_endpoint`: `string`; `token_introspection_endpoint`: `string`; `userinfo_endpoint`: `string`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/openid/types.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L48) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/openid/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L39)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/openid/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L41) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/openid/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L42) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/openid/types.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L40) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/openid/types.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L43) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/openid/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L44) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/openid/types.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L69)

#### Methods

##### createJWT()

```ts
createJWT(input): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;
```

Defined in: [recipe/openid/types.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L84)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `payload?`: `any`; `userContext`: [`UserContext`](types.mdx#usercontext); `useStaticSigningKey?`: `boolean`; `validitySeconds?`: `number`; \} |
| `input.payload?` | `any` |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |
| `input.useStaticSigningKey?` | `boolean` |
| `input.validitySeconds?` | `number` |

###### Returns

`Promise`\<
  \| \{
  `jwt`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNSUPPORTED_ALGORITHM_ERROR"`;
\}\>

##### getOpenIdDiscoveryConfiguration()

```ts
getOpenIdDiscoveryConfiguration(input): Promise<{
  authorization_endpoint: string;
  end_session_endpoint: string;
  id_token_signing_alg_values_supported: string[];
  issuer: string;
  jwks_uri: string;
  response_types_supported: string[];
  revocation_endpoint: string;
  status: "OK";
  subject_types_supported: string[];
  token_endpoint: string;
  token_introspection_endpoint: string;
  userinfo_endpoint: string;
}>;
```

Defined in: [recipe/openid/types.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L70)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: [`UserContext`](types.mdx#usercontext); \} |
| `input.userContext` | [`UserContext`](types.mdx#usercontext) |

###### Returns

`Promise`\<\{
  `authorization_endpoint`: `string`;
  `end_session_endpoint`: `string`;
  `id_token_signing_alg_values_supported`: `string`[];
  `issuer`: `string`;
  `jwks_uri`: `string`;
  `response_types_supported`: `string`[];
  `revocation_endpoint`: `string`;
  `status`: `"OK"`;
  `subject_types_supported`: `string`[];
  `token_endpoint`: `string`;
  `token_introspection_endpoint`: `string`;
  `userinfo_endpoint`: `string`;
\}\>

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/openid/types.ts:19](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L19)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override"></a> `override?` | `object` | [recipe/openid/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L20) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/openid/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L25) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/openid/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L21) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/openid/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override` | `object` | [recipe/openid/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L30) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/openid/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L35) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/openid/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L31) |

# References - Backend SDKs - Node.js SDK Reference -  OpenID
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-openid

## Classes

### default

Defined in: [recipe/openid/index.ts:4](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L4)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `OpenIdRecipe.init` | [recipe/openid/index.ts:5](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L5) |

#### Methods

##### getOpenIdDiscoveryConfiguration()

```ts
static getOpenIdDiscoveryConfiguration(userContext?): Promise<{
  authorization_endpoint: string;
  end_session_endpoint: string;
  id_token_signing_alg_values_supported: string[];
  issuer: string;
  jwks_uri: string;
  response_types_supported: string[];
  revocation_endpoint: string;
  status: "OK";
  subject_types_supported: string[];
  token_endpoint: string;
  token_introspection_endpoint: string;
  userinfo_endpoint: string;
}>;
```

Defined in: [recipe/openid/index.ts:7](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L7)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `authorization_endpoint`: `string`;
  `end_session_endpoint`: `string`;
  `id_token_signing_alg_values_supported`: `string`[];
  `issuer`: `string`;
  `jwks_uri`: `string`;
  `response_types_supported`: `string`[];
  `revocation_endpoint`: `string`;
  `status`: `"OK"`;
  `subject_types_supported`: `string`[];
  `token_endpoint`: `string`;
  `token_introspection_endpoint`: `string`;
  `userinfo_endpoint`: `string`;
\}\>

## Variables

### getOpenIdDiscoveryConfiguration()

```ts
getOpenIdDiscoveryConfiguration: (userContext?) => Promise<{
  authorization_endpoint: string;
  end_session_endpoint: string;
  id_token_signing_alg_values_supported: string[];
  issuer: string;
  jwks_uri: string;
  response_types_supported: string[];
  revocation_endpoint: string;
  status: "OK";
  subject_types_supported: string[];
  token_endpoint: string;
  token_introspection_endpoint: string;
  userinfo_endpoint: string;
}> = OpenIdRecipeWrapper.getOpenIdDiscoveryConfiguration;
```

Defined in: [recipe/openid/index.ts:15](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L15)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `authorization_endpoint`: `string`;
  `end_session_endpoint`: `string`;
  `id_token_signing_alg_values_supported`: `string`[];
  `issuer`: `string`;
  `jwks_uri`: `string`;
  `response_types_supported`: `string`[];
  `revocation_endpoint`: `string`;
  `status`: `"OK"`;
  `subject_types_supported`: `string`[];
  `token_endpoint`: `string`;
  `token_introspection_endpoint`: `string`;
  `userinfo_endpoint`: `string`;
\}\>

***

### init()

```ts
init: (config?) => RecipeListFunction = OpenIdRecipeWrapper.init;
```

Defined in: [recipe/openid/index.ts:14](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L14)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-openid-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

# References - Backend SDKs - Node.js SDK Reference -  UserRoles Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-userroles-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/userroles/types.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L43)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/userroles/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L45)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="addroletouser"></a> `addRoleToUser` | (`input`) => `Promise`\< \| \{ `didUserAlreadyHaveRole`: `boolean`; `status`: `"OK"`; \} \| \{ `status`: `"UNKNOWN_ROLE_ERROR"`; \}\> | [recipe/userroles/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L46) |
| <a id="createnewroleoraddpermissions"></a> `createNewRoleOrAddPermissions` | (`input`) => `Promise`\<\{ `createdNewRole`: `boolean`; `status`: `"OK"`; \}\> | [recipe/userroles/types.ts:81](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L81) |
| <a id="deleterole"></a> `deleteRole` | (`input`) => `Promise`\<\{ `didRoleExist`: `boolean`; `status`: `"OK"`; \}\> | [recipe/userroles/types.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L109) |
| <a id="getallroles"></a> `getAllRoles` | (`input`) => `Promise`\<\{ `roles`: `string`[]; `status`: `"OK"`; \}\> | [recipe/userroles/types.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L114) |
| <a id="getpermissionsforrole"></a> `getPermissionsForRole` | (`input`) => `Promise`\< \| \{ `permissions`: `string`[]; `status`: `"OK"`; \} \| \{ `status`: `"UNKNOWN_ROLE_ERROR"`; \}\> | [recipe/userroles/types.ts:90](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L90) |
| <a id="getrolesforuser"></a> `getRolesForUser` | (`input`) => `Promise`\<\{ `roles`: `string`[]; `status`: `"OK"`; \}\> | [recipe/userroles/types.ts:66](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L66) |
| <a id="getrolesthathavepermission"></a> `getRolesThatHavePermission` | (`input`) => `Promise`\<\{ `roles`: `string`[]; `status`: `"OK"`; \}\> | [recipe/userroles/types.ts:104](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L104) |
| <a id="getusersthathaverole"></a> `getUsersThatHaveRole` | (`input`) => `Promise`\< \| \{ `status`: `"OK"`; `users`: `string`[]; \} \| \{ `status`: `"UNKNOWN_ROLE_ERROR"`; \}\> | [recipe/userroles/types.ts:71](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L71) |
| <a id="removepermissionsfromrole"></a> `removePermissionsFromRole` | (`input`) => `Promise`\<\{ `status`: `"OK"` \| `"UNKNOWN_ROLE_ERROR"`; \}\> | [recipe/userroles/types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L100) |
| <a id="removeuserrole"></a> `removeUserRole` | (`input`) => `Promise`\< \| \{ `didUserHaveRole`: `boolean`; `status`: `"OK"`; \} \| \{ `status`: `"UNKNOWN_ROLE_ERROR"`; \}\> | [recipe/userroles/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L56) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/userroles/types.ts:19](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L19)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override"></a> `override?` | `object` | [recipe/userroles/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L22) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/userroles/types.ts:27](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L27) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/userroles/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L23) |
| <a id="skipaddingpermissionstoaccesstoken"></a> `skipAddingPermissionsToAccessToken?` | `boolean` | [recipe/userroles/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L21) |
| <a id="skipaddingrolestoaccesstoken"></a> `skipAddingRolesToAccessToken?` | `boolean` | [recipe/userroles/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L20) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/userroles/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L31)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override` | `object` | [recipe/userroles/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L34) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/userroles/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L39) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/userroles/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L35) |
| <a id="skipaddingpermissionstoaccesstoken-1"></a> `skipAddingPermissionsToAccessToken` | `boolean` | [recipe/userroles/types.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L33) |
| <a id="skipaddingrolestoaccesstoken-1"></a> `skipAddingRolesToAccessToken` | `boolean` | [recipe/userroles/types.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/types.ts#L32) |

# References - Backend SDKs - Node.js SDK Reference -  UserRoles
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-userroles

## Classes

### default

Defined in: [recipe/userroles/index.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L22)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/userroles/index.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L23) |
| <a id="permissionclaim"></a> `PermissionClaim` | `static` | `PermissionClaimClass` | `PermissionClaim` | [recipe/userroles/index.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L24) |
| <a id="userroleclaim"></a> `UserRoleClaim` | `static` | `UserRoleClaimClass` | `UserRoleClaim` | [recipe/userroles/index.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L25) |

#### Methods

##### addRoleToUser()

```ts
static addRoleToUser(
   tenantId, 
   userId, 
   role, 
   userContext?): Promise<
  | {
  didUserAlreadyHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;
```

Defined in: [recipe/userroles/index.ts:27](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L27)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `didUserAlreadyHaveRole`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

##### createNewRoleOrAddPermissions()

```ts
static createNewRoleOrAddPermissions(
   role, 
   permissions, 
   userContext?): Promise<{
  createdNewRole: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/userroles/index.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L61)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `permissions` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `createdNewRole`: `boolean`;
  `status`: `"OK"`;
\}\>

##### deleteRole()

```ts
static deleteRole(role, userContext?): Promise<{
  didRoleExist: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/userroles/index.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L91)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `didRoleExist`: `boolean`;
  `status`: `"OK"`;
\}\>

##### getAllRoles()

```ts
static getAllRoles(userContext?): Promise<{
  roles: string[];
  status: "OK";
}>;
```

Defined in: [recipe/userroles/index.ts:98](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L98)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `roles`: `string`[];
  `status`: `"OK"`;
\}\>

##### getPermissionsForRole()

```ts
static getPermissionsForRole(role, userContext?): Promise<
  | {
  permissions: string[];
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;
```

Defined in: [recipe/userroles/index.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L69)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `permissions`: `string`[];
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

##### getRolesForUser()

```ts
static getRolesForUser(
   tenantId, 
   userId, 
   userContext?): Promise<{
  roles: string[];
  status: "OK";
}>;
```

Defined in: [recipe/userroles/index.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L45)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `roles`: `string`[];
  `status`: `"OK"`;
\}\>

##### getRolesThatHavePermission()

```ts
static getRolesThatHavePermission(permission, userContext?): Promise<{
  roles: string[];
  status: "OK";
}>;
```

Defined in: [recipe/userroles/index.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L84)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `permission` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `roles`: `string`[];
  `status`: `"OK"`;
\}\>

##### getUsersThatHaveRole()

```ts
static getUsersThatHaveRole(
   tenantId, 
   role, 
   userContext?): Promise<
  | {
  status: "OK";
  users: string[];
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;
```

Defined in: [recipe/userroles/index.ts:53](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L53)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `users`: `string`[];
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

##### removePermissionsFromRole()

```ts
static removePermissionsFromRole(
   role, 
   permissions, 
   userContext?): Promise<{
  status: "OK" | "UNKNOWN_ROLE_ERROR";
}>;
```

Defined in: [recipe/userroles/index.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L76)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `permissions` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"UNKNOWN_ROLE_ERROR"`;
\}\>

##### removeUserRole()

```ts
static removeUserRole(
   tenantId, 
   userId, 
   role, 
   userContext?): Promise<
  | {
  didUserHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;
```

Defined in: [recipe/userroles/index.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L36)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `didUserHaveRole`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

## Variables

### addRoleToUser()

```ts
const addRoleToUser: (tenantId, userId, role, userContext?) => Promise<
  | {
  didUserAlreadyHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.addRoleToUser;
```

Defined in: [recipe/userroles/index.ts:106](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L106)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `didUserAlreadyHaveRole`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

***

### createNewRoleOrAddPermissions()

```ts
const createNewRoleOrAddPermissions: (role, permissions, userContext?) => Promise<{
  createdNewRole: boolean;
  status: "OK";
}> = Wrapper.createNewRoleOrAddPermissions;
```

Defined in: [recipe/userroles/index.ts:110](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L110)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `permissions` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `createdNewRole`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### deleteRole()

```ts
const deleteRole: (role, userContext?) => Promise<{
  didRoleExist: boolean;
  status: "OK";
}> = Wrapper.deleteRole;
```

Defined in: [recipe/userroles/index.ts:114](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L114)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `didRoleExist`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### getAllRoles()

```ts
const getAllRoles: (userContext?) => Promise<{
  roles: string[];
  status: "OK";
}> = Wrapper.getAllRoles;
```

Defined in: [recipe/userroles/index.ts:115](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L115)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `roles`: `string`[];
  `status`: `"OK"`;
\}\>

***

### getPermissionsForRole()

```ts
const getPermissionsForRole: (role, userContext?) => Promise<
  | {
  permissions: string[];
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.getPermissionsForRole;
```

Defined in: [recipe/userroles/index.ts:111](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L111)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `permissions`: `string`[];
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

***

### getRolesForUser()

```ts
const getRolesForUser: (tenantId, userId, userContext?) => Promise<{
  roles: string[];
  status: "OK";
}> = Wrapper.getRolesForUser;
```

Defined in: [recipe/userroles/index.ts:108](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L108)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `roles`: `string`[];
  `status`: `"OK"`;
\}\>

***

### getRolesThatHavePermission()

```ts
const getRolesThatHavePermission: (permission, userContext?) => Promise<{
  roles: string[];
  status: "OK";
}> = Wrapper.getRolesThatHavePermission;
```

Defined in: [recipe/userroles/index.ts:113](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L113)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `permission` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `roles`: `string`[];
  `status`: `"OK"`;
\}\>

***

### getUsersThatHaveRole()

```ts
const getUsersThatHaveRole: (tenantId, role, userContext?) => Promise<
  | {
  status: "OK";
  users: string[];
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.getUsersThatHaveRole;
```

Defined in: [recipe/userroles/index.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L109)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `users`: `string`[];
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

***

### init()

```ts
const init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/userroles/index.ts:105](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L105)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-userroles-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### PermissionClaim

```ts
const PermissionClaim: PermissionClaimClass;
```

Defined in: [recipe/userroles/permissionClaim.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/permissionClaim.ts#L41)

***

### removePermissionsFromRole()

```ts
const removePermissionsFromRole: (role, permissions, userContext?) => Promise<{
  status: "OK" | "UNKNOWN_ROLE_ERROR";
}> = Wrapper.removePermissionsFromRole;
```

Defined in: [recipe/userroles/index.ts:112](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L112)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `role` | `string` |
| `permissions` | `string`[] |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"UNKNOWN_ROLE_ERROR"`;
\}\>

***

### removeUserRole()

```ts
const removeUserRole: (tenantId, userId, role, userContext?) => Promise<
  | {
  didUserHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.removeUserRole;
```

Defined in: [recipe/userroles/index.ts:107](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/index.ts#L107)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `role` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `didUserHaveRole`: `boolean`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"UNKNOWN_ROLE_ERROR"`;
\}\>

***

### UserRoleClaim

```ts
const UserRoleClaim: UserRoleClaimClass;
```

Defined in: [recipe/userroles/userRoleClaim.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/userroles/userRoleClaim.ts#L24)

## References

### RecipeInterface

Re-exports [RecipeInterface](recipe-userroles-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  UserMetadata Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-usermetadata-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/usermetadata/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L39)

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/usermetadata/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L41)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="clearusermetadata"></a> `clearUserMetadata` | (`input`) => `Promise`\<\{ `status`: `"OK"`; \}\> | - | [recipe/usermetadata/types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L60) |
| <a id="getusermetadata"></a> `getUserMetadata` | (`input`) => `Promise`\<\{ `metadata`: `any`; `status`: `"OK"`; \}\> | - | [recipe/usermetadata/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L42) |
| <a id="updateusermetadata"></a> `updateUserMetadata` | (`input`) => `Promise`\<\{ `metadata`: [`JSONObject`](types.mdx#jsonobject); `status`: `"OK"`; \}\> | Updates the metadata object of the user by doing a shallow merge of the stored and the update JSONs and removing properties set to null on the root level of the update object. e.g.: - stored: `{ "preferences": { "theme":"dark" }, "notifications": { "email": true }, "todos": ["example"] }` - update: `{ "notifications": { "sms": true }, "todos": null }` - result: `{ "preferences": { "theme":"dark" }, "notifications": { "sms": true } }` | [recipe/usermetadata/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L55) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/usermetadata/types.ts:19](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L19)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override"></a> `override?` | `object` | [recipe/usermetadata/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L20) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/usermetadata/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L25) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/usermetadata/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L21) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/usermetadata/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override` | `object` | [recipe/usermetadata/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L30) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/usermetadata/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L35) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/usermetadata/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L31) |

# References - Backend SDKs - Node.js SDK Reference -  UserMetadata
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-usermetadata

## Classes

### default

Defined in: [recipe/usermetadata/index.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L21)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/usermetadata/index.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L22) |

#### Methods

##### clearUserMetadata()

```ts
static clearUserMetadata(userId, userContext?): Promise<{
  status: "OK";
}>;
```

Defined in: [recipe/usermetadata/index.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L39)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### getUserMetadata()

```ts
static getUserMetadata(userId, userContext?): Promise<{
  metadata: any;
  status: "OK";
}>;
```

Defined in: [recipe/usermetadata/index.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L24)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `metadata`: `any`;
  `status`: `"OK"`;
\}\>

##### updateUserMetadata()

```ts
static updateUserMetadata(
   userId, 
   metadataUpdate, 
   userContext?): Promise<{
  metadata: JSONObject;
  status: "OK";
}>;
```

Defined in: [recipe/usermetadata/index.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `metadataUpdate` | [`JSONObject`](types.mdx#jsonobject) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `metadata`: [`JSONObject`](types.mdx#jsonobject);
  `status`: `"OK"`;
\}\>

## Variables

### clearUserMetadata()

```ts
const clearUserMetadata: (userId, userContext?) => Promise<{
  status: "OK";
}> = Wrapper.clearUserMetadata;
```

Defined in: [recipe/usermetadata/index.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L50)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### getUserMetadata()

```ts
const getUserMetadata: (userId, userContext?) => Promise<{
  metadata: any;
  status: "OK";
}> = Wrapper.getUserMetadata;
```

Defined in: [recipe/usermetadata/index.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L48)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `metadata`: `any`;
  `status`: `"OK"`;
\}\>

***

### init()

```ts
const init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/usermetadata/index.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L47)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-usermetadata-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### updateUserMetadata()

```ts
const updateUserMetadata: (userId, metadataUpdate, userContext?) => Promise<{
  metadata: JSONObject;
  status: "OK";
}> = Wrapper.updateUserMetadata;
```

Defined in: [recipe/usermetadata/index.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L49)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `metadataUpdate` | [`JSONObject`](types.mdx#jsonobject) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `metadata`: [`JSONObject`](types.mdx#jsonobject);
  `status`: `"OK"`;
\}\>

## References

### JSONObject

Re-exports [JSONObject](types.mdx#jsonobject)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-usermetadata-types.mdx#recipeinterface)

# References - Backend SDKs - Node.js SDK Reference -  TOTP Types
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-totp-types

## Type Aliases

### APIInterface

```ts
type APIInterface = object;
```

Defined in: [recipe/totp/types.ts:149](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L149)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="createdevicepost"></a> `createDevicePOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `deviceName`: `string`; `qrCodeString`: `string`; `secret`: `string`; `status`: `"OK"`; \} \| \{ `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/totp/types.ts:150](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L150) |
| <a id="listdevicesget"></a> `listDevicesGET` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `devices`: `object`[]; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/totp/types.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L170) |
| <a id="removedevicepost"></a> `removeDevicePOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `didDeviceExist`: `boolean`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/totp/types.ts:185](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L185) |
| <a id="verifydevicepost"></a> `verifyDevicePOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"`; `wasAlreadyVerified`: `boolean`; \} \| \{ `status`: `"UNKNOWN_DEVICE_ERROR"`; \} \| \{ `currentNumberOfFailedAttempts`: `number`; `maxNumberOfFailedAttempts`: `number`; `status`: `"INVALID_TOTP_ERROR"`; \} \| \{ `retryAfterMs`: `number`; `status`: `"LIMIT_REACHED_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/totp/types.ts:200](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L200) |
| <a id="verifytotppost"></a> `verifyTOTPPOST` | \| `undefined` \| (`input`) => `Promise`\< \| \{ `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"`; \} \| \{ `currentNumberOfFailedAttempts`: `number`; `maxNumberOfFailedAttempts`: `number`; `status`: `"INVALID_TOTP_ERROR"`; \} \| \{ `retryAfterMs`: `number`; `status`: `"LIMIT_REACHED_ERROR"`; \} \| [`GeneralErrorResponse`](types.mdx#generalerrorresponse)\> | [recipe/totp/types.ts:228](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L228) |

***

### APIOptions

```ts
type APIOptions = object;
```

Defined in: [recipe/totp/types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L140)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/totp/types.ts:142](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L142) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/totp/types.ts:144](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L144) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/totp/types.ts:143](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L143) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/totp/types.ts:141](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L141) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/totp/types.ts:145](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L145) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/totp/types.ts:146](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L146) |

***

### RecipeInterface

```ts
type RecipeInterface = object;
```

Defined in: [recipe/totp/types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L49)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="createdevice"></a> `createDevice` | (`input`) => `Promise`\< \| \{ `deviceName`: `string`; `qrCodeString`: `string`; `secret`: `string`; `status`: `"OK"`; \} \| \{ `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`; \} \| \{ `status`: `"UNKNOWN_USER_ID_ERROR"`; \}\> | [recipe/totp/types.ts:58](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L58) |
| <a id="getuseridentifierinfoforuserid"></a> `getUserIdentifierInfoForUserId` | (`input`) => `Promise`\< \| \{ `info`: `string`; `status`: `"OK"`; \} \| \{ `status`: `"UNKNOWN_USER_ID_ERROR"` \| `"USER_IDENTIFIER_INFO_DOES_NOT_EXIST_ERROR"`; \}\> | [recipe/totp/types.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L50) |
| <a id="listdevices"></a> `listDevices` | (`input`) => `Promise`\<\{ `devices`: `object`[]; `status`: `"OK"`; \}\> | [recipe/totp/types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L87) |
| <a id="removedevice"></a> `removeDevice` | (`input`) => `Promise`\<\{ `didDeviceExist`: `boolean`; `status`: `"OK"`; \}\> | [recipe/totp/types.ts:96](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L96) |
| <a id="updatedevice"></a> `updateDevice` | (`input`) => `Promise`\<\{ `status`: `"OK"` \| `"UNKNOWN_DEVICE_ERROR"` \| `"DEVICE_ALREADY_EXISTS_ERROR"`; \}\> | [recipe/totp/types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L79) |
| <a id="verifydevice"></a> `verifyDevice` | (`input`) => `Promise`\< \| \{ `status`: `"OK"`; `wasAlreadyVerified`: `boolean`; \} \| \{ `status`: `"UNKNOWN_DEVICE_ERROR"`; \} \| \{ `currentNumberOfFailedAttempts`: `number`; `maxNumberOfFailedAttempts`: `number`; `status`: `"INVALID_TOTP_ERROR"`; \} \| \{ `retryAfterMs`: `number`; `status`: `"LIMIT_REACHED_ERROR"`; \}\> | [recipe/totp/types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L100) |
| <a id="verifytotp"></a> `verifyTOTP` | (`input`) => `Promise`\< \| \{ `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"`; \} \| \{ `currentNumberOfFailedAttempts`: `number`; `maxNumberOfFailedAttempts`: `number`; `status`: `"INVALID_TOTP_ERROR"`; \} \| \{ `retryAfterMs`: `number`; `status`: `"LIMIT_REACHED_ERROR"`; \}\> | [recipe/totp/types.ts:124](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L124) |

***

### TypeInput

```ts
type TypeInput = object;
```

Defined in: [recipe/totp/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L21)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultperiod"></a> `defaultPeriod?` | `number` | [recipe/totp/types.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L24) |
| <a id="defaultskew"></a> `defaultSkew?` | `number` | [recipe/totp/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L23) |
| <a id="issuer"></a> `issuer?` | `string` | [recipe/totp/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L22) |
| <a id="override"></a> `override?` | `object` | [recipe/totp/types.ts:26](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L26) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/totp/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L31) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/totp/types.ts:27](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L27) |

***

### TypeNormalisedInput

```ts
type TypeNormalisedInput = object;
```

Defined in: [recipe/totp/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L35)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultperiod-1"></a> `defaultPeriod` | `number` | [recipe/totp/types.ts:38](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L38) |
| <a id="defaultskew-1"></a> `defaultSkew` | `number` | [recipe/totp/types.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L37) |
| <a id="issuer-1"></a> `issuer` | `string` | [recipe/totp/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L36) |
| <a id="override-1"></a> `override` | `object` | [recipe/totp/types.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L40) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/totp/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L45) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/totp/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/types.ts#L41) |

# References - Backend SDKs - Node.js SDK Reference -  TOTP
Source: https://supertokens.com/docs/references/backend-sdks/supertokens-nodejs/recipe-totp

## Classes

### default

Defined in: [recipe/totp/index.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L20)

#### Constructors

##### Constructor

```ts
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types.mdx#recipelistfunction) | `Recipe.init` | [recipe/totp/index.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L21) |

#### Methods

##### createDevice()

```ts
static createDevice(
   userId, 
   userIdentifierInfo?, 
   deviceName?, 
   skew?, 
   period?, 
   userContext?): Promise<
  | {
  deviceName: string;
  qrCodeString: string;
  secret: string;
  status: "OK";
}
  | {
  status: "DEVICE_ALREADY_EXISTS_ERROR";
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}>;
```

Defined in: [recipe/totp/index.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L23)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userIdentifierInfo?` | `string` |
| `deviceName?` | `string` |
| `skew?` | `number` |
| `period?` | `number` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `deviceName`: `string`;
  `qrCodeString`: `string`;
  `secret`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

##### listDevices()

```ts
static listDevices(userId, userContext?): Promise<{
  devices: object[];
  status: "OK";
}>;
```

Defined in: [recipe/totp/index.ts:70](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L70)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `devices`: `object`[];
  `status`: `"OK"`;
\}\>

##### removeDevice()

```ts
static removeDevice(
   userId, 
   deviceName, 
   userContext?): Promise<{
  didDeviceExist: boolean;
  status: "OK";
}>;
```

Defined in: [recipe/totp/index.ts:88](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L88)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `deviceName` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `didDeviceExist`: `boolean`;
  `status`: `"OK"`;
\}\>

##### updateDevice()

```ts
static updateDevice(
   userId, 
   existingDeviceName, 
   newDeviceName, 
   userContext?): Promise<{
  status: "OK" | "DEVICE_ALREADY_EXISTS_ERROR" | "UNKNOWN_DEVICE_ERROR";
}>;
```

Defined in: [recipe/totp/index.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L54)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `existingDeviceName` | `string` |
| `newDeviceName` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"DEVICE_ALREADY_EXISTS_ERROR"` \| `"UNKNOWN_DEVICE_ERROR"`;
\}\>

##### verifyDevice()

```ts
static verifyDevice(
   tenantId, 
   userId, 
   deviceName, 
   totp, 
   userContext?): Promise<
  | {
  status: "OK";
  wasAlreadyVerified: boolean;
}
  | {
  status: "UNKNOWN_DEVICE_ERROR";
}
  | {
  currentNumberOfFailedAttempts: number;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}>;
```

Defined in: [recipe/totp/index.ts:103](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L103)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `deviceName` | `string` |
| `totp` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `wasAlreadyVerified`: `boolean`;
\}
  \| \{
  `status`: `"UNKNOWN_DEVICE_ERROR"`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

##### verifyTOTP()

```ts
static verifyTOTP(
   tenantId, 
   userId, 
   totp, 
   userContext?): Promise<
  | {
  status: "OK" | "UNKNOWN_USER_ID_ERROR";
}
  | {
  currentNumberOfFailedAttempts: number;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}>;
```

Defined in: [recipe/totp/index.ts:136](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L136)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `totp` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

## Variables

### createDevice()

```ts
createDevice: (userId, userIdentifierInfo?, deviceName?, skew?, period?, userContext?) => Promise<
  | {
  deviceName: string;
  qrCodeString: string;
  secret: string;
  status: "OK";
}
  | {
  status: "DEVICE_ALREADY_EXISTS_ERROR";
}
  | {
  status: "UNKNOWN_USER_ID_ERROR";
}> = Wrapper.createDevice;
```

Defined in: [recipe/totp/index.ts:166](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L166)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userIdentifierInfo?` | `string` |
| `deviceName?` | `string` |
| `skew?` | `number` |
| `period?` | `number` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `deviceName`: `string`;
  `qrCodeString`: `string`;
  `secret`: `string`;
  `status`: `"OK"`;
\}
  \| \{
  `status`: `"DEVICE_ALREADY_EXISTS_ERROR"`;
\}
  \| \{
  `status`: `"UNKNOWN_USER_ID_ERROR"`;
\}\>

***

### init()

```ts
init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/totp/index.ts:164](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L164)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-totp-types.mdx#typeinput) |

#### Returns

[`RecipeListFunction`](types.mdx#recipelistfunction)

***

### listDevices()

```ts
listDevices: (userId, userContext?) => Promise<{
  devices: object[];
  status: "OK";
}> = Wrapper.listDevices;
```

Defined in: [recipe/totp/index.ts:167](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L167)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `devices`: `object`[];
  `status`: `"OK"`;
\}\>

***

### removeDevice()

```ts
removeDevice: (userId, deviceName, userContext?) => Promise<{
  didDeviceExist: boolean;
  status: "OK";
}> = Wrapper.removeDevice;
```

Defined in: [recipe/totp/index.ts:169](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L169)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `deviceName` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `didDeviceExist`: `boolean`;
  `status`: `"OK"`;
\}\>

***

### updateDevice()

```ts
updateDevice: (userId, existingDeviceName, newDeviceName, userContext?) => Promise<{
  status: "OK" | "DEVICE_ALREADY_EXISTS_ERROR" | "UNKNOWN_DEVICE_ERROR";
}> = Wrapper.updateDevice;
```

Defined in: [recipe/totp/index.ts:168](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L168)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `existingDeviceName` | `string` |
| `newDeviceName` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"` \| `"DEVICE_ALREADY_EXISTS_ERROR"` \| `"UNKNOWN_DEVICE_ERROR"`;
\}\>

***

### verifyDevice()

```ts
verifyDevice: (tenantId, userId, deviceName, totp, userContext?) => Promise<
  | {
  status: "OK";
  wasAlreadyVerified: boolean;
}
  | {
  status: "UNKNOWN_DEVICE_ERROR";
}
  | {
  currentNumberOfFailedAttempts: number;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}> = Wrapper.verifyDevice;
```

Defined in: [recipe/totp/index.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L170)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `deviceName` | `string` |
| `totp` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"`;
  `wasAlreadyVerified`: `boolean`;
\}
  \| \{
  `status`: `"UNKNOWN_DEVICE_ERROR"`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

***

### verifyTOTP()

```ts
verifyTOTP: (tenantId, userId, totp, userContext?) => Promise<
  | {
  status: "OK" | "UNKNOWN_USER_ID_ERROR";
}
  | {
  currentNumberOfFailedAttempts: number;
  maxNumberOfFailedAttempts: number;
  status: "INVALID_TOTP_ERROR";
}
  | {
  retryAfterMs: number;
  status: "LIMIT_REACHED_ERROR";
}> = Wrapper.verifyTOTP;
```

Defined in: [recipe/totp/index.ts:171](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/totp/index.ts#L171)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `tenantId` | `string` |
| `userId` | `string` |
| `totp` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<
  \| \{
  `status`: `"OK"` \| `"UNKNOWN_USER_ID_ERROR"`;
\}
  \| \{
  `currentNumberOfFailedAttempts`: `number`;
  `maxNumberOfFailedAttempts`: `number`;
  `status`: `"INVALID_TOTP_ERROR"`;
\}
  \| \{
  `retryAfterMs`: `number`;
  `status`: `"LIMIT_REACHED_ERROR"`;
\}\>

## References

### APIInterface

Re-exports [APIInterface](recipe-totp-types.mdx#apiinterface)

***

### APIOptions

Re-exports [APIOptions](recipe-totp-types.mdx#apioptions)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-totp-types.mdx#recipeinterface)

# References - Backend SDKs -  If your backend framework is not supported by SuperTokens, you can follow this guide on setting up an authentication server to protect your frontend and backend.
Source: https://supertokens.com/docs/references/backend-sdks/other-frameworks

A key feature of the SuperTokens backend SDK is the middleware it adds to your backend server. This middleware adds authentication routes to handle requests like user creation and login. If your backend framework is not supported by SuperTokens, you need to run a separate server with the SuperTokens backend SDK configured. This could be a service in NodeJS, Python, or Golang.

To illustrate how this setup works, consider an example:
- The user has a React based frontend and a PHP backend server.
- SuperTokens does not have a PHP SDK, and a separate service in NodeJS starts to act as an authentication server. The SuperTokens backend SDK configures this server to handle authentication requests and the issuing of access and refresh tokens.
- The architecture of setup should have the following design:

![SuperTokens Setup With Authentication server](/img/other-framework-setup.png)

- In the architecture above the the React Frontend communicates with the PHP and node server through a reverse proxy.
- Authentication requests like sign-up or sign-in route to the NodeJS server. These APIs are automatically created and handled by the `supertokens-node` SDK. On the other hand, your application-specific APIs are on the PHP server.
- Once a user signs up or signs in, the system creates a session between your API server's domain and the frontend.
- Application requests to the PHP server have session tokens attached to them.
- The session token is a JWT, and the PHP server can [verify it](/docs/additional-verification/session-verification/protect-api-routes#using-a-jwt-verification-library).
- When verifying a request, if the session token is missing or has expired, the PHP server should return a `401` response. This prompts the SuperTokens Frontend SDK to trigger the automatic refresh flow to generate new session tokens and retry the request.

:::info Important
The method mentioned above assumes that the authentication server is running on the same domain as the PHP server. If instead, your authentication server runs on a separate subdomain, you need to [enable cookie sharing](/docs/post-authentication/session-management/advanced-workflows/multiple-api-endpoints) for cookies to be automatically attached to requests to the PHP server.
:::

# References - Frontend Driver Interface -  Frontend Driver Interface
Source: https://supertokens.com/docs/references/fdi/introduction

## Overview

The **FDI**, Frontend Driver Interface, is the API exposed by the **SuperTokens Backend SDKs**.
It is meant to be consumed only by your frontend applications.

:::info no-title
In most cases, you don't need to directly interact with the API, since the existing [frontend SDKS](/docs/references/backend-sdks/reference) are built on top of it.
If you are using something that does not have SDK support, then you can make use of the FDI resources.
:::

### URL Structure

All the endpoints are prefixed with `{apiBasePath}`.
This is the property with the same name that you set during [backend SDK initialization](/docs/quickstart/backend-setup#2-initialize-the-sdk).

Tenant specific actions include a `{tenantId}` parameter. If not set, the default tenant will be used.

Given the following endpoint: `/{apiBasePath}/{tenantId}/signinup`, and the `apiBasePath` set to `auth` during [initialization](/docs/quickstart/backend-setup#2-initialize-the-sdk):
- You can call it without the actual parameter, using `/auth/signinup` in your action. 
- You can set the values to target a specific tenant: `/auth/myTenant/signinup`.

### Versioning

At the moment, the documentation pages only show the latest version of the API.
If you want to check an older release, please access the [Swagger page](https://app.swaggerhub.com/apis/supertokens/FDI)

To know which version you should see:
1. Go to the GitHub page of the backend or frontend SDK you are using
2. Switch to the branch that matches the version of the SDK
3. Open the file called `frontendDriverInterfaceSupported.json`
4. In there, you see an array of `X.Y` values, pick the latest one, and see the API spec for that.

## Authentication

Since this API allows users to sign up or login, most of the endpoints do not require any type of credentials.
However, in some situations you have to authenticate your requests.
In those cases, you need to choose between using cookies or headers.
The method that you have to use depends on the [token transfer method](/docs/post-authentication/session-management/switch-between-cookies-and-header-authentication) used in your application.

{
  "get": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "getVerifyEmail",
    "summary": "Check email verification status",
    "description": "Checks if an email is verified and adds this information into the access token payload as well\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email verification recipe ID",
        "example": "emailverification",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if an email is verified and adds this information into the access token payload as well",
        "headers": {
          "Set-Cookie": {
            "description": "Sent in cookie-based sessions if the access token payload is updated",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "Sent in cookie-based sessions if the access token payload is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "Sent if enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "description": "Sent if the access token payload is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "isVerified": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "verifyEmail",
    "summary": "Verify email address",
    "description": "Verify an email\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email verification recipe ID",
        "example": "emailverification",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string",
                "description": "The method to use for the operation",
                "example": "token"
              },
              "token": {
                "type": "string",
                "description": "A security token used for authentication",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Verify an email",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "verifyEmailToken",
    "summary": "Send email verification",
    "description": "Send email verification email\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email verification recipe ID",
        "example": "emailverification",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "responses": {
      "200": {
        "description": "Send email verification email",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "EMAIL_ALREADY_VERIFIED_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailExists",
    "summary": "Check email exists",
    "description": "Check if an email exists\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email password recipe ID",
        "example": "emailpassword",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "email",
        "in": "query",
        "description": "The email address to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if an email exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "description": "Whether the resource exists",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailExistsDepr",
    "summary": "Check email exists (deprecated)",
    "description": "Check if an email exists\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email password recipe ID",
        "example": "emailpassword",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "email",
        "in": "query",
        "description": "The email address to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if an email exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "description": "Whether the resource exists",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "signIn",
    "summary": "Sign in with email",
    "description": "Signin a user with email ID and password\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The recipe ID for the request",
        "example": "session",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "formFields"
            ],
            "properties": {
              "formFields": {
                "type": "array",
                "description": "Form fields for authentication",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field identifier",
                      "enum": [
                        "email",
                        "password"
                      ]
                    },
                    "value": {
                      "type": "string",
                      "description": "Field value"
                    }
                  }
                },
                "example": [
                  {
                    "id": "email",
                    "value": "johndoe@gmail.com"
                  },
                  {
                    "id": "password",
                    "value": "testPass123"
                  }
                ]
              },
              "shouldTryLinkingWithSessionUser": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Sign in Response",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "description": "Sign in response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Sign in not allowed response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "SIGN_IN_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "description": "Reason why sign in is not allowed",
                      "example": "Cannot sign in due to security reasons. Please try resetting your password, use a different login method or contact support. (ERR_CODE_008)"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Form field error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "FIELD_ERROR"
                      ]
                    },
                    "formFields": {
                      "type": "array",
                      "description": "List of field errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Field ID",
                            "example": "email"
                          },
                          "error": {
                            "type": "string",
                            "description": "Error message",
                            "example": "Error Message"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Wrong credentials error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "WRONG_CREDENTIALS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "signUp",
    "summary": "Sign up with email",
    "description": "Signup a user with email ID and password\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email password recipe ID",
        "example": "emailpassword",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "formFields"
            ],
            "properties": {
              "formFields": {
                "type": "array",
                "description": "Form fields for authentication",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field identifier",
                      "enum": [
                        "email",
                        "password"
                      ]
                    },
                    "value": {
                      "type": "string",
                      "description": "Field value"
                    }
                  }
                },
                "example": [
                  {
                    "id": "email",
                    "value": "johndoe@gmail.com"
                  },
                  {
                    "id": "password",
                    "value": "testPass123"
                  }
                ]
              },
              "shouldTryLinkingWithSessionUser": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Sign up Response",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "description": "Sign up response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Sign up not allowed response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "SIGN_UP_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "description": "Reason why sign up is not allowed",
                      "example": "Cannot sign up due to security reasons. Please try resetting your password, use a different login method or contact support. (ERR_CODE_007)"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Form field error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "FIELD_ERROR"
                      ]
                    },
                    "formFields": {
                      "type": "array",
                      "description": "List of field errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Field ID",
                            "example": "email"
                          },
                          "error": {
                            "type": "string",
                            "description": "Error message",
                            "example": "Error Message"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "passwordReset",
    "summary": "Reset user password",
    "description": "Reset a password using password reset token\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email password recipe ID",
        "example": "emailpassword",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string",
                "description": "The method to use for the operation",
                "example": "token"
              },
              "formfields": {
                "type": "array",
                "description": "Form fields for authentication",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field identifier",
                      "enum": [
                        "email",
                        "password"
                      ]
                    },
                    "value": {
                      "type": "string",
                      "description": "Field value"
                    }
                  }
                },
                "example": [
                  {
                    "id": "email",
                    "value": "johndoe@gmail.com"
                  },
                  {
                    "id": "password",
                    "value": "testPass123"
                  }
                ]
              },
              "token": {
                "type": "string",
                "description": "A security token used for authentication",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              }
            },
            "example": {
              "method": "token",
              "formFields": [
                {
                  "id": "password",
                  "value": "newPass123"
                }
              ],
              "token": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Reset a password using password reset token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "description": "Password reset success response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Password reset error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "RESET_PASSWORD_INVALID_TOKEN_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Form field error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "FIELD_ERROR"
                      ]
                    },
                    "formFields": {
                      "type": "array",
                      "description": "List of field errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Field ID",
                            "example": "email"
                          },
                          "error": {
                            "type": "string",
                            "description": "Error message",
                            "example": "Error Message"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "passwordResetToken",
    "summary": "Generate password reset token",
    "description": "Generate a new reset password token for this user\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The email password recipe ID",
        "example": "emailpassword",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "formFields": {
                "type": "array",
                "description": "Form fields for authentication",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field identifier",
                      "enum": [
                        "email",
                        "password"
                      ]
                    },
                    "value": {
                      "type": "string",
                      "description": "Field value"
                    }
                  }
                },
                "example": [
                  {
                    "id": "email",
                    "value": "johndoe@gmail.com"
                  },
                  {
                    "id": "password",
                    "value": "testPass123"
                  }
                ]
              }
            },
            "example": {
              "formFields": [
                {
                  "id": "email",
                  "value": "test@email.com"
                }
              ]
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Generate a new reset password token for this user",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "description": "Password reset token response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Password reset not allowed response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "PASSWORD_RESET_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "description": "Reason why password reset is not allowed",
                      "example": "Token generation was not done because of account take over risk. Please contact support. (HAS_OTHER_EMAIL_OR_PHONE)"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Form field error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status",
                      "enum": [
                        "FIELD_ERROR"
                      ]
                    },
                    "formFields": {
                      "type": "array",
                      "description": "List of field errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Field ID",
                            "example": "email"
                          },
                          "error": {
                            "type": "string",
                            "description": "Error message",
                            "example": "Error Message"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "TOTP Recipe"
    ],
    "operationId": "listTOTPdevices",
    "summary": "List TOTP devices",
    "description": "List the TOTP devices of the current user\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The TOTP recipe ID",
        "example": "totp",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "responses": {
      "200": {
        "description": "The list of the TOTP devices of the session user",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Devices List Response",
                  "description": "Successful response containing the list of TOTP devices for the current user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "devices": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "asdf123"
                          },
                          "period": {
                            "type": "number",
                            "example": 30
                          },
                          "skew": {
                            "type": "number",
                            "example": 30
                          },
                          "verified": {
                            "type": "boolean",
                            "example": false
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "TOTP Recipe"
    ],
    "operationId": "createTOTPDevice",
    "summary": "Create TOTP device",
    "description": "Creates an unverified totp device\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The TOTP recipe ID",
        "example": "totp",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "deviceName": {
                "type": "string",
                "example": "asdf123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Information about the created (unverified) device. Based on the this,\nthe user can add the device to their TOTP app and verify it.\n",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Creation Response",
                  "description": "Successful response containing information about the created TOTP device",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "deviceName": {
                      "type": "string",
                      "example": "asfd123"
                    },
                    "qrCodeString": {
                      "type": "string",
                      "example": "otpauth://totp/Supertokens:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Supertokens"
                    },
                    "secret": {
                      "type": "string",
                      "example": "JBSWY3DPEHPK3PXP"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "TOTP Device Already Exists Error",
                  "description": "Error response when attempting to create a TOTP device that already exists",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "DEVICE_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "TOTP Recipe"
    ],
    "operationId": "removeTOTPDevice",
    "summary": "Remove TOTP device",
    "description": "Removes a totp device\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The TOTP recipe ID",
        "example": "totp",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "deviceName": {
                "type": "string",
                "example": "asdf123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Success report",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Removal Response",
                  "description": "Successful response indicating whether the TOTP device was removed",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didDeviceExist": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "TOTP Recipe"
    ],
    "operationId": "verifyTOTPDevice",
    "summary": "Verify TOTP device",
    "description": "Checks that the TOTP sent in the body belongs to the totp device (specified by deviceName, belonging to the session user)\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The TOTP recipe ID",
        "example": "totp",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "totp": {
                "type": "string",
                "example": "123456"
              },
              "deviceName": {
                "type": "string",
                "example": "asdf123asdf"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Verification result and optionally the session with a refreshed MFA claim",
        "headers": {
          "Set-Cookie": {
            "description": "Sent in cookie-based sessions if the access token payload is updated",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "Sent in cookie-based sessions if the access token payload is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "Sent if enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "description": "Sent if the access token payload is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Verification Success",
                  "description": "Successful response when TOTP device verification succeeds",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Unknown TOTP Device Error",
                  "description": "Error response when attempting to verify an unknown TOTP device",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_DEVICE_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Invalid TOTP Error",
                  "description": "Error response when the provided TOTP code is invalid",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_TOTP_ERROR"
                      ]
                    },
                    "currentNumberOfFailedAttempts": {
                      "type": "number",
                      "example": 2
                    },
                    "maxNumberOfFailedAttempts": {
                      "type": "number",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "TOTP Rate Limit Error",
                  "description": "Error response when too many failed TOTP attempts have been made",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "LIMIT_REACHED_ERROR"
                      ]
                    },
                    "retryAfterMs": {
                      "type": "number",
                      "example": 30000
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "TOTP Recipe"
    ],
    "operationId": "verifyTOTP",
    "summary": "Verify TOTP code",
    "description": "Checks that the TOTP sent in the body belongs to a verified totp device of the session user\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The TOTP recipe ID",
        "example": "totp",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "totp": {
                "type": "string",
                "example": "123456"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Verification result and optionally the session with a refreshed MFA claim",
        "headers": {
          "Set-Cookie": {
            "description": "Sent in cookie-based sessions if the access token payload is updated",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "Sent in cookie-based sessions if the access token payload is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "Sent if enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "description": "Sent if the access token payload is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Sign Out Response",
                  "description": "Successful response when user is signed out",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_TOTP_ERROR"
                      ]
                    },
                    "currentNumberOfFailedAttempts": {
                      "type": "number",
                      "example": 2
                    },
                    "maxNumberOfFailedAttempts": {
                      "type": "number",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "LIMIT_REACHED_ERROR"
                      ]
                    },
                    "retryAfterMs": {
                      "type": "number",
                      "example": 30000
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "MultiFactorAuth Recipe"
    ],
    "operationId": "getMFAInfo",
    "summary": "Get MFA factors information",
    "description": "Returns information about the auth factors of the current user and refreshes the related session claim\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The multi factor auth recipe ID",
        "example": "multifactorauth",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "responses": {
      "200": {
        "description": "Information about the auth factors of the current user and optionally the session with a refreshed MFA claim",
        "headers": {
          "Set-Cookie": {
            "description": "Sent in cookie-based sessions if the access token is updated",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "Sent in cookie-based sessions if the access token is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "Sent if enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "description": "Sent if the access token is updated",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "MFA Info Response",
                  "description": "Successful response containing information about the auth factors of the current user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "factors": {
                      "type": "object",
                      "properties": {
                        "alreadySetup": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "allowedToSetup": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "next": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "emails": {
                      "type": "object",
                      "properties": {
                        "emailpassword": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "otp-email": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "link-email": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "phoneNumbers": {
                      "type": "object",
                      "properties": {
                        "otp-phone": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "link-phone": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthAuthGET",
    "summary": "Start OAuth login",
    "description": "Starts the OAuth2 login flow - for a detailed description of all input parameters please see the OAuth2 and OpenID Connect Core specs\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "A general error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Generic error response",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Error status code",
                  "enum": [
                    "GENERAL_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          }
        }
      },
      "302": {
        "description": "Redirects the user to the login page or back to the client app",
        "headers": {
          "Location": {
            "schema": {
              "type": "string",
              "example": "https://auth.example.com/auth/?loginChallenge=1234567890"
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthEndSessionPOST",
    "summary": "End OAuth session",
    "description": "Redirects the user to a page where they can log out and revoke the oauth tokens - for a detailed description of input parameters please see the user initiated logout spec\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id_token_hint": {
                "type": "string"
              },
              "client_id": {
                "type": "string",
                "example": "st-cl-example-client"
              },
              "post_logout_redirect_uri": {
                "type": "string",
                "example": "https://client.example.com/logoutCallback"
              }
            }
          }
        },
        "application/x-www-form-urlencoded": {
          "schema": {
            "type": "object",
            "properties": {
              "id_token_hint": {
                "type": "string"
              },
              "client_id": {
                "type": "string",
                "example": "st-cl-example-client"
              },
              "post_logout_redirect_uri": {
                "type": "string",
                "example": "https://client.example.com/logoutCallback"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "A general error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Generic error response",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Error status code",
                  "enum": [
                    "GENERAL_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          }
        }
      },
      "302": {
        "description": "Redirects the user to the logout page or back to the client app",
        "headers": {
          "Location": {
            "schema": {
              "type": "string",
              "example": "https://auth.example.com/auth/oauth/logout?logoutChallenge=1234567890"
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthEndSessionGET",
    "summary": "End session redirect",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "in": "query",
        "name": "id_token_hint",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "client_id",
        "schema": {
          "type": "string",
          "example": "st-cl-example-client"
        }
      },
      {
        "in": "query",
        "name": "post_logout_redirect_uri",
        "schema": {
          "type": "string",
          "example": "https://client.example.com/logoutCallback"
        }
      }
    ],
    "description": "Redirects the user to a page where they can log out and revoke the oauth tokens\n",
    "responses": {
      "200": {
        "description": "A general error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Generic error response",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Error status code",
                  "enum": [
                    "GENERAL_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          }
        }
      },
      "302": {
        "description": "Redirects the user to the logout page or back to the client app",
        "headers": {
          "Location": {
            "schema": {
              "type": "string",
              "example": "https://auth.example.com/auth/oauth/logout?logoutChallenge=1234567890"
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthLoginGET",
    "summary": "Continue OAuth login",
    "description": "Continues the OAuth2 login flow after the login page\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "in": "query",
        "name": "loginChallenge",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The next url in the login flow",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "frontendRedirectTo": {
                      "type": "string",
                      "description": "The URL to redirect the user to",
                      "example": "https://client.com/callback?code=asdf1234567890&status=asdf1234"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthLoginInfoGET",
    "summary": "Get OAuth login info",
    "description": "Retrieves information about the OAuth2 login\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "in": "query",
        "name": "loginChallenge",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Information about the current login flow",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status",
                    "info"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "info": {
                      "type": "object",
                      "description": "Information about the current login flow",
                      "required": [
                        "clientId"
                      ],
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "description": "The ID of the client."
                        },
                        "clientName": {
                          "type": "string",
                          "description": "The name of the client."
                        },
                        "tosUri": {
                          "type": "string",
                          "description": "The URI of the client's terms of service."
                        },
                        "policyUri": {
                          "type": "string",
                          "description": "The URI of the client's privacy policy."
                        },
                        "logoUri": {
                          "type": "string",
                          "description": "The URI of the client's logo."
                        },
                        "clientUri": {
                          "type": "string",
                          "description": "The URI of the client we can link to on the login page"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthUserInfoGET",
    "summary": "Get OAuth user info",
    "description": "Retrieves user information based on the access token passed in the authorization header\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "security": [
      {
        "OAuth2AccessTokenBearer": []
      }
    ],
    "responses": {
      "200": {
        "description": "Retrieved user information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "sub"
                  ],
                  "properties": {
                    "sub": {
                      "type": "string",
                      "description": "Unique identifier for a user",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the user",
                      "example": "johndoe@gmail.com"
                    },
                    "email_verified": {
                      "type": "boolean",
                      "description": "Whether the email is verified",
                      "example": true
                    },
                    "emails": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "johndoe@gmail.com"
                      }
                    },
                    "phoneNumber": {
                      "type": "string",
                      "description": "The phoneNumber of the user",
                      "example": "0036701234567"
                    },
                    "phoneNumber_verified": {
                      "type": "boolean",
                      "description": "Whether the phoneNumber is verified",
                      "example": true
                    },
                    "phoneNumbers": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "0036701234567"
                      }
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "admin"
                      }
                    },
                    "permissions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "user:create"
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "401": {
        "description": "The access token is expired, revoked or malformed",
        "headers": {
          "WWW-Authenticate": {
            "schema": {
              "type": "string",
              "example": "Bearer error=\"invalid_token\""
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "example": "Invalid or expired OAuth2 access token"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthEndSessionPOST",
    "summary": "End OAuth session",
    "description": "Redirects the user to a page where they can log out and revoke the oauth tokens - for a detailed description of input parameters please see the user initiated logout spec\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id_token_hint": {
                "type": "string"
              },
              "client_id": {
                "type": "string",
                "example": "st-cl-example-client"
              },
              "post_logout_redirect_uri": {
                "type": "string",
                "example": "https://client.example.com/logoutCallback"
              }
            }
          }
        },
        "application/x-www-form-urlencoded": {
          "schema": {
            "type": "object",
            "properties": {
              "id_token_hint": {
                "type": "string"
              },
              "client_id": {
                "type": "string",
                "example": "st-cl-example-client"
              },
              "post_logout_redirect_uri": {
                "type": "string",
                "example": "https://client.example.com/logoutCallback"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "A general error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Generic error response",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Error status code",
                  "enum": [
                    "GENERAL_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          }
        }
      },
      "302": {
        "description": "Redirects the user to the logout page or back to the client app",
        "headers": {
          "Location": {
            "schema": {
              "type": "string",
              "example": "https://auth.example.com/auth/oauth/logout?logoutChallenge=1234567890"
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthEndSessionGET",
    "summary": "End session redirect",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "in": "query",
        "name": "id_token_hint",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "client_id",
        "schema": {
          "type": "string",
          "example": "st-cl-example-client"
        }
      },
      {
        "in": "query",
        "name": "post_logout_redirect_uri",
        "schema": {
          "type": "string",
          "example": "https://client.example.com/logoutCallback"
        }
      }
    ],
    "description": "Redirects the user to a page where they can log out and revoke the oauth tokens\n",
    "responses": {
      "200": {
        "description": "A general error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Generic error response",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Error status code",
                  "enum": [
                    "GENERAL_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          }
        }
      },
      "302": {
        "description": "Redirects the user to the logout page or back to the client app",
        "headers": {
          "Location": {
            "schema": {
              "type": "string",
              "example": "https://auth.example.com/auth/oauth/logout?logoutChallenge=1234567890"
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthIntrospectPOST",
    "summary": "Introspect OAuth token",
    "description": "Introspects an access/refresh token\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "token"
            ],
            "properties": {
              "token": {
                "type": "string"
              }
            }
          }
        },
        "application/x-www-form-urlencoded": {
          "schema": {
            "type": "object",
            "required": [
              "token"
            ],
            "properties": {
              "token": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Information about the token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "active"
                  ],
                  "properties": {
                    "active": {
                      "type": "boolean",
                      "description": "Whether the token is active or not",
                      "example": true
                    },
                    "token_type": {
                      "type": "string",
                      "description": "The type of the token",
                      "example": "Bearer"
                    },
                    "token_use": {
                      "type": "string",
                      "description": "The use of the token",
                      "example": "access_token"
                    },
                    "sub": {
                      "type": "string",
                      "description": "Unique identifier for a user",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the user",
                      "example": "johndoe@gmail.com"
                    },
                    "email_verified": {
                      "type": "boolean",
                      "description": "Whether the email is verified",
                      "example": true
                    },
                    "emails": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "johndoe@gmail.com"
                      }
                    },
                    "phoneNumber": {
                      "type": "string",
                      "description": "The phoneNumber of the user",
                      "example": "0036701234567"
                    },
                    "phoneNumber_verified": {
                      "type": "boolean",
                      "description": "Whether the phoneNumber is verified",
                      "example": true
                    },
                    "phoneNumbers": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "0036701234567"
                      }
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "admin"
                      }
                    },
                    "permissions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "user:create"
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthLogoutPOST",
    "summary": "Logout OAuth user",
    "description": "Logs out the user and revokes the access/refresh tokens based on the id_token_hint passed to the end_session endpoint\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "logoutChallenge"
            ],
            "properties": {
              "logoutChallenge": {
                "type": "string"
              }
            }
          }
        },
        "x-www-form-urlencoded": {
          "schema": {
            "type": "object",
            "required": [
              "logoutChallenge"
            ],
            "properties": {
              "logoutChallenge": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Accepts the logout request specified by the challenge and gets where the user should be redirected to",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "frontendRedirectTo": {
                      "type": "string",
                      "description": "The URL to redirect the user to",
                      "example": "https://auth.example.com/auth/oauth/logout?logoutChallenge=1234567890"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthRevokePOST",
    "summary": "Revoke OAuth token",
    "description": "Revokes an access/refresh token - the client id and secret can also be provided in an authorization header using the Basic scheme\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "token"
            ],
            "properties": {
              "token": {
                "type": "string"
              },
              "client_id": {
                "type": "string",
                "example": "st-cl-test-client"
              },
              "client_secret": {
                "type": "string",
                "example": "superSecret"
              }
            }
          }
        },
        "x-www-form-urlencoded": {
          "schema": {
            "type": "object",
            "required": [
              "token"
            ],
            "properties": {
              "token": {
                "type": "string"
              },
              "client_id": {
                "type": "string",
                "example": "st-cl-test-client"
              },
              "client_secret": {
                "type": "string",
                "example": "superSecret"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Revoked the access/refresh token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "operationId": "oauthTokenPOST",
    "summary": "Exchange OAuth grant",
    "description": "Exchanges an OAuth2 grant (e.g.: authorization code) for an access token (and optionally a refresh/id token) - for a detailed description of all input parameters please see the OAuth2 and OpenID Connect Core specs\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Issued tokens",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "expires_in",
                    "token_type",
                    "scope"
                  ],
                  "properties": {
                    "access_token": {
                      "type": "string",
                      "description": "The access token issued by the authorization server."
                    },
                    "expires_in": {
                      "type": "number",
                      "description": "The lifetime in seconds of the access token (integer). For example, the value \"3600\" denotes that the access token will expire in one hour from the time the response was generated."
                    },
                    "id_token": {
                      "type": "string",
                      "description": "To retrieve a refresh token request the id_token scope."
                    },
                    "refresh_token": {
                      "type": "string",
                      "description": "The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope \"offline\" to your access token request."
                    },
                    "scope": {
                      "type": "string",
                      "description": "The scope of the access token"
                    },
                    "token_type": {
                      "type": "string",
                      "description": "The type of the token issued"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "OAuth2 specific error response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "description": "The OAuth2 error code",
                  "example": "invalid_request"
                },
                "error_description": {
                  "type": "string",
                  "description": "Human readable error description",
                  "example": "Unsupported grant type: password"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessEmailExists",
    "summary": "Check email exists",
    "description": "Check if an email exists\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "email",
        "in": "query",
        "description": "The email address to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if an email exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Email Exists Response",
                  "description": "Response indicating whether the email exists in the system",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "description": "Whether the resource exists",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessPhoneNumberExists",
    "summary": "Check phone exists",
    "description": "Check if a phone number exists\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "phoneNumber",
        "in": "query",
        "description": "The phone number to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "0036701234567"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if a phone number exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "description": "Whether the resource exists",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessEmailExistsDepr",
    "summary": "Check email exists (deprecated)",
    "description": "Check if an email exists\nNote that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "email",
        "in": "query",
        "description": "The email address to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if an email exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Email Exists Response",
                  "description": "Response indicating whether the email exists in the system",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "description": "Whether the resource exists",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessPhoneNumberExistsDepr",
    "summary": "Check phone exists (deprecated)",
    "description": "Check if a phone number exists\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "phoneNumber",
        "in": "query",
        "description": "The phone number to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "0036701234567"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Checks if a phone number exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Phone Number Exists Response",
                  "description": "Response indicating whether the phone number exists in the system",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "description": "Whether the resource exists",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessSignInUpStart",
    "summary": "Start passwordless sign in/up",
    "description": "Start sign in/up process with passwordless\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Email address",
                    "example": "johndoe@gmail.com"
                  },
                  "shouldTryLinkingWithSessionUser": {
                    "type": "boolean",
                    "example": false
                  }
                },
                "required": [
                  "email"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "phoneNumber": {
                    "type": "string",
                    "description": "Phone number",
                    "example": "0036701234567"
                  },
                  "shouldTryLinkingWithSessionUser": {
                    "type": "boolean",
                    "example": false
                  }
                },
                "required": [
                  "phoneNumber"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Started the passwordless sign in/up process.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Passwordless Sign In/Up Start Response",
                  "description": "Successful response containing information to continue the passwordless sign in/up process",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "deviceId": {
                      "type": "string",
                      "description": "This should be saved on the starting device to enable the manual code entry flow.",
                      "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
                    },
                    "preAuthSessionId": {
                      "type": "string",
                      "description": "An identifier that used to identify the login attempt/device.",
                      "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                    },
                    "flowType": {
                      "type": "string",
                      "enum": [
                        "MAGIC_LINK",
                        "USER_INPUT_CODE_AND_MAGIC_LINK",
                        "USER_INPUT_CODE"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Sign In/Up Not Allowed Error",
                  "description": "Error response when sign in/up is not allowed due to security reasons",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "SIGN_IN_UP_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "example": "Cannot sign in / up due to security reasons. Please contact support. (IS_SIGN_IN_ALLOWED_FALSE)"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessSignInUpConsume",
    "summary": "Complete passwordless sign in/up",
    "description": "Finish sign in/up process with passwordless\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "An identifier that used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  },
                  "shouldTryLinkingWithSessionUser": {
                    "type": "boolean",
                    "example": false
                  },
                  "linkCode": {
                    "type": "string",
                    "example": "b10lbT_SnDC4flA6Fn7pE5TtG5k5NfigLef4QMBeGA8"
                  }
                },
                "required": [
                  "preAuthSessionId",
                  "linkCode"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "An identifier that used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  },
                  "shouldTryLinkingWithSessionUser": {
                    "type": "boolean",
                    "example": false
                  },
                  "deviceId": {
                    "type": "string",
                    "description": "This should be saved on the starting device to enable the manual code entry flow.",
                    "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
                  },
                  "userInputCode": {
                    "type": "string",
                    "example": 432123
                  }
                },
                "required": [
                  "preAuthSessionId",
                  "deviceId",
                  "userInputCode"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Signin/up a user",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Passwordless Sign In/Up Response",
                  "description": "Successful response containing user information after passwordless sign in/up",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "createdNewRecipeUser": {
                      "type": "boolean",
                      "example": true
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Incorrect User Input Code Error",
                  "description": "Error response when the user input code is incorrect",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INCORRECT_USER_INPUT_CODE_ERROR",
                        "EXPIRED_USER_INPUT_CODE_ERROR"
                      ]
                    },
                    "failedCodeInputAttemptCount": {
                      "type": "number",
                      "example": 2
                    },
                    "maximumCodeInputAttempts": {
                      "type": "number",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Restart Flow Error",
                  "description": "Error response indicating the flow needs to be restarted",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RESTART_FLOW_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Sign In/Up Not Allowed Error",
                  "description": "Error response when sign in/up is not allowed due to security reasons",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "SIGN_IN_UP_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "example": "Cannot sign in / up due to security reasons. Please contact support. (IS_SIGN_IN_ALLOWED_FALSE)"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessSignInUpResend",
    "summary": "Resend passwordless code",
    "description": "Resend passwordless code\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The passwordless recipe ID",
        "example": "passwordless",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "deviceId": {
                "type": "string",
                "description": "This should be saved on the starting device to enable the manual code entry flow.",
                "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
              },
              "preAuthSessionId": {
                "type": "string",
                "description": "An identifier that used to identify the login attempt/device.",
                "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
              },
              "shouldTryLinkingWithSessionUser": {
                "type": "boolean",
                "example": false
              }
            },
            "required": [
              "deviceId",
              "preAuthSessionId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Started the passwordless sign in/up process.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Passwordless Code Resend Response",
                  "description": "Response indicating the status of the passwordless code resend attempt",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "RESTART_FLOW_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "refresh",
    "summary": "Refresh user session",
    "description": "Refresh the user session\n",
    "security": [
      {
        "RefreshTokenBearer": []
      },
      {
        "RefreshTokenCookie": []
      }
    ],
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The recipe ID for the request",
        "example": "session",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Refresh users",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "signout",
    "summary": "Sign out user",
    "description": "Logout user\n",
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The recipe ID for the request",
        "example": "session",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Logout user",
        "headers": {
          "Set-Cookie": {
            "schema": {
              "type": "string",
              "example": "sAccessToken=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT; HttpOnly; SameSite=Lax sRefreshToken=; Path=/auth/session/refresh; Expires=Thu, 01 Jan 1970 00:00:00 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "Set to an empty string to trigger token clearing in the client SDK",
            "schema": {
              "type": "string",
              "example": ""
            }
          },
          "st-refresh-token": {
            "description": "Set to an empty string to trigger token clearing in the client SDK",
            "schema": {
              "type": "string",
              "example": ""
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "example": "remove"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "ThirdParty Recipe"
    ],
    "operationId": "authorisationUrl",
    "summary": "Get third party auth URL",
    "description": "Get the thirdparty provider's authorisation URL to which the user should be redirected to.\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The third party recipe ID",
        "example": "thirdparty",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "thirdPartyId",
        "required": true,
        "schema": {
          "type": "string",
          "description": "Third party provider identifier",
          "example": "google"
        }
      },
      {
        "in": "query",
        "name": "redirectURIOnProviderDashboard",
        "required": true,
        "schema": {
          "type": "string",
          "description": "URL to redirect to after authentication",
          "example": "https://yourdomain.com/callback"
        }
      },
      {
        "in": "query",
        "name": "clientType",
        "required": false,
        "schema": {
          "type": "string",
          "description": "Type of client making the request",
          "example": "web"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get the OAuth authorisation URL",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status",
                    "url"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "urlWithQueryParams": {
                      "type": "string",
                      "example": "https://providerdomain.com/authorize?client_id=..&scope=..&access_type=.."
                    },
                    "pkceCodeVerifier": {
                      "type": "string",
                      "example": "abcd1234"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "ThirdParty Recipe"
    ],
    "operationId": "signInUp",
    "summary": "Sign in/up with third party",
    "description": "Signin/up a user\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The third party recipe ID",
        "example": "thirdparty",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "required": [
                  "thirdPartyId",
                  "redirectURIInfo"
                ],
                "properties": {
                  "thirdPartyId": {
                    "type": "string",
                    "description": "Third party provider identifier",
                    "example": "google"
                  },
                  "clientType": {
                    "type": "string",
                    "description": "Type of client making the request",
                    "example": "web"
                  },
                  "redirectURIInfo": {
                    "type": "object",
                    "required": [
                      "redirectURIOnProviderDashboard",
                      "redirectURIQueryParams"
                    ],
                    "properties": {
                      "redirectURIOnProviderDashboard": {
                        "type": "string",
                        "description": "URL to redirect to after authentication",
                        "example": "https://yourdomain.com/callback"
                      },
                      "redirectURIQueryParams": {
                        "type": "object",
                        "example": {
                          "code": "neqmpdsfuqe141m5lk437867masdf",
                          "state": "ljayfgqewertbh13245njw0"
                        }
                      },
                      "pkceCodeVerifier": {
                        "type": "string",
                        "example": "abcd1234"
                      }
                    }
                  },
                  "shouldTryLinkingWithSessionUser": {
                    "type": "boolean",
                    "example": false
                  }
                }
              },
              {
                "type": "object",
                "required": [
                  "thirdPartyId",
                  "oAuthTokens"
                ],
                "properties": {
                  "thirdPartyId": {
                    "type": "string",
                    "description": "Third party provider identifier",
                    "example": "google"
                  },
                  "clientType": {
                    "type": "string",
                    "description": "Type of client making the request",
                    "example": "web"
                  },
                  "oAuthTokens": {
                    "type": "object",
                    "description": "OAuth tokens",
                    "properties": {
                      "access_token": {
                        "type": "string",
                        "description": "OAuth access token",
                        "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                      },
                      "id_token": {
                        "type": "string",
                        "description": "OAuth ID token",
                        "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                      }
                    }
                  },
                  "shouldTryLinkingWithSessionUser": {
                    "type": "boolean",
                    "example": false
                  }
                }
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Signin/up a user",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "description": "Sign in/up response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "createdNewRecipeUser": {
                      "type": "boolean",
                      "description": "Whether a new recipe user was created",
                      "example": true
                    }
                  }
                },
                {
                  "description": "Sign in/up error response",
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "description": "Error status",
                          "enum": [
                            "NO_EMAIL_GIVEN_BY_PROVIDER"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "description": "Error status",
                          "enum": [
                            "SIGN_IN_UP_NOT_ALLOWED"
                          ]
                        },
                        "reason": {
                          "type": "string",
                          "description": "Reason why sign in/up is not allowed",
                          "example": "Cannot sign in / up due to security reasons. Please contact support. (IS_SIGN_IN_ALLOWED_FALSE)"
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "A claim validation error happened during factor setup",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-ev"
                          },
                          "reason": {
                            "type": "object",
                            "description": "The reason for the validation error",
                            "example": {
                              "message": "wrong value",
                              "expectedValue": true,
                              "actualValue": false
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message",
                      "example": "invalid claim"
                    },
                    "claimValidationErrors": {
                      "type": "array",
                      "description": "List of claim validation errors",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The claim ID",
                            "example": "st-mfa"
                          },
                          "reason": {
                            "type": "string",
                            "description": "The reason for the validation error",
                            "example": "Completed factors in the session does not satisfy the MFA requirements for auth"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "ThirdParty Recipe"
    ],
    "operationId": "thirdPartyCallbackApple",
    "summary": "Handle Apple sign in",
    "description": "Handles sign in with the apple.\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/x-www-form-urlencoded": {
          "schema": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The Authorization code which will be exchanged for an access token"
              },
              "state": {
                "type": "string",
                "description": "A unique string used to mitigate CSRF attacks"
              }
            }
          }
        }
      }
    },
    "responses": {
      "303": {
        "description": "Redirects the user to the client's app."
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnEmailExists",
    "summary": "Check WebAuthn email exists",
    "description": "Check if a WebAuthn email exists\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "email",
        "in": "query",
        "description": "The email address to check",
        "required": true,
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Email existence check response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "exists": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnRegisterCredential",
    "summary": "Register WebAuthn credential",
    "description": "Register a new WebAuthn credential for an existing user\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "anti-csrf",
        "in": "header",
        "description": "This will only be here if enabled by the user.",
        "schema": {
          "type": "string",
          "description": "A security token used for authentication",
          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
        }
      }
    ],
    "security": [
      {
        "AccessTokenBearer": []
      },
      {
        "AccessTokenCookie": []
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "webauthnGeneratedOptionsId",
              "credential"
            ],
            "properties": {
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "opt_123..."
              },
              "credential": {
                "type": "object",
                "description": "WebAuthn registration payload",
                "required": [
                  "id",
                  "rawId",
                  "response",
                  "type"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Credential ID",
                    "example": "cred_123..."
                  },
                  "rawId": {
                    "type": "string",
                    "description": "Raw credential ID",
                    "example": "base64rawid..."
                  },
                  "authenticatorAttachment": {
                    "type": "string",
                    "description": "Type of authenticator",
                    "enum": [
                      "platform",
                      "cross-platform"
                    ]
                  },
                  "clientExtensionResults": {
                    "type": "object",
                    "description": "Client extension results",
                    "additionalProperties": true
                  },
                  "response": {
                    "type": "object",
                    "description": "Registration response",
                    "required": [
                      "clientDataJSON",
                      "attestationObject"
                    ],
                    "properties": {
                      "clientDataJSON": {
                        "type": "string",
                        "description": "Client data JSON",
                        "example": "base64clientdata..."
                      },
                      "attestationObject": {
                        "type": "string",
                        "description": "Attestation object",
                        "example": "base64attestation..."
                      },
                      "authenticatorData": {
                        "type": "string",
                        "description": "Authenticator data",
                        "example": "base64authenticatordata..."
                      },
                      "transports": {
                        "type": "array",
                        "description": "Supported transports",
                        "items": {
                          "type": "string",
                          "enum": [
                            "usb",
                            "nfc",
                            "ble",
                            "internal",
                            "smart-card",
                            "cable",
                            "hybrid"
                          ]
                        }
                      },
                      "publicKey": {
                        "type": "string",
                        "description": "Public key",
                        "example": "base64publickey..."
                      },
                      "publicKeyAlgorithm": {
                        "type": "number",
                        "description": "Public key algorithm",
                        "example": -7
                      }
                    }
                  },
                  "type": {
                    "type": "string",
                    "description": "Credential type",
                    "enum": [
                      "public-key"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Credential registration response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_CREDENTIALS_ERROR",
                        "OPTIONS_NOT_FOUND_ERROR",
                        "INVALID_OPTIONS_ERROR",
                        "INVALID_AUTHENTICATOR_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "REGISTER_CREDENTIAL_NOT_ALLOWED",
                        "INVALID_AUTHENTICATOR_ERRORp"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "example": "Register credential not allowed"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnRecoverAccount",
    "summary": "Recover WebAuthn account",
    "description": "Recover a WebAuthn account\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "token",
              "webauthnGeneratedOptionsId",
              "credential"
            ],
            "properties": {
              "token": {
                "type": "string",
                "example": "abc123..."
              },
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "opt_123..."
              },
              "credential": {
                "type": "object",
                "description": "WebAuthn registration payload",
                "required": [
                  "id",
                  "rawId",
                  "response",
                  "type"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Credential ID",
                    "example": "cred_123..."
                  },
                  "rawId": {
                    "type": "string",
                    "description": "Raw credential ID",
                    "example": "base64rawid..."
                  },
                  "authenticatorAttachment": {
                    "type": "string",
                    "description": "Type of authenticator",
                    "enum": [
                      "platform",
                      "cross-platform"
                    ]
                  },
                  "clientExtensionResults": {
                    "type": "object",
                    "description": "Client extension results",
                    "additionalProperties": true
                  },
                  "response": {
                    "type": "object",
                    "description": "Registration response",
                    "required": [
                      "clientDataJSON",
                      "attestationObject"
                    ],
                    "properties": {
                      "clientDataJSON": {
                        "type": "string",
                        "description": "Client data JSON",
                        "example": "base64clientdata..."
                      },
                      "attestationObject": {
                        "type": "string",
                        "description": "Attestation object",
                        "example": "base64attestation..."
                      },
                      "authenticatorData": {
                        "type": "string",
                        "description": "Authenticator data",
                        "example": "base64authenticatordata..."
                      },
                      "transports": {
                        "type": "array",
                        "description": "Supported transports",
                        "items": {
                          "type": "string",
                          "enum": [
                            "usb",
                            "nfc",
                            "ble",
                            "internal",
                            "smart-card",
                            "cable",
                            "hybrid"
                          ]
                        }
                      },
                      "publicKey": {
                        "type": "string",
                        "description": "Public key",
                        "example": "base64publickey..."
                      },
                      "publicKeyAlgorithm": {
                        "type": "number",
                        "description": "Public key algorithm",
                        "example": -7
                      }
                    }
                  },
                  "type": {
                    "type": "string",
                    "description": "Credential type",
                    "enum": [
                      "public-key"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Account recovery response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "email": {
                      "type": "string",
                      "description": "Email address",
                      "example": "johndoe@gmail.com"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_CREDENTIALS_ERROR",
                        "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR",
                        "OPTIONS_NOT_FOUND_ERROR",
                        "INVALID_OPTIONS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_AUTHENTICATOR_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "example": "Invalid authenticator"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnGenerateRecoverAccountToken",
    "summary": "Generate WebAuthn recovery token",
    "description": "Generate a recovery token for a WebAuthn account\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "email"
            ],
            "properties": {
              "email": {
                "type": "string",
                "description": "Email address",
                "example": "johndoe@gmail.com"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Recovery token generation response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RECOVER_ACCOUNT_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "example": "Recover account not allowed"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnRegisterOptions",
    "summary": "Get WebAuthn registration options",
    "description": "Get WebAuthn registration options for a user\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "required": [
                  "email"
                ],
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Email address",
                    "example": "johndoe@gmail.com"
                  },
                  "displayName": {
                    "type": "string",
                    "example": "John Doe"
                  }
                }
              },
              {
                "type": "object",
                "required": [
                  "recoverAccountToken"
                ],
                "properties": {
                  "recoverAccountToken": {
                    "type": "string",
                    "example": "abc123..."
                  }
                }
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "WebAuthn registration options",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnGeneratedOptionsId": {
                      "type": "string",
                      "example": "opt_123..."
                    },
                    "createdAt": {
                      "type": "string",
                      "example": "2024-03-20T10:00:00Z"
                    },
                    "expiresAt": {
                      "type": "string",
                      "example": "2024-03-20T10:05:00Z"
                    },
                    "rp": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "example.com"
                        },
                        "name": {
                          "type": "string",
                          "example": "Example Site"
                        }
                      }
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "user_123..."
                        },
                        "name": {
                          "type": "string",
                          "example": "john@example.com"
                        },
                        "displayName": {
                          "type": "string",
                          "example": "John Doe"
                        }
                      }
                    },
                    "challenge": {
                      "type": "string",
                      "example": "base64challenge..."
                    },
                    "timeout": {
                      "type": "number",
                      "example": 300000
                    },
                    "excludeCredentials": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "public-key"
                            ]
                          },
                          "transports": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "enum": [
                                "ble",
                                "hybrid",
                                "internal",
                                "nfc",
                                "usb"
                              ]
                            }
                          }
                        }
                      }
                    },
                    "attestation": {
                      "type": "string",
                      "enum": [
                        "none",
                        "indirect",
                        "direct",
                        "enterprise"
                      ]
                    },
                    "pubKeyCredParams": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "alg": {
                            "type": "number",
                            "example": -7
                          },
                          "type": {
                            "type": "string",
                            "example": "public-key"
                          }
                        }
                      }
                    },
                    "authenticatorSelection": {
                      "type": "object",
                      "properties": {
                        "requireResidentKey": {
                          "type": "boolean"
                        },
                        "residentKey": {
                          "type": "string",
                          "enum": [
                            "required",
                            "preferred",
                            "discouraged"
                          ]
                        },
                        "userVerification": {
                          "type": "string",
                          "enum": [
                            "required",
                            "preferred",
                            "discouraged"
                          ]
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR",
                        "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    },
                    "err": {
                      "type": "string",
                      "example": "Invalid email"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnSignIn",
    "summary": "Sign in with WebAuthn",
    "description": "Sign in a user with WebAuthn\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "webauthnGeneratedOptionsId",
              "credential"
            ],
            "properties": {
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "opt_123..."
              },
              "credential": {
                "type": "object",
                "description": "WebAuthn authentication payload",
                "required": [
                  "id",
                  "rawId",
                  "response",
                  "type"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Credential ID",
                    "example": "cred_123..."
                  },
                  "rawId": {
                    "type": "string",
                    "description": "Raw credential ID",
                    "example": "base64rawid..."
                  },
                  "authenticatorAttachment": {
                    "type": "string",
                    "description": "Type of authenticator",
                    "enum": [
                      "platform",
                      "cross-platform"
                    ]
                  },
                  "clientExtensionResults": {
                    "type": "object",
                    "description": "Client extension results",
                    "additionalProperties": true
                  },
                  "response": {
                    "type": "object",
                    "description": "Authentication response",
                    "required": [
                      "clientDataJSON",
                      "authenticatorData",
                      "signature"
                    ],
                    "properties": {
                      "clientDataJSON": {
                        "type": "string",
                        "description": "Client data JSON",
                        "example": "base64clientdata..."
                      },
                      "authenticatorData": {
                        "type": "string",
                        "description": "Authenticator data",
                        "example": "base64authenticatordata..."
                      },
                      "signature": {
                        "type": "string",
                        "description": "Authentication signature",
                        "example": "base64signature..."
                      },
                      "userHandle": {
                        "type": "string",
                        "description": "User handle",
                        "example": "base64userhandle..."
                      }
                    }
                  },
                  "type": {
                    "type": "string",
                    "description": "Credential type",
                    "enum": [
                      "public-key"
                    ]
                  }
                }
              },
              "shouldTryLinkingWithSessionUser": {
                "type": "boolean",
                "example": true
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Sign in response",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_CREDENTIALS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "SIGN_IN_NOT_ALLOWED"
                      ]
                    },
                    "reason": {
                      "type": "string",
                      "example": "Sign in not allowed"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnSignInOptions",
    "summary": "Get WebAuthn sign in options",
    "description": "Get WebAuthn sign in options\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "WebAuthn sign in options",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnGeneratedOptionsId": {
                      "type": "string",
                      "example": "opt_123..."
                    },
                    "createdAt": {
                      "type": "string",
                      "example": "2024-03-20T10:00:00Z"
                    },
                    "expiresAt": {
                      "type": "string",
                      "example": "2024-03-20T10:05:00Z"
                    },
                    "rpId": {
                      "type": "string",
                      "example": "example.com"
                    },
                    "challenge": {
                      "type": "string",
                      "example": "base64challenge..."
                    },
                    "timeout": {
                      "type": "number",
                      "example": 300000
                    },
                    "userVerification": {
                      "type": "string",
                      "enum": [
                        "required",
                        "preferred",
                        "discouraged"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "WebAuthn Recipe"
    ],
    "operationId": "webauthnSignUp",
    "summary": "Sign up with WebAuthn",
    "description": "Sign up a user with WebAuthn\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The WebAuthn recipe ID",
        "example": "webauthn",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "webauthnGeneratedOptionsId",
              "credential"
            ],
            "properties": {
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "opt_123..."
              },
              "credential": {
                "type": "object",
                "description": "WebAuthn registration payload",
                "required": [
                  "id",
                  "rawId",
                  "response",
                  "type"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Credential ID",
                    "example": "cred_123..."
                  },
                  "rawId": {
                    "type": "string",
                    "description": "Raw credential ID",
                    "example": "base64rawid..."
                  },
                  "authenticatorAttachment": {
                    "type": "string",
                    "description": "Type of authenticator",
                    "enum": [
                      "platform",
                      "cross-platform"
                    ]
                  },
                  "clientExtensionResults": {
                    "type": "object",
                    "description": "Client extension results",
                    "additionalProperties": true
                  },
                  "response": {
                    "type": "object",
                    "description": "Registration response",
                    "required": [
                      "clientDataJSON",
                      "attestationObject"
                    ],
                    "properties": {
                      "clientDataJSON": {
                        "type": "string",
                        "description": "Client data JSON",
                        "example": "base64clientdata..."
                      },
                      "attestationObject": {
                        "type": "string",
                        "description": "Attestation object",
                        "example": "base64attestation..."
                      },
                      "authenticatorData": {
                        "type": "string",
                        "description": "Authenticator data",
                        "example": "base64authenticatordata..."
                      },
                      "transports": {
                        "type": "array",
                        "description": "Supported transports",
                        "items": {
                          "type": "string",
                          "enum": [
                            "usb",
                            "nfc",
                            "ble",
                            "internal",
                            "smart-card",
                            "cable",
                            "hybrid"
                          ]
                        }
                      },
                      "publicKey": {
                        "type": "string",
                        "description": "Public key",
                        "example": "base64publickey..."
                      },
                      "publicKeyAlgorithm": {
                        "type": "number",
                        "description": "Public key algorithm",
                        "example": -7
                      }
                    }
                  },
                  "type": {
                    "type": "string",
                    "description": "Credential type",
                    "enum": [
                      "public-key"
                    ]
                  }
                }
              },
              "shouldTryLinkingWithSessionUser": {
                "type": "boolean",
                "example": true
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Sign up response",
        "headers": {
          "Set-Cookie": {
            "description": "In cookie-based sessions",
            "schema": {
              "type": "string",
              "example": "sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax; sRefreshToken=K91cQ7ezMbu...cb61c3.V2; Path=/auth/session/refresh; Expires=Thu, 30 Sep 2021 06:43:07 GMT; HttpOnly; SameSite=Lax"
            }
          },
          "st-access-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "st-refresh-token": {
            "description": "In header-based sessions",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "anti-csrf": {
            "description": "If enabled by the user",
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "front-token": {
            "schema": {
              "type": "string",
              "description": "A security token used for authentication",
              "example": "ZTRiOTBjNz...jI5MTZlODkxw"
            }
          },
          "Access-Control-Expose-Headers": {
            "schema": {
              "type": "string",
              "example": "anti-csrf, front-token, st-access-token, st-refresh-token"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "description": "User information",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for a user",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "timeJoined": {
                          "type": "number",
                          "description": "Timestamp when user joined",
                          "example": 1638433545183
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "description": "Whether this is the primary user account",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "description": "List of tenant IDs the user belongs to",
                          "items": {
                            "type": "string",
                            "example": "public"
                          }
                        },
                        "emails": {
                          "type": "array",
                          "description": "List of user's email addresses",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "description": "List of user's phone numbers",
                          "items": {
                            "type": "string",
                            "example": 36201234123
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "description": "List of third party accounts",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Third party provider ID",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "description": "User ID in the third party system",
                                "example": "rq238mrq2389rvq123213"
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "description": "List of login methods available to the user",
                          "items": {
                            "type": "object",
                            "properties": {
                              "recipeId": {
                                "type": "string",
                                "description": "The recipe ID for this login method",
                                "enum": [
                                  "emailpassword",
                                  "thirdparty",
                                  "passwordless"
                                ]
                              },
                              "recipeUserId": {
                                "type": "string",
                                "description": "Unique identifier for a user",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "description": "Whether this login method is verified",
                                "example": true
                              },
                              "tenantIds": {
                                "type": "array",
                                "description": "List of tenant IDs for this login method",
                                "items": {
                                  "type": "string",
                                  "example": "public"
                                }
                              },
                              "timeJoined": {
                                "type": "number",
                                "description": "Timestamp when this login method was added",
                                "example": 1638433545183
                              },
                              "email": {
                                "type": "string",
                                "description": "Email address for this login method",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "description": "Phone number for this login method",
                                "example": 36201234123
                              },
                              "thirdParty": {
                                "type": "object",
                                "description": "Third party information for this login method",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider ID",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "description": "User ID in the third party system",
                                    "example": "rq238mrq2389rvq123213"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_CREDENTIALS_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Multitenancy Recipe"
    ],
    "operationId": "loginmethods",
    "summary": "Get enabled login methods",
    "description": "Get enabled login methods: Returns recipes with their enabled setting and recipe specific configuration.\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      },
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "description": "The multitenancy recipe ID",
        "example": "multitenancy",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "clientType",
        "required": false,
        "schema": {
          "type": "string",
          "description": "Type of client making the request",
          "example": "web"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get enabled login methods",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status",
                    "recipes"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Success status indicator",
                      "enum": [
                        "OK"
                      ]
                    },
                    "recipes": {
                      "type": "object",
                      "required": [
                        "emailPassword",
                        "thirdParty",
                        "passwordless",
                        "firstFactors"
                      ],
                      "properties": {
                        "emailPassword": {
                          "type": "object",
                          "required": [
                            "enabled"
                          ],
                          "properties": {
                            "enabled": {
                              "type": "boolean",
                              "example": true
                            }
                          }
                        },
                        "thirdParty": {
                          "type": "object",
                          "required": [
                            "enabled",
                            "providers"
                          ],
                          "properties": {
                            "enabled": {
                              "type": "boolean",
                              "example": true
                            },
                            "providers": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "required": [
                                  "id"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Third party provider identifier",
                                    "example": "google"
                                  },
                                  "name": {
                                    "type": "string",
                                    "example": "Google"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "passwordless": {
                          "type": "object",
                          "required": [
                            "enabled"
                          ],
                          "properties": {
                            "enabled": {
                              "type": "boolean",
                              "example": true
                            }
                          }
                        },
                        "firstFactors": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "JWT Recipe"
    ],
    "operationId": "getJWKS",
    "summary": "Get JWT keys",
    "description": "Get all JSON web keys for JWT verification\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Retrieve JWKs for JWT verification",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "keys": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "description": "A JWK that can be used to verify a JWT",
                        "properties": {
                          "alg": {
                            "type": "string",
                            "description": "The algorithm to use when creating the JWT.",
                            "enum": [
                              "RS256"
                            ]
                          },
                          "kty": {
                            "type": "string",
                            "example": "RSA"
                          },
                          "use": {
                            "type": "string",
                            "example": "sig"
                          },
                          "kid": {
                            "type": "string",
                            "description": "Unique identifier for the JWK"
                          },
                          "n": {
                            "type": "string",
                            "description": "Modulus for the key"
                          },
                          "e": {
                            "type": "string",
                            "description": "Exponent for the key"
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "Bad request error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Bad request error message",
              "enum": [
                "Bad request"
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "OpenId Recipe"
    ],
    "operationId": "getOpenIdDiscoveryConfiguration",
    "summary": "Get OpenID config",
    "description": "Get OpenID discovery configuration\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Retrieve OpenID configuration",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "issuer": {
                      "type": "string",
                      "description": "URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier (https://openid.net/specs/openid-connect-discovery-1_0.html section 3)",
                      "example": "https://api.example.com/auth"
                    },
                    "jwks_uri": {
                      "type": "string",
                      "description": "URL for fetching a list JsonWebKey, used for JWT signature verification. Refer to /jwt/jwks.json API in the JWT recipe for JWK details",
                      "example": "https://api.example.com/auth/jwt/jwks.json"
                    },
                    "authorization_endpoint": {
                      "type": "string",
                      "description": "URL of the authorization endpoint",
                      "example": "https://api.example.com/auth/oauth/authorize"
                    },
                    "token_endpoint": {
                      "type": "string",
                      "description": "URL of the token endpoint",
                      "example": "https://api.example.com/auth/oauth/token"
                    },
                    "userinfo_endpoint": {
                      "type": "string",
                      "description": "URL of the userinfo endpoint",
                      "example": "https://api.example.com/auth/oauth/userinfo"
                    },
                    "revocation_endpoint": {
                      "type": "string",
                      "description": "URL of the token revocation endpoint",
                      "example": "https://api.example.com/auth/oauth/revoke"
                    },
                    "token_introspection_endpoint": {
                      "type": "string",
                      "description": "URL of the token introspection endpoint",
                      "example": "https://api.example.com/auth/oauth/introspect"
                    },
                    "end_session_endpoint": {
                      "type": "string",
                      "description": "URL of the end session endpoint",
                      "example": "https://api.example.com/auth/oauth/end_session"
                    },
                    "subject_types_supported": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "public"
                        ]
                      }
                    },
                    "id_token_signing_alg_values_supported": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "RS256"
                        ]
                      }
                    },
                    "response_types_supported": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "code",
                          "id_token",
                          "id_token token"
                        ]
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "Generic error response",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Error status code",
                      "enum": [
                        "GENERAL_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "Bad request error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Bad request error message",
              "enum": [
                "Bad request"
              ]
            }
          }
        }
      },
      "404": {
        "description": "Resource not found error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Not found error message",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "Internal server error",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "description": "Internal server error message",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "App API"
    ],
    "operationId": "exampleAppAPI",
    "summary": "Test authentication",
    "description": "Use this endpoint to check if your request are authenticated properly.\n",
    "parameters": [
      {
        "name": "apiBasePath",
        "in": "path",
        "description": "Its value depends on the apiBasePath set by the user",
        "required": true,
        "schema": {
          "type": "string",
          "example": "auth"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The session passed verification and went through the application code"
      },
      "401": {
        "description": "The session doesn't exists or if it needs to be refreshed",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "unauthorised or try refresh token",
                  "example": "try refresh token"
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "The session exists, but didn't pass a claim validator",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "example": "invalid claim"
                },
                "claimValidationErrors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "example": "st-ev"
                      },
                      "reason": {
                        "type": "object",
                        "example": {
                          "message": "value does not exist",
                          "expectedValue": "val",
                          "actualValue": "claimVal"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

# References - Core Driver Interface -  Core Driver Interface
Source: https://supertokens.com/docs/references/cdi/introduction

## Overview

The **CDI**, Core Driver Interface, is the API exposed by the **SuperTokens Core** service.
It is meant to be consumed only by your backend only.

:::info no-title
In most cases, you don't need to directly interact with the API, since the existing [backend SDKS](/docs/references/backend-sdks/reference) are built on top of it.
:::

### URL Structure

Most of the endpoints take in two path parameters: `appid-{appId}` and `{tenantId}`.
Both are optional.
If not set, the default app and tenant will be used.

Given the following endpoint: `/appid-{appId}/{tenantId}/recipe/totp/device/verify`:
- You can call it without the actual path parameters, using `/recipe/totp/device/verify` in your action. 
- You can set both values and end up with a path that looks like this: `/appid-myApp/myTenant/recipe/totp/device/verify`.

### Versioning

At the moment, the documentation pages only show the latest version of the API.
If you want to check an older release, please access the [Swagger page](https://app.swaggerhub.com/apis/supertokens/CDI)

To know which version you should see:
1. Check the version of the core you are running (for managed service, visit the dashboard, else run `supertokens --version` command)
2. Go to the [**SuperTokens Core** GitHub page](https://github.com/supertokens/supertokens-core)
3. Switch to the branch that matches the version of the core your running
4. Open the file called `coreDriverInterfaceSupported.json`
5. In there, you see an array of `X.Y` values, pick the latest one, and see the API spec for that.

## Authentication

The API uses JWT tokens for authentication.
In order for the core service to accept a request you need to set the `api-key` header with the value of your token.

If you are using the managed service, the token can be accessed from [the dashboard](https://supertokens.com/dashboard-saas).
In the context of a self-hosted instance, keys are not created by default.
You have to explicitly [generate them](/docs/platform-configuration/supertokens-core/api-keys).

{
  "get": {
    "tags": [
      "Account Linking Recipe"
    ],
    "operationId": "canLinkAccounts",
    "summary": "Check account linking possibility",
    "description": "Check if accounts can be linked for given primary and recipe user id\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "accountlinking",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "primaryUserId",
        "schema": {
          "type": "string",
          "description": "The primary user ID to check",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        },
        "required": true
      },
      {
        "in": "query",
        "name": "recipeUserId",
        "schema": {
          "type": "string",
          "description": "The recipe user ID to check",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "Indicates success with the status prop",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Account Linking Check Success",
                  "description": "Response when accounts can be linked",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "accountsAlreadyLinked": {
                      "type": "boolean",
                      "description": "Indicates if accounts are already linked",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Account Info Already Associated Error",
                  "description": "Response when account info is already associated with another primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user that already has this account info",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Recipe User Already Linked Error",
                  "description": "Response when recipe user is already linked with another primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user this recipe user is already linked to",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Not Primary User Error",
                  "description": "Response when input user is not a primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INPUT_USER_IS_NOT_A_PRIMARY_USER"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Account Linking Recipe"
    ],
    "operationId": "canCreatePrimaryUser",
    "summary": "Check primary user creation possibility",
    "description": "Check if primary user can be created for given user id\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "accountlinking",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "recipeUserId",
        "schema": {
          "type": "string",
          "description": "The recipe user ID to check",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "Indicates success with the status and canCreatePrimaryUser properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Primary User Check Success",
                  "description": "Response when user can be created as primary",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "wasAlreadyAPrimaryUser": {
                      "type": "boolean",
                      "description": "Indicates if the user was already a primary user",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Account Info Already Associated Error",
                  "description": "Response when account info is already associated with another primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user that already has this account info",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Recipe User Already Linked Error",
                  "description": "Response when recipe user is already linked with a primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user this recipe user is already linked to",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Account Linking Recipe"
    ],
    "operationId": "linkAccounts",
    "summary": "Link user accounts together",
    "description": "Link accounts for given primary and recipe user id\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "accountlinking",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "primaryUserId": {
                "type": "string",
                "description": "The primary user ID to link with",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              },
              "recipeUserId": {
                "type": "string",
                "description": "The recipe user ID to link",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              }
            },
            "required": [
              "primaryUserId",
              "recipeUserId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status and accountsAlreadyLinked properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Account Linking Success",
                  "description": "Response when accounts are linked successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "accountsAlreadyLinked": {
                      "type": "boolean",
                      "description": "Indicates if accounts were already linked",
                      "example": true
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Account Info Already Associated Error",
                  "description": "Response when account info is already associated with another primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user that already has this account info",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Recipe User Already Linked Error",
                  "description": "Response when recipe user is already linked with another primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user this recipe user is already linked to",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Not Primary User Error",
                  "description": "Response when input user is not a primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INPUT_USER_IS_NOT_A_PRIMARY_USER"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Account Linking Recipe"
    ],
    "operationId": "createPrimaryUser",
    "summary": "Create primary user account",
    "description": "Create a primary user for given user id\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "accountlinking",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "recipeUserId": {
                "type": "string",
                "description": "The recipe user ID to create as primary user",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              }
            },
            "required": [
              "recipeUserId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status and primaryUserId properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Primary User Creation Success",
                  "description": "Response when primary user is created successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "wasAlreadyAPrimaryUser": {
                      "type": "boolean",
                      "description": "Indicates if the user was already a primary user",
                      "example": true
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Account Info Already Associated Error",
                  "description": "Response when account info is already associated with another primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user that already has this account info",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Recipe User Already Linked Error",
                  "description": "Response when recipe user is already linked with a primary user",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR"
                      ]
                    },
                    "primaryUserId": {
                      "type": "string",
                      "description": "The ID of the primary user this recipe user is already linked to",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "description": {
                      "type": "string",
                      "description": "Error description"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Account Linking Recipe"
    ],
    "operationId": "unlinkAccounts",
    "summary": "Unlink user accounts",
    "description": "Unlink accounts for given recipe user id\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "accountlinking",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "recipeUserId": {
                "type": "string",
                "description": "The recipe user ID to unlink",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              }
            },
            "required": [
              "recipeUserId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status and accountsUnlinked properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Account Unlinking Success",
                  "description": "Response when accounts are unlinked successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "wasRecipeUserDeleted": {
                      "type": "boolean",
                      "description": "Indicates if the recipe user was deleted",
                      "example": true
                    },
                    "wasLinked": {
                      "type": "boolean",
                      "description": "Indicates if the accounts were linked",
                      "example": true
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List bulk import users",
    "tags": [
      "Bulk Import"
    ],
    "operationId": "getBulkImportUsers",
    "description": "Paginated API to get bulk import users\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "paginationToken",
        "in": "query",
        "example": "ZmE3YTA4NDEtY...MjM5MTgwMzIyMzE=",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "limit",
        "in": "query",
        "example": 1,
        "schema": {
          "type": "number"
        }
      },
      {
        "$ref": "#/components/parameters/bulkImportUserStatus"
      }
    ],
    "responses": {
      "200": {
        "description": "Paginated Bulk Import Users",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "array",
                  "items": {
                    "properties": {
                      "id": {
                        "type": "string",
                        "example": "fa7a0841-b533-4478-9253-0fde890c576"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "NEW",
                          "PROCESSING",
                          "FAILED"
                        ]
                      },
                      "createdAt": {
                        "type": "number",
                        "example": 1623918032231
                      },
                      "updatedAt": {
                        "type": "number",
                        "example": 1623918032231
                      }
                    },
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "externalUserId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "userMetadata": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "description": "should be a JSON object (not a JSON literal nor an array)",
                              "example": {
                                "preferences": {
                                  "theme": "dark"
                                },
                                "notifications": {
                                  "email": true
                                },
                                "todos": [
                                  "example"
                                ]
                              }
                            }
                          },
                          "userRoles": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "role": {
                                  "type": "string",
                                  "example": "admin"
                                },
                                "tenantIds": {
                                  "type": "array",
                                  "items": {
                                    "type": "string",
                                    "example": "customer1"
                                  }
                                }
                              },
                              "required": [
                                "role",
                                "tenantIds"
                              ]
                            }
                          },
                          "totpDevices": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "secretKey": {
                                  "type": "string",
                                  "example": "2PRXZWZAYYDAWCD"
                                },
                                "skew": {
                                  "type": "number",
                                  "example": 0
                                },
                                "period": {
                                  "type": "number",
                                  "example": 30
                                },
                                "deviceName": {
                                  "type": "string",
                                  "example": "My Authy App"
                                }
                              },
                              "required": [
                                "secretKey"
                              ]
                            }
                          },
                          "loginMethods": {
                            "type": "array",
                            "items": {
                              "anyOf": [
                                {
                                  "name": "Email/Password Login Method",
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "tenantIds": {
                                          "type": "array",
                                          "description": "List of tenant IDs this login method is associated with",
                                          "items": {
                                            "type": "string",
                                            "example": "customer1"
                                          }
                                        },
                                        "isVerified": {
                                          "type": "boolean",
                                          "description": "Indicates whether the email is verified"
                                        },
                                        "isPrimary": {
                                          "type": "boolean",
                                          "description": "Indicates whether the login method is the primary login method"
                                        },
                                        "timeJoinedInMSSinceEpoch": {
                                          "type": "integer",
                                          "description": "Time joined in milliseconds since the epoch"
                                        }
                                      }
                                    },
                                    {
                                      "type": "object",
                                      "properties": {
                                        "recipeId": {
                                          "type": "string",
                                          "example": "emailpassword"
                                        },
                                        "email": {
                                          "type": "string",
                                          "example": "johndoe@gmail.com"
                                        },
                                        "passwordHash": {
                                          "type": "string",
                                          "example": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw"
                                        },
                                        "plainTextPassword": {
                                          "type": "string",
                                          "example": "passwordExample"
                                        },
                                        "hashingAlgorithm": {
                                          "type": "string",
                                          "enum": [
                                            "argon2",
                                            "bcrypt",
                                            "firebase_scrypt"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "email",
                                        "passwordHash",
                                        "hashingAlgorithm"
                                      ]
                                    }
                                  ]
                                },
                                {
                                  "name": "Third Party Login Method",
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "tenantIds": {
                                          "type": "array",
                                          "description": "List of tenant IDs this login method is associated with",
                                          "items": {
                                            "type": "string",
                                            "example": "customer1"
                                          }
                                        },
                                        "isVerified": {
                                          "type": "boolean",
                                          "description": "Indicates whether the email is verified"
                                        },
                                        "isPrimary": {
                                          "type": "boolean",
                                          "description": "Indicates whether the login method is the primary login method"
                                        },
                                        "timeJoinedInMSSinceEpoch": {
                                          "type": "integer",
                                          "description": "Time joined in milliseconds since the epoch"
                                        }
                                      }
                                    },
                                    {
                                      "type": "object",
                                      "properties": {
                                        "recipeId": {
                                          "type": "string",
                                          "example": "thirdparty"
                                        },
                                        "thirdPartyId": {
                                          "type": "string",
                                          "example": "google"
                                        },
                                        "thirdPartyUserId": {
                                          "type": "string",
                                          "example": 106347997792363870000
                                        }
                                      },
                                      "required": [
                                        "thirdPartyId",
                                        "thirdPartyUserId"
                                      ]
                                    }
                                  ]
                                },
                                {
                                  "name": "Passwordless Login Method",
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "tenantIds": {
                                          "type": "array",
                                          "description": "List of tenant IDs this login method is associated with",
                                          "items": {
                                            "type": "string",
                                            "example": "customer1"
                                          }
                                        },
                                        "isVerified": {
                                          "type": "boolean",
                                          "description": "Indicates whether the email is verified"
                                        },
                                        "isPrimary": {
                                          "type": "boolean",
                                          "description": "Indicates whether the login method is the primary login method"
                                        },
                                        "timeJoinedInMSSinceEpoch": {
                                          "type": "integer",
                                          "description": "Time joined in milliseconds since the epoch"
                                        }
                                      }
                                    },
                                    {
                                      "type": "object",
                                      "properties": {
                                        "recipeId": {
                                          "type": "string",
                                          "example": "passwordless"
                                        }
                                      }
                                    }
                                  ],
                                  "oneOf": [
                                    {
                                      "type": "string",
                                      "example": "johndoe@gmail.com"
                                    },
                                    {
                                      "type": "string",
                                      "example": "+14155552671"
                                    }
                                  ]
                                }
                              ]
                            }
                          }
                        }
                      },
                      {
                        "type": "object"
                      }
                    ]
                  }
                },
                "nextPaginationToken": {
                  "type": "string",
                  "example": "ZmE3YTA4ND...OzE2MjM5MTgwMzIyMzE="
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "summary": "Add bulk import users",
    "tags": [
      "Bulk Import"
    ],
    "operationId": "addBulkImportUsers",
    "description": "Add users for bulk import. Maximum 10000 users can be added in one request.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "users": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "externalUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "userMetadata": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "description": "should be a JSON object (not a JSON literal nor an array)",
                        "example": {
                          "preferences": {
                            "theme": "dark"
                          },
                          "notifications": {
                            "email": true
                          },
                          "todos": [
                            "example"
                          ]
                        }
                      }
                    },
                    "userRoles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "role": {
                            "type": "string",
                            "example": "admin"
                          },
                          "tenantIds": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          }
                        },
                        "required": [
                          "role",
                          "tenantIds"
                        ]
                      }
                    },
                    "totpDevices": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "secretKey": {
                            "type": "string",
                            "example": "2PRXZWZAYYDAWCD"
                          },
                          "skew": {
                            "type": "number",
                            "example": 0
                          },
                          "period": {
                            "type": "number",
                            "example": 30
                          },
                          "deviceName": {
                            "type": "string",
                            "example": "My Authy App"
                          }
                        },
                        "required": [
                          "secretKey"
                        ]
                      }
                    },
                    "loginMethods": {
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "name": "Email/Password Login Method",
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "tenantIds": {
                                    "type": "array",
                                    "description": "List of tenant IDs this login method is associated with",
                                    "items": {
                                      "type": "string",
                                      "example": "customer1"
                                    }
                                  },
                                  "isVerified": {
                                    "type": "boolean",
                                    "description": "Indicates whether the email is verified"
                                  },
                                  "isPrimary": {
                                    "type": "boolean",
                                    "description": "Indicates whether the login method is the primary login method"
                                  },
                                  "timeJoinedInMSSinceEpoch": {
                                    "type": "integer",
                                    "description": "Time joined in milliseconds since the epoch"
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "recipeId": {
                                    "type": "string",
                                    "example": "emailpassword"
                                  },
                                  "email": {
                                    "type": "string",
                                    "example": "johndoe@gmail.com"
                                  },
                                  "passwordHash": {
                                    "type": "string",
                                    "example": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw"
                                  },
                                  "plainTextPassword": {
                                    "type": "string",
                                    "example": "passwordExample"
                                  },
                                  "hashingAlgorithm": {
                                    "type": "string",
                                    "enum": [
                                      "argon2",
                                      "bcrypt",
                                      "firebase_scrypt"
                                    ]
                                  }
                                },
                                "required": [
                                  "email",
                                  "passwordHash",
                                  "hashingAlgorithm"
                                ]
                              }
                            ]
                          },
                          {
                            "name": "Third Party Login Method",
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "tenantIds": {
                                    "type": "array",
                                    "description": "List of tenant IDs this login method is associated with",
                                    "items": {
                                      "type": "string",
                                      "example": "customer1"
                                    }
                                  },
                                  "isVerified": {
                                    "type": "boolean",
                                    "description": "Indicates whether the email is verified"
                                  },
                                  "isPrimary": {
                                    "type": "boolean",
                                    "description": "Indicates whether the login method is the primary login method"
                                  },
                                  "timeJoinedInMSSinceEpoch": {
                                    "type": "integer",
                                    "description": "Time joined in milliseconds since the epoch"
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "recipeId": {
                                    "type": "string",
                                    "example": "thirdparty"
                                  },
                                  "thirdPartyId": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "thirdPartyUserId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                },
                                "required": [
                                  "thirdPartyId",
                                  "thirdPartyUserId"
                                ]
                              }
                            ]
                          },
                          {
                            "name": "Passwordless Login Method",
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "tenantIds": {
                                    "type": "array",
                                    "description": "List of tenant IDs this login method is associated with",
                                    "items": {
                                      "type": "string",
                                      "example": "customer1"
                                    }
                                  },
                                  "isVerified": {
                                    "type": "boolean",
                                    "description": "Indicates whether the email is verified"
                                  },
                                  "isPrimary": {
                                    "type": "boolean",
                                    "description": "Indicates whether the login method is the primary login method"
                                  },
                                  "timeJoinedInMSSinceEpoch": {
                                    "type": "integer",
                                    "description": "Time joined in milliseconds since the epoch"
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "recipeId": {
                                    "type": "string",
                                    "example": "passwordless"
                                  }
                                }
                              }
                            ],
                            "oneOf": [
                              {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              {
                                "type": "string",
                                "example": "+14155552671"
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            },
            "required": [
              "users"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Bulk Import Users added successfully",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "object",
                  "properties": {
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "loginMethods": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "recipeId": {
                            "type": "string",
                            "example": "emailpassword"
                          },
                          "userId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "tenants": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          },
                          "email": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          },
                          "thirdpartyId": {
                            "type": "string",
                            "example": "google"
                          },
                          "thirdpartyUserId": {
                            "type": "string",
                            "example": 106347997792363870000
                          },
                          "phoneNumber": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "required": [
                          "recipeId",
                          "userId",
                          "tenants",
                          "email"
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "One or more users have invalid schema",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Data has missing or invalid fields. Please check the users field for more details."
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "index": {
                        "type": "number",
                        "example": 0,
                        "description": "Index of the user in the users array that has invalid schema"
                      },
                      "errors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "description": "List of errors for the user",
                          "example": "Invalid recipeId for loginMethod. Pass one of emailpassword, thirdparty or, passwordless!"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Bulk Import"
    ],
    "operationId": "countBulkImportUsers",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "summary": "Count bulk import users",
    "description": "Count users in the bulk import processing queue, by status or all of them (by passing `null` status).\n",
    "parameters": [
      {
        "$ref": "#/components/parameters/api-key"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "$ref": "#/components/parameters/bulkImportUserStatus"
      }
    ],
    "responses": {
      "200": {
        "description": "The number of users in the bulk import processing queue by status",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "count": {
                  "type": "number",
                  "description": "The number of users in the bulk import processing queue by status",
                  "example": 10
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List bulk import users",
    "tags": [
      "Bulk Import"
    ],
    "operationId": "getBulkImportUsers",
    "description": "Paginated API to get bulk import users\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "paginationToken",
        "in": "query",
        "example": "ZmE3YTA4NDEtY...MjM5MTgwMzIyMzE=",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "limit",
        "in": "query",
        "example": 1,
        "schema": {
          "type": "number"
        }
      },
      {
        "$ref": "#/components/parameters/bulkImportUserStatus"
      }
    ],
    "responses": {
      "200": {
        "description": "Paginated Bulk Import Users",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "array",
                  "items": {
                    "properties": {
                      "id": {
                        "type": "string",
                        "example": "fa7a0841-b533-4478-9253-0fde890c576"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "NEW",
                          "PROCESSING",
                          "FAILED"
                        ]
                      },
                      "createdAt": {
                        "type": "number",
                        "example": 1623918032231
                      },
                      "updatedAt": {
                        "type": "number",
                        "example": 1623918032231
                      }
                    },
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "externalUserId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "userMetadata": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "description": "should be a JSON object (not a JSON literal nor an array)",
                              "example": {
                                "preferences": {
                                  "theme": "dark"
                                },
                                "notifications": {
                                  "email": true
                                },
                                "todos": [
                                  "example"
                                ]
                              }
                            }
                          },
                          "userRoles": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "role": {
                                  "type": "string",
                                  "example": "admin"
                                },
                                "tenantIds": {
                                  "type": "array",
                                  "items": {
                                    "type": "string",
                                    "example": "customer1"
                                  }
                                }
                              },
                              "required": [
                                "role",
                                "tenantIds"
                              ]
                            }
                          },
                          "totpDevices": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "secretKey": {
                                  "type": "string",
                                  "example": "2PRXZWZAYYDAWCD"
                                },
                                "skew": {
                                  "type": "number",
                                  "example": 0
                                },
                                "period": {
                                  "type": "number",
                                  "example": 30
                                },
                                "deviceName": {
                                  "type": "string",
                                  "example": "My Authy App"
                                }
                              },
                              "required": [
                                "secretKey"
                              ]
                            }
                          },
                          "loginMethods": {
                            "type": "array",
                            "items": {
                              "anyOf": [
                                {
                                  "name": "Email/Password Login Method",
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "tenantIds": {
                                          "type": "array",
                                          "description": "List of tenant IDs this login method is associated with",
                                          "items": {
                                            "type": "string",
                                            "example": "customer1"
                                          }
                                        },
                                        "isVerified": {
                                          "type": "boolean",
                                          "description": "Indicates whether the email is verified"
                                        },
                                        "isPrimary": {
                                          "type": "boolean",
                                          "description": "Indicates whether the login method is the primary login method"
                                        },
                                        "timeJoinedInMSSinceEpoch": {
                                          "type": "integer",
                                          "description": "Time joined in milliseconds since the epoch"
                                        }
                                      }
                                    },
                                    {
                                      "type": "object",
                                      "properties": {
                                        "recipeId": {
                                          "type": "string",
                                          "example": "emailpassword"
                                        },
                                        "email": {
                                          "type": "string",
                                          "example": "johndoe@gmail.com"
                                        },
                                        "passwordHash": {
                                          "type": "string",
                                          "example": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw"
                                        },
                                        "plainTextPassword": {
                                          "type": "string",
                                          "example": "passwordExample"
                                        },
                                        "hashingAlgorithm": {
                                          "type": "string",
                                          "enum": [
                                            "argon2",
                                            "bcrypt",
                                            "firebase_scrypt"
                                          ]
                                        }
                                      },
                                      "required": [
                                        "email",
                                        "passwordHash",
                                        "hashingAlgorithm"
                                      ]
                                    }
                                  ]
                                },
                                {
                                  "name": "Third Party Login Method",
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "tenantIds": {
                                          "type": "array",
                                          "description": "List of tenant IDs this login method is associated with",
                                          "items": {
                                            "type": "string",
                                            "example": "customer1"
                                          }
                                        },
                                        "isVerified": {
                                          "type": "boolean",
                                          "description": "Indicates whether the email is verified"
                                        },
                                        "isPrimary": {
                                          "type": "boolean",
                                          "description": "Indicates whether the login method is the primary login method"
                                        },
                                        "timeJoinedInMSSinceEpoch": {
                                          "type": "integer",
                                          "description": "Time joined in milliseconds since the epoch"
                                        }
                                      }
                                    },
                                    {
                                      "type": "object",
                                      "properties": {
                                        "recipeId": {
                                          "type": "string",
                                          "example": "thirdparty"
                                        },
                                        "thirdPartyId": {
                                          "type": "string",
                                          "example": "google"
                                        },
                                        "thirdPartyUserId": {
                                          "type": "string",
                                          "example": 106347997792363870000
                                        }
                                      },
                                      "required": [
                                        "thirdPartyId",
                                        "thirdPartyUserId"
                                      ]
                                    }
                                  ]
                                },
                                {
                                  "name": "Passwordless Login Method",
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "tenantIds": {
                                          "type": "array",
                                          "description": "List of tenant IDs this login method is associated with",
                                          "items": {
                                            "type": "string",
                                            "example": "customer1"
                                          }
                                        },
                                        "isVerified": {
                                          "type": "boolean",
                                          "description": "Indicates whether the email is verified"
                                        },
                                        "isPrimary": {
                                          "type": "boolean",
                                          "description": "Indicates whether the login method is the primary login method"
                                        },
                                        "timeJoinedInMSSinceEpoch": {
                                          "type": "integer",
                                          "description": "Time joined in milliseconds since the epoch"
                                        }
                                      }
                                    },
                                    {
                                      "type": "object",
                                      "properties": {
                                        "recipeId": {
                                          "type": "string",
                                          "example": "passwordless"
                                        }
                                      }
                                    }
                                  ],
                                  "oneOf": [
                                    {
                                      "type": "string",
                                      "example": "johndoe@gmail.com"
                                    },
                                    {
                                      "type": "string",
                                      "example": "+14155552671"
                                    }
                                  ]
                                }
                              ]
                            }
                          }
                        }
                      },
                      {
                        "type": "object"
                      }
                    ]
                  }
                },
                "nextPaginationToken": {
                  "type": "string",
                  "example": "ZmE3YTA4ND...OzE2MjM5MTgwMzIyMzE="
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "summary": "Add bulk import users",
    "tags": [
      "Bulk Import"
    ],
    "operationId": "addBulkImportUsers",
    "description": "Add users for bulk import. Maximum 10000 users can be added in one request.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "users": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "externalUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "userMetadata": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "description": "should be a JSON object (not a JSON literal nor an array)",
                        "example": {
                          "preferences": {
                            "theme": "dark"
                          },
                          "notifications": {
                            "email": true
                          },
                          "todos": [
                            "example"
                          ]
                        }
                      }
                    },
                    "userRoles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "role": {
                            "type": "string",
                            "example": "admin"
                          },
                          "tenantIds": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          }
                        },
                        "required": [
                          "role",
                          "tenantIds"
                        ]
                      }
                    },
                    "totpDevices": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "secretKey": {
                            "type": "string",
                            "example": "2PRXZWZAYYDAWCD"
                          },
                          "skew": {
                            "type": "number",
                            "example": 0
                          },
                          "period": {
                            "type": "number",
                            "example": 30
                          },
                          "deviceName": {
                            "type": "string",
                            "example": "My Authy App"
                          }
                        },
                        "required": [
                          "secretKey"
                        ]
                      }
                    },
                    "loginMethods": {
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "name": "Email/Password Login Method",
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "tenantIds": {
                                    "type": "array",
                                    "description": "List of tenant IDs this login method is associated with",
                                    "items": {
                                      "type": "string",
                                      "example": "customer1"
                                    }
                                  },
                                  "isVerified": {
                                    "type": "boolean",
                                    "description": "Indicates whether the email is verified"
                                  },
                                  "isPrimary": {
                                    "type": "boolean",
                                    "description": "Indicates whether the login method is the primary login method"
                                  },
                                  "timeJoinedInMSSinceEpoch": {
                                    "type": "integer",
                                    "description": "Time joined in milliseconds since the epoch"
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "recipeId": {
                                    "type": "string",
                                    "example": "emailpassword"
                                  },
                                  "email": {
                                    "type": "string",
                                    "example": "johndoe@gmail.com"
                                  },
                                  "passwordHash": {
                                    "type": "string",
                                    "example": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw"
                                  },
                                  "plainTextPassword": {
                                    "type": "string",
                                    "example": "passwordExample"
                                  },
                                  "hashingAlgorithm": {
                                    "type": "string",
                                    "enum": [
                                      "argon2",
                                      "bcrypt",
                                      "firebase_scrypt"
                                    ]
                                  }
                                },
                                "required": [
                                  "email",
                                  "passwordHash",
                                  "hashingAlgorithm"
                                ]
                              }
                            ]
                          },
                          {
                            "name": "Third Party Login Method",
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "tenantIds": {
                                    "type": "array",
                                    "description": "List of tenant IDs this login method is associated with",
                                    "items": {
                                      "type": "string",
                                      "example": "customer1"
                                    }
                                  },
                                  "isVerified": {
                                    "type": "boolean",
                                    "description": "Indicates whether the email is verified"
                                  },
                                  "isPrimary": {
                                    "type": "boolean",
                                    "description": "Indicates whether the login method is the primary login method"
                                  },
                                  "timeJoinedInMSSinceEpoch": {
                                    "type": "integer",
                                    "description": "Time joined in milliseconds since the epoch"
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "recipeId": {
                                    "type": "string",
                                    "example": "thirdparty"
                                  },
                                  "thirdPartyId": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "thirdPartyUserId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                },
                                "required": [
                                  "thirdPartyId",
                                  "thirdPartyUserId"
                                ]
                              }
                            ]
                          },
                          {
                            "name": "Passwordless Login Method",
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "tenantIds": {
                                    "type": "array",
                                    "description": "List of tenant IDs this login method is associated with",
                                    "items": {
                                      "type": "string",
                                      "example": "customer1"
                                    }
                                  },
                                  "isVerified": {
                                    "type": "boolean",
                                    "description": "Indicates whether the email is verified"
                                  },
                                  "isPrimary": {
                                    "type": "boolean",
                                    "description": "Indicates whether the login method is the primary login method"
                                  },
                                  "timeJoinedInMSSinceEpoch": {
                                    "type": "integer",
                                    "description": "Time joined in milliseconds since the epoch"
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "recipeId": {
                                    "type": "string",
                                    "example": "passwordless"
                                  }
                                }
                              }
                            ],
                            "oneOf": [
                              {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              {
                                "type": "string",
                                "example": "+14155552671"
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            },
            "required": [
              "users"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Bulk Import Users added successfully",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "object",
                  "properties": {
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "loginMethods": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "recipeId": {
                            "type": "string",
                            "example": "emailpassword"
                          },
                          "userId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "tenants": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          },
                          "email": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          },
                          "thirdpartyId": {
                            "type": "string",
                            "example": "google"
                          },
                          "thirdpartyUserId": {
                            "type": "string",
                            "example": 106347997792363870000
                          },
                          "phoneNumber": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "required": [
                          "recipeId",
                          "userId",
                          "tenants",
                          "email"
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "One or more users have invalid schema",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Data has missing or invalid fields. Please check the users field for more details."
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "index": {
                        "type": "number",
                        "example": 0,
                        "description": "Index of the user in the users array that has invalid schema"
                      },
                      "errors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "description": "List of errors for the user",
                          "example": "Invalid recipeId for loginMethod. Pass one of emailpassword, thirdparty or, passwordless!"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Delete bulk import users",
    "tags": [
      "Bulk Import"
    ],
    "operationId": "deleteBulkImportUsers",
    "description": "Delete bulk import users by id. Multiple ids can be passed in the request body.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "ids": {
                "type": "array",
                "description": "List of bulk import user ids to be deleted",
                "items": {
                  "type": "string",
                  "example": "fa7a0841-b533-4478-9253-0fde890c576"
                }
              }
            },
            "required": [
              "ids"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Bulk Import Users deleted successfully",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "deletedIds": {
                  "type": "array",
                  "description": "List of ids that were successfully deleted",
                  "items": {
                    "type": "string",
                    "example": "fa7a0841-b533-4478-9253-0fde890c576"
                  }
                },
                "invalidIds": {
                  "type": "array",
                  "description": "List of ids that were invalid",
                  "items": {
                    "type": "string",
                    "example": "fa7a0841-b533-4478-9253-0fde890c576"
                  },
                  "example": []
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Bulk Import"
    ],
    "operationId": "importOneUserWithBulkImport",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "summary": "Import one user directly",
    "description": "Import one user immediately with the Bulk Import functionality.\n",
    "parameters": [
      {
        "$ref": "#/components/parameters/api-key"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "externalUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "userMetadata": {
                "type": "array",
                "items": {
                  "type": "object",
                  "description": "should be a JSON object (not a JSON literal nor an array)",
                  "example": {
                    "preferences": {
                      "theme": "dark"
                    },
                    "notifications": {
                      "email": true
                    },
                    "todos": [
                      "example"
                    ]
                  }
                }
              },
              "userRoles": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "role": {
                      "type": "string",
                      "example": "admin"
                    },
                    "tenantIds": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "customer1"
                      }
                    }
                  },
                  "required": [
                    "role",
                    "tenantIds"
                  ]
                }
              },
              "totpDevices": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "secretKey": {
                      "type": "string",
                      "example": "2PRXZWZAYYDAWCD"
                    },
                    "skew": {
                      "type": "number",
                      "example": 0
                    },
                    "period": {
                      "type": "number",
                      "example": 30
                    },
                    "deviceName": {
                      "type": "string",
                      "example": "My Authy App"
                    }
                  },
                  "required": [
                    "secretKey"
                  ]
                }
              },
              "loginMethods": {
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "name": "Email/Password Login Method",
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "tenantIds": {
                              "type": "array",
                              "description": "List of tenant IDs this login method is associated with",
                              "items": {
                                "type": "string",
                                "example": "customer1"
                              }
                            },
                            "isVerified": {
                              "type": "boolean",
                              "description": "Indicates whether the email is verified"
                            },
                            "isPrimary": {
                              "type": "boolean",
                              "description": "Indicates whether the login method is the primary login method"
                            },
                            "timeJoinedInMSSinceEpoch": {
                              "type": "integer",
                              "description": "Time joined in milliseconds since the epoch"
                            }
                          }
                        },
                        {
                          "type": "object",
                          "properties": {
                            "recipeId": {
                              "type": "string",
                              "example": "emailpassword"
                            },
                            "email": {
                              "type": "string",
                              "example": "johndoe@gmail.com"
                            },
                            "passwordHash": {
                              "type": "string",
                              "example": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw"
                            },
                            "plainTextPassword": {
                              "type": "string",
                              "example": "passwordExample"
                            },
                            "hashingAlgorithm": {
                              "type": "string",
                              "enum": [
                                "argon2",
                                "bcrypt",
                                "firebase_scrypt"
                              ]
                            }
                          },
                          "required": [
                            "email",
                            "passwordHash",
                            "hashingAlgorithm"
                          ]
                        }
                      ]
                    },
                    {
                      "name": "Third Party Login Method",
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "tenantIds": {
                              "type": "array",
                              "description": "List of tenant IDs this login method is associated with",
                              "items": {
                                "type": "string",
                                "example": "customer1"
                              }
                            },
                            "isVerified": {
                              "type": "boolean",
                              "description": "Indicates whether the email is verified"
                            },
                            "isPrimary": {
                              "type": "boolean",
                              "description": "Indicates whether the login method is the primary login method"
                            },
                            "timeJoinedInMSSinceEpoch": {
                              "type": "integer",
                              "description": "Time joined in milliseconds since the epoch"
                            }
                          }
                        },
                        {
                          "type": "object",
                          "properties": {
                            "recipeId": {
                              "type": "string",
                              "example": "thirdparty"
                            },
                            "thirdPartyId": {
                              "type": "string",
                              "example": "google"
                            },
                            "thirdPartyUserId": {
                              "type": "string",
                              "example": 106347997792363870000
                            }
                          },
                          "required": [
                            "thirdPartyId",
                            "thirdPartyUserId"
                          ]
                        }
                      ]
                    },
                    {
                      "name": "Passwordless Login Method",
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "tenantIds": {
                              "type": "array",
                              "description": "List of tenant IDs this login method is associated with",
                              "items": {
                                "type": "string",
                                "example": "customer1"
                              }
                            },
                            "isVerified": {
                              "type": "boolean",
                              "description": "Indicates whether the email is verified"
                            },
                            "isPrimary": {
                              "type": "boolean",
                              "description": "Indicates whether the login method is the primary login method"
                            },
                            "timeJoinedInMSSinceEpoch": {
                              "type": "integer",
                              "description": "Time joined in milliseconds since the epoch"
                            }
                          }
                        },
                        {
                          "type": "object",
                          "properties": {
                            "recipeId": {
                              "type": "string",
                              "example": "passwordless"
                            }
                          }
                        }
                      ],
                      "oneOf": [
                        {
                          "type": "string",
                          "example": "johndoe@gmail.com"
                        },
                        {
                          "type": "string",
                          "example": "+14155552671"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "User added successfully",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "user": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "isPrimaryUser": {
                      "type": "boolean",
                      "example": true
                    },
                    "tenantIds": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "customer1"
                      }
                    },
                    "timeJoined": {
                      "type": "number",
                      "example": 1623918032231
                    },
                    "emails": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "johndoe@gmail.com"
                      }
                    },
                    "phoneNumbers": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "+14155552671"
                      }
                    },
                    "thirdParty": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "google"
                          },
                          "userId": {
                            "type": "string",
                            "example": 106347997792363870000
                          }
                        }
                      }
                    },
                    "loginMethods": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "tenantIds": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          },
                          "recipeUserId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "verified": {
                            "type": "boolean",
                            "example": true
                          },
                          "timeJoined": {
                            "type": "number",
                            "example": 1623918032231
                          },
                          "recipeId": {
                            "type": "string",
                            "enum": [
                              "emailpassword",
                              "passwordless",
                              "thirdparty"
                            ]
                          },
                          "email": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          },
                          "phoneNumber": {
                            "type": "string",
                            "example": "+14155552671"
                          },
                          "thirdParty": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "User has invalid schema",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Data has missing or invalid fields. Please check the users field for more details."
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "index": {
                        "type": "number",
                        "example": 0,
                        "description": "Index of the user in the users array that has invalid schema"
                      },
                      "errors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "description": "List of errors for the user",
                          "example": "Invalid recipeId for loginMethod. Pass one of emailpassword, thirdparty or, passwordless!"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getHelloOnRootPath",
    "summary": "Get hello message on root path",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getHello",
    "summary": "Get hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "putHello",
    "summary": "Put hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "tags": [
      "Core"
    ],
    "operationId": "postHello",
    "summary": "Post hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteHello",
    "summary": "Delete hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getUsers",
    "summary": "Get users",
    "description": "Get users.\n\nAPI is tenant specific if `includeAllTenants` is false.\nElse, `tenantId` is ignored.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "includeRecipeIds",
        "in": "query",
        "required": false,
        "description": "The param should take an array of comma seperated strings",
        "schema": {
          "type": "string",
          "example": "val1,val2,val3.."
        }
      },
      {
        "name": "paginationToken",
        "in": "query",
        "example": "ZmE3YTA4NDEtY...MjM5MTgwMzIyMzE=",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "limit",
        "in": "query",
        "example": 1,
        "schema": {
          "type": "number"
        }
      },
      {
        "name": "timeJoinedOrder",
        "in": "query",
        "schema": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      },
      {
        "in": "query",
        "name": "email",
        "schema": {
          "type": "string",
          "example": "test@example.com"
        },
        "required": false
      },
      {
        "in": "query",
        "name": "phone",
        "schema": {
          "type": "number",
          "example": 911234567890
        },
        "required": false
      },
      {
        "in": "query",
        "name": "recipe",
        "schema": {
          "type": "string",
          "example": "emailpassword"
        },
        "required": false
      },
      {
        "in": "query",
        "name": "provider",
        "schema": {
          "type": "string",
          "example": "google"
        },
        "required": false
      }
    ],
    "responses": {
      "200": {
        "description": "User Pagination",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "user": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "isPrimaryUser": {
                            "type": "boolean",
                            "example": true
                          },
                          "tenantIds": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          },
                          "timeJoined": {
                            "type": "number",
                            "example": 1623918032231
                          },
                          "emails": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "johndoe@gmail.com"
                            }
                          },
                          "phoneNumbers": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "+14155552671"
                            }
                          },
                          "thirdParty": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "example": "google"
                                },
                                "userId": {
                                  "type": "string",
                                  "example": 106347997792363870000
                                }
                              }
                            }
                          },
                          "loginMethods": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "tenantIds": {
                                  "type": "array",
                                  "items": {
                                    "type": "string",
                                    "example": "customer1"
                                  }
                                },
                                "recipeUserId": {
                                  "type": "string",
                                  "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                                },
                                "verified": {
                                  "type": "boolean",
                                  "example": true
                                },
                                "timeJoined": {
                                  "type": "number",
                                  "example": 1623918032231
                                },
                                "recipeId": {
                                  "type": "string",
                                  "enum": [
                                    "emailpassword",
                                    "passwordless",
                                    "thirdparty"
                                  ]
                                },
                                "email": {
                                  "type": "string",
                                  "example": "johndoe@gmail.com"
                                },
                                "phoneNumber": {
                                  "type": "string",
                                  "example": "+14155552671"
                                },
                                "thirdParty": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "example": "google"
                                    },
                                    "userId": {
                                      "type": "string",
                                      "example": 106347997792363870000
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "nextPaginationToken": {
                  "type": "string",
                  "example": "ZmE3YTA4ND...OzE2MjM5MTgwMzIyMzE="
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getUsersByAccountInfo",
    "summary": "Get users by account info",
    "description": "Get users by email, phoneNumber or thirdParty info\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "required": false,
        "schema": {
          "type": "string",
          "example": "test@example.com"
        }
      },
      {
        "in": "query",
        "name": "phoneNumber",
        "required": false,
        "schema": {
          "type": "string",
          "example": "+911234567890"
        }
      },
      {
        "in": "query",
        "name": "thirdPartyId",
        "required": false,
        "schema": {
          "type": "string",
          "example": "google"
        }
      },
      {
        "in": "query",
        "name": "thirdPartyUserId",
        "required": false,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      },
      {
        "in": "query",
        "name": "doUnionOfAccountInfo",
        "required": true,
        "schema": {
          "type": "boolean",
          "example": true
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                      },
                      "isPrimaryUser": {
                        "type": "boolean",
                        "example": true
                      },
                      "tenantIds": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "customer1"
                        }
                      },
                      "timeJoined": {
                        "type": "number",
                        "example": 1623918032231
                      },
                      "emails": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "johndoe@gmail.com"
                        }
                      },
                      "phoneNumbers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "+14155552671"
                        }
                      },
                      "thirdParty": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "example": "google"
                            },
                            "userId": {
                              "type": "string",
                              "example": 106347997792363870000
                            }
                          }
                        }
                      },
                      "loginMethods": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "tenantIds": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "customer1"
                              }
                            },
                            "recipeUserId": {
                              "type": "string",
                              "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                            },
                            "verified": {
                              "type": "boolean",
                              "example": true
                            },
                            "timeJoined": {
                              "type": "number",
                              "example": 1623918032231
                            },
                            "recipeId": {
                              "type": "string",
                              "enum": [
                                "emailpassword",
                                "passwordless",
                                "thirdparty"
                              ]
                            },
                            "email": {
                              "type": "string",
                              "example": "johndoe@gmail.com"
                            },
                            "phoneNumber": {
                              "type": "string",
                              "example": "+14155552671"
                            },
                            "thirdParty": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "example": "google"
                                },
                                "userId": {
                                  "type": "string",
                                  "example": 106347997792363870000
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getUsersCount",
    "summary": "Get users count",
    "description": "Get number of users.\n\nAPI is tenant specific if `includeAllTenants` is false.\nElse, `tenantId` is ignored.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "includeRecipeIds",
        "in": "query",
        "required": false,
        "description": "The param should take an array of comma seperated strings",
        "schema": {
          "type": "string",
          "example": "val1,val2,val3.."
        }
      },
      {
        "name": "includeAllTenants",
        "description": "if set to true, will count users across all tenants in the app",
        "in": "query",
        "schema": {
          "type": "boolean",
          "default": false
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get number of users",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "count": {
                  "type": "number",
                  "example": 1000000
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getApiVersion",
    "summary": "Get API version",
    "description": "Get a list of compatible CDI versions\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "in": "query",
        "name": "websiteDomain",
        "schema": {
          "type": "string",
          "example": "https://example.com"
        },
        "required": false
      },
      {
        "in": "query",
        "name": "apiDomain",
        "schema": {
          "type": "string",
          "example": "https://api.example.com"
        },
        "required": false
      }
    ],
    "responses": {
      "200": {
        "description": "get api version",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "versions": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": [
                      "2.13"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getFeatureFlag",
    "summary": "Get enterprise features",
    "description": "Get a list of the enabled enterprise features\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "features": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "example": [
                    "feature_1",
                    "feature_2"
                  ]
                },
                "usageStats": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "setLicense",
    "summary": "Set license key",
    "description": "Set or sync license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "licenseKey": {
                "type": "string",
                "example": "eyJhbGciOiJIUzI1NiIsIn..."
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "MISSING_EE_FOLDER_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_LICENSE_KEY_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteLicense",
    "summary": "Delete license key",
    "description": "Delete license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getLicense",
    "summary": "Get license key",
    "description": "Retrieve license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "licenseKey": {
                      "type": "string",
                      "example": "eyJhbGciOiJIUzI1NiIsIn..."
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "NO_LICENSE_KEY_FOUND_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "UserIdMapping Recipe"
    ],
    "operationId": "userIdMappingCreateMapping",
    "summary": "Create user ID mapping",
    "description": "Create a mapping between a SuperTokens userId and an external userId.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "useridmapping",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "superTokensUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "externalUserId": {
                "type": "string",
                "description": "The external user ID to map to",
                "example": "externalId"
              },
              "externalUserIdInfo": {
                "type": "string",
                "description": "Additional information about the external user ID",
                "example": "Info about external userId"
              },
              "force": {
                "type": "boolean",
                "description": "Whether to force create the mapping even if it exists"
              }
            },
            "required": [
              "superTokensUserId",
              "externalUserId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_SUPERTOKENS_USER_ID_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "USER_ID_MAPPING_ALREADY_EXISTS_ERROR"
                      ]
                    },
                    "doesSuperTokensUserIdExist": {
                      "type": "boolean"
                    },
                    "doesExternalUserIdExist": {
                      "type": "boolean"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "UserIdMapping Recipe"
    ],
    "operationId": "userIdMappingGetMapping",
    "summary": "Get user ID mapping",
    "description": "Retrieve a UserIdMapping\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "useridmapping",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "description": "The user ID to get mapping for"
        },
        "required": true
      },
      {
        "in": "query",
        "name": "userIdType",
        "schema": {
          "type": "string",
          "description": "Type of user ID to search for",
          "enum": [
            "SUPERTOKENS",
            "EXTERNAL",
            "ANY"
          ]
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Retrives a userId mapping",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "User ID Mapping Found",
                  "description": "Response containing the user ID mapping",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "superTokensUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "externalUserId": {
                      "type": "string",
                      "description": "The external user ID",
                      "example": "externalId"
                    },
                    "externalUserIdInfo": {
                      "type": "string",
                      "description": "Additional information about the external user ID",
                      "example": "Info about external userId"
                    }
                  },
                  "required": [
                    "status",
                    "superTokensUserId",
                    "externalUserId"
                  ]
                },
                {
                  "type": "object",
                  "title": "Unknown Mapping Error",
                  "description": "Response when user ID mapping is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_MAPPING_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getRequestsStats",
    "summary": "Get requests stats",
    "description": "Get requests stats for last 24 hours\n\n`averageRequestsPerSecond` and `peakRequestsPerSecond` would countain `1440` values corresponding to `now - 1440 minutes` until `now - 1 minute`.\n\nA value of `-1` would mean that there is no data for that minute.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "atMinute": {
                  "type": "number",
                  "example": 16382348
                },
                "averageRequestsPerSecond": {
                  "type": "array",
                  "items": {
                    "type": "number",
                    "example": 10.5
                  }
                },
                "peakRequestsPerSecond": {
                  "type": "array",
                  "items": {
                    "type": "number",
                    "example": 20
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getTelemetry",
    "summary": "Get telemetry ID",
    "description": "Returns the telemetryID if it exists\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Returns the telemetryID if it exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "exists": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "telemetryId": {
                      "type": "string",
                      "example": "99c87c72-1807-22d-9b39-7a88f95re56c"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "exists": {
                      "type": "boolean",
                      "example": [
                        false
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getUserId",
    "summary": "Get user ID",
    "description": "Get user id from email or phone number\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getSearchTags",
    "summary": "Get search tags",
    "description": "Retrieve available tags for search\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Returns available tags for search",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": [
                      "email",
                      "phone",
                      "provider"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getActiveUsersCount",
    "summary": "Get active users count",
    "description": "Get number of active users.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "since",
        "schema": {
          "type": "number",
          "example": 1679875200000
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "Get number of active users",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "count": {
                  "type": "number",
                  "example": 100000
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getConfig",
    "summary": "Get config file path",
    "description": "Get path to the loaded config file\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "pid",
        "schema": {
          "type": "string",
          "example": 21307
        }
      }
    ],
    "responses": {
      "200": {
        "description": "get api version",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "path": {
                      "type": "string",
                      "example": "/usr/lib/supertokens/config.yaml"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "NOT_ALLOWED"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getHello",
    "summary": "Get hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "putHello",
    "summary": "Put hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "tags": [
      "Core"
    ],
    "operationId": "postHello",
    "summary": "Post hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteHello",
    "summary": "Delete hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "UserIdMapping Recipe"
    ],
    "operationId": "userIdMappingCreateMapping",
    "summary": "Create user ID mapping",
    "description": "Create a mapping between a SuperTokens userId and an external userId.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "useridmapping",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "superTokensUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "externalUserId": {
                "type": "string",
                "description": "The external user ID to map to",
                "example": "externalId"
              },
              "externalUserIdInfo": {
                "type": "string",
                "description": "Additional information about the external user ID",
                "example": "Info about external userId"
              },
              "force": {
                "type": "boolean",
                "description": "Whether to force create the mapping even if it exists"
              }
            },
            "required": [
              "superTokensUserId",
              "externalUserId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_SUPERTOKENS_USER_ID_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "USER_ID_MAPPING_ALREADY_EXISTS_ERROR"
                      ]
                    },
                    "doesSuperTokensUserIdExist": {
                      "type": "boolean"
                    },
                    "doesExternalUserIdExist": {
                      "type": "boolean"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "UserIdMapping Recipe"
    ],
    "operationId": "userIdMappingGetMapping",
    "summary": "Get user ID mapping",
    "description": "Retrieve a UserIdMapping\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "useridmapping",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "description": "The user ID to get mapping for"
        },
        "required": true
      },
      {
        "in": "query",
        "name": "userIdType",
        "schema": {
          "type": "string",
          "description": "Type of user ID to search for",
          "enum": [
            "SUPERTOKENS",
            "EXTERNAL",
            "ANY"
          ]
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Retrives a userId mapping",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "User ID Mapping Found",
                  "description": "Response containing the user ID mapping",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "superTokensUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "externalUserId": {
                      "type": "string",
                      "description": "The external user ID",
                      "example": "externalId"
                    },
                    "externalUserIdInfo": {
                      "type": "string",
                      "description": "Additional information about the external user ID",
                      "example": "Info about external userId"
                    }
                  },
                  "required": [
                    "status",
                    "superTokensUserId",
                    "externalUserId"
                  ]
                },
                {
                  "type": "object",
                  "title": "Unknown Mapping Error",
                  "description": "Response when user ID mapping is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_MAPPING_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "UserIdMapping Recipe"
    ],
    "operationId": "userIdMappingRemoveMapping",
    "summary": "Remove user ID mapping",
    "description": "Delete a mapping between a SuperTokens userId and an external userId.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "useridmapping",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "userIdType": {
                "type": "string",
                "description": "Type of user ID to remove mapping for",
                "enum": [
                  "SUPERTOKENS",
                  "EXTERNAL",
                  "ANY"
                ]
              },
              "force": {
                "type": "boolean",
                "description": "Whether to force remove the mapping"
              }
            },
            "required": [
              "userId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "title": "User ID Mapping Removal Success",
              "description": "Response when user ID mapping is removed successfully",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didMappingExist": {
                  "type": "boolean",
                  "description": "Indicates if the mapping existed before removal"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteUser",
    "summary": "Delete user",
    "description": "Delete user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "userId"
            ],
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "removeAllLinkedAccounts": {
                "type": "boolean",
                "example": true
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Returns OK if the operation succeeded (even if the user didn't exist before the call)",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getHello",
    "summary": "Get hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "putHello",
    "summary": "Put hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "tags": [
      "Core"
    ],
    "operationId": "postHello",
    "summary": "Post hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteHello",
    "summary": "Delete hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "setLicense",
    "summary": "Set license key",
    "description": "Set or sync license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "licenseKey": {
                "type": "string",
                "example": "eyJhbGciOiJIUzI1NiIsIn..."
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "MISSING_EE_FOLDER_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_LICENSE_KEY_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteLicense",
    "summary": "Delete license key",
    "description": "Delete license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getLicense",
    "summary": "Get license key",
    "description": "Retrieve license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "licenseKey": {
                      "type": "string",
                      "example": "eyJhbGciOiJIUzI1NiIsIn..."
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "NO_LICENSE_KEY_FOUND_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "UserIdMapping Recipe"
    ],
    "operationId": "userIdMappingUpateExternalUserIdInfo",
    "summary": "Update external user info",
    "description": "Update or delete externalUserIdInfo\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "useridmapping",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "userIdType": {
                "type": "string",
                "description": "Type of user ID to update info for",
                "enum": [
                  "SUPERTOKENS",
                  "EXTERNAL",
                  "ANY"
                ]
              },
              "externalUserIdInfo": {
                "type": "string",
                "description": "New external user ID information",
                "example": "new external userId info",
                "nullable": true
              }
            },
            "required": [
              "userId",
              "externalUserIdInfo"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "External User Info Update Success",
                  "description": "Response when external user info is updated successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Unknown Mapping Error",
                  "description": "Response when user ID mapping is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_MAPPING_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getHello",
    "summary": "Get hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "putHello",
    "summary": "Put hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "tags": [
      "Core"
    ],
    "operationId": "postHello",
    "summary": "Post hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteHello",
    "summary": "Delete hello message",
    "description": "Return a simple hello message\n",
    "responses": {
      "200": {
        "description": "return a simple hello message",
        "content": {
          "application/json": {
            "schema": {
              "type": "string",
              "enum": [
                "Hello"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "Core"
    ],
    "operationId": "setLicense",
    "summary": "Set license key",
    "description": "Set or sync license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "licenseKey": {
                "type": "string",
                "example": "eyJhbGciOiJIUzI1NiIsIn..."
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "MISSING_EE_FOLDER_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_LICENSE_KEY_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Core"
    ],
    "operationId": "deleteLicense",
    "summary": "Delete license key",
    "description": "Delete license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getLicense",
    "summary": "Get license key",
    "description": "Retrieve license key\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "licenseKey": {
                      "type": "string",
                      "example": "eyJhbGciOiJIUzI1NiIsIn..."
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "NO_LICENSE_KEY_FOUND_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Dashboard Recipe"
    ],
    "summary": "Get the core config",
    "description": "Get the core config of the tenant specified by the url prefix, along with the metadata of each of the fields.\n",
    "operationId": "tenantCoreConfigForDashboardGET",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Tenant core config result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "config"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "config": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string",
                        "example": "password_reset_token_lifetime"
                      },
                      "valueType": {
                        "type": "string",
                        "enum": [
                          "string",
                          "number",
                          "boolean"
                        ],
                        "nullable": true,
                        "example": "number"
                      },
                      "value": {
                        "nullable": true,
                        "type": "number",
                        "example": 3600000
                      },
                      "description": {
                        "type": "string",
                        "example": "Time in milliseconds for how long a password reset token / link is valid for. [Default: 3600000 (1 hour)]"
                      },
                      "isDifferentAcrossTenants": {
                        "type": "boolean"
                      },
                      "possibleValues": {
                        "nullable": true,
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "isNullable": {
                        "type": "boolean",
                        "example": false
                      },
                      "defaultValue": {
                        "nullable": true,
                        "type": "number",
                        "example": 3600000
                      },
                      "isPluginProperty": {
                        "type": "boolean",
                        "example": false
                      },
                      "isPluginPropertyEditable": {
                        "type": "boolean",
                        "example": false
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "getAllSessionsForDashboardUser",
    "summary": "Get all sessions for dashboard user",
    "description": "Get a list of the sessions for the dashboard user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "example": "ue1231-f32f290f2-f23r23f-323f2"
        },
        "required": false
      }
    ],
    "responses": {
      "200": {
        "description": "get a list of sessions for dashboard user",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "sessions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "userId": {
                        "type": "string",
                        "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                      },
                      "sessionId": {
                        "type": "string",
                        "example": "fni29f-f23f23-f2fq32qt-h35evf"
                      },
                      "timeCreated": {
                        "type": "number",
                        "example": 16382348324
                      },
                      "expiry": {
                        "type": "number",
                        "example": 16382348324
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "getAllDashboardUsers",
    "summary": "Get all dashboard users",
    "description": "Get a list of call the dashboard users\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "get a list of dashboard users",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "email": {
                        "type": "string",
                        "example": "test@example.com"
                      },
                      "userId": {
                        "type": "string",
                        "example": "uf2323-f223r233-f23-f23-f2f32"
                      },
                      "timeCreated": {
                        "type": "number",
                        "example": 16382348324
                      },
                      "isSuspended": {
                        "type": "boolean",
                        "example": false
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "verifyDashboardUserSession",
    "summary": "Verify dashboard user session",
    "description": "Verify a Dashboard user's sessionId\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "sessionId": {
                "type": "string",
                "example": "rf32f-f32342f-32f-323r2f3-23"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "email": {
                      "type": "string"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "USER_SUSPENDED_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "You have crossed the free dashboard user limit. Please purchase the dashboard feature or login with a valid user account"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVAlID_SESSION_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "signInDashboardUser",
    "summary": "Sign in dashboard user",
    "description": "Signin a Dashboard user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "test@example.com"
              },
              "password": {
                "type": "string",
                "example": "password@123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "sessionId": {
                      "type": "string",
                      "example": null
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "USER_SUSPENDED_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "You have crossed the free dashboard user limit. Please purchase the dashboard feature or login with a valid user account"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVAlID_CREDENTIALS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "createDashboardUser",
    "summary": "Create dashboard user",
    "description": "Create a dashboard user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "test@example.com"
              },
              "password": {
                "type": "string",
                "example": "password@123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "userId": {
                          "type": "string",
                          "example": "example-userid"
                        },
                        "email": {
                          "type": "string",
                          "example": "test@example.com"
                        },
                        "timeCreated": {
                          "type": "number",
                          "example": 1231321231
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "PASSWORD_WEAK_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Your password must have at least 8 characters"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "Indicates ayment required",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "USER_LIMIT_REACHED_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "example": "You have reached the free limit for creating users, please purchase the dashboard feature to create new users"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "updateDashboardUser",
    "summary": "Update dashboard user",
    "description": "Update a user's email or password\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "example": "test@example.com"
                  },
                  "newPassword": {
                    "type": "string",
                    "example": "password@123"
                  },
                  "newEmail": {
                    "type": "string",
                    "example": "test2@example.com"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "example": "ue21r-fw32r3-d121-d1"
                  },
                  "newPassword": {
                    "type": "string",
                    "example": "password@123"
                  },
                  "newEmail": {
                    "type": "string",
                    "example": "test2@example.com"
                  }
                }
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "userId": {
                          "type": "string",
                          "example": "r23r-f235th54-g3413gf-r32dr2"
                        },
                        "email": {
                          "type": "string",
                          "example": "test@example.com"
                        },
                        "timeCreated": {
                          "type": "number",
                          "example": 391238234792
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "PASSWORD_WEAK_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Your password must have at least 8 characters"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "deleteDashboardUser",
    "summary": "Delete dashboard user",
    "description": "Delete a dashboard user with their userId or email\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "schema": {
          "type": "string",
          "example": "test@example.com"
        },
        "required": false
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "example": "ue1231-f32f290f2-f23r23f-323f2"
        },
        "required": false
      }
    ],
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didUserExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "createDashboardUser",
    "summary": "Create dashboard user",
    "description": "Create a dashboard user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "test@example.com"
              },
              "password": {
                "type": "string",
                "example": "password@123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "userId": {
                          "type": "string",
                          "example": "example-userid"
                        },
                        "email": {
                          "type": "string",
                          "example": "test@example.com"
                        },
                        "timeCreated": {
                          "type": "number",
                          "example": 1231321231
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "PASSWORD_WEAK_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Your password must have at least 8 characters"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "Indicates ayment required",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "USER_LIMIT_REACHED_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "example": "You have reached the free limit for creating users, please purchase the dashboard feature to create new users"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "updateDashboardUser",
    "summary": "Update dashboard user",
    "description": "Update a user's email or password\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "example": "test@example.com"
                  },
                  "newPassword": {
                    "type": "string",
                    "example": "password@123"
                  },
                  "newEmail": {
                    "type": "string",
                    "example": "test2@example.com"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "example": "ue21r-fw32r3-d121-d1"
                  },
                  "newPassword": {
                    "type": "string",
                    "example": "password@123"
                  },
                  "newEmail": {
                    "type": "string",
                    "example": "test2@example.com"
                  }
                }
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "userId": {
                          "type": "string",
                          "example": "r23r-f235th54-g3413gf-r32dr2"
                        },
                        "email": {
                          "type": "string",
                          "example": "test@example.com"
                        },
                        "timeCreated": {
                          "type": "number",
                          "example": 391238234792
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "PASSWORD_WEAK_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Your password must have at least 8 characters"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "deleteDashboardUser",
    "summary": "Delete dashboard user",
    "description": "Delete a dashboard user with their userId or email\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "schema": {
          "type": "string",
          "example": "test@example.com"
        },
        "required": false
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "example": "ue1231-f32f290f2-f23r23f-323f2"
        },
        "required": false
      }
    ],
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didUserExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "delete": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "RevokeDashboardUsersSession",
    "summary": "Revoke dashboard user session",
    "description": "Revoke a Dashboard user's session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "sessionId",
        "schema": {
          "type": "string",
          "example": "ue1231-f32f290f2-f23r23f-323f2"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "createDashboardUser",
    "summary": "Create dashboard user",
    "description": "Create a dashboard user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "test@example.com"
              },
              "password": {
                "type": "string",
                "example": "password@123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "userId": {
                          "type": "string",
                          "example": "example-userid"
                        },
                        "email": {
                          "type": "string",
                          "example": "test@example.com"
                        },
                        "timeCreated": {
                          "type": "number",
                          "example": 1231321231
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "PASSWORD_WEAK_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Your password must have at least 8 characters"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "Indicates ayment required",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "USER_LIMIT_REACHED_ERROR"
                  ]
                },
                "message": {
                  "type": "string",
                  "example": "You have reached the free limit for creating users, please purchase the dashboard feature to create new users"
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "updateDashboardUser",
    "summary": "Update dashboard user",
    "description": "Update a user's email or password\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "example": "test@example.com"
                  },
                  "newPassword": {
                    "type": "string",
                    "example": "password@123"
                  },
                  "newEmail": {
                    "type": "string",
                    "example": "test2@example.com"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "example": "ue21r-fw32r3-d121-d1"
                  },
                  "newPassword": {
                    "type": "string",
                    "example": "password@123"
                  },
                  "newEmail": {
                    "type": "string",
                    "example": "test2@example.com"
                  }
                }
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "userId": {
                          "type": "string",
                          "example": "r23r-f235th54-g3413gf-r32dr2"
                        },
                        "email": {
                          "type": "string",
                          "example": "test@example.com"
                        },
                        "timeCreated": {
                          "type": "number",
                          "example": 391238234792
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "PASSWORD_WEAK_ERROR"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Your password must have at least 8 characters"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_EMAIL_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "delete": {
    "tags": [
      "Dashboard Recipe"
    ],
    "operationId": "deleteDashboardUser",
    "summary": "Delete dashboard user",
    "description": "Delete a dashboard user with their userId or email\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "dashboard",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "schema": {
          "type": "string",
          "example": "test@example.com"
        },
        "required": false
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "example": "ue1231-f32f290f2-f23r23f-323f2"
        },
        "required": false
      }
    ],
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didUserExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "emailVerificationVerifyGet",
    "summary": "Check email verification",
    "description": "Check if an email is verified\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "emailverification",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      },
      {
        "name": "email",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Verify an email",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "isVerified": {
                  "type": "boolean",
                  "example": true
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "emailVerificationVerify",
    "summary": "Verify email",
    "description": "Verify an email\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailverification",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string",
                "enum": [
                  "token"
                ]
              },
              "token": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Verify an email",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "email": {
                      "type": "string",
                      "example": "johndoe@gmail.com"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "emailVerificationVerifyToken",
    "summary": "Generate email verification token",
    "description": "Generate a new email verification token for this user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailverification",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Generate a new email verification token for this user",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "token": {
                      "type": "string",
                      "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_VERIFIED_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "emailVerificationVerifyTokenRemove",
    "summary": "Remove email verification tokens",
    "description": "Remove all unused email verification tokens for this user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailverification",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailVerification Recipe"
    ],
    "operationId": "emailVerificationVerifyRemove",
    "summary": "Unverify email",
    "description": "Unverify an email\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "emailverification",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordGetUser",
    "summary": "Get email password user",
    "deprecated": true,
    "description": "Get a user's information\n\nAPI is tenant specific if querying by email.\nIf querying by userId, tenantId will be ignored.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "description": "use either email or userId, not both",
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      },
      {
        "in": "query",
        "name": "userId",
        "description": "use either email or userId, not both",
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "get user's information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR",
                        "UNKNOWN_EMAIL_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordPutUser",
    "summary": "Update user info",
    "description": "Update a user's information\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              },
              "password": {
                "type": "string",
                "example": "password123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "update user's information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "UNKNOWN_USER_ID_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_CHANGE_NOT_ALLOWED_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordSignin",
    "summary": "Sign in user",
    "description": "Signin a user with email ID and password\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              },
              "password": {
                "type": "string",
                "example": "password123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "signin response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "WRONG_CREDENTIALS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordSignup",
    "summary": "Sign up user",
    "description": "Signup a user with email ID and password\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              },
              "password": {
                "type": "string",
                "example": "password123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "signup response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordGetPasswordReset",
    "summary": "Reset user password",
    "deprecated": true,
    "description": "Reset a password using password reset token\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string",
                "enum": [
                  "token"
                ]
              },
              "token": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              },
              "newPassword": {
                "type": "string",
                "example": "newpassword123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Reset a password using password reset token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RESET_PASSWORD_INVALID_TOKEN_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordGetPasswordResetToken",
    "summary": "Generate password reset token",
    "description": "Generate a new reset password token for this user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "userId",
              "email"
            ],
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Generate a new reset password token for this user",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "token": {
                      "type": "string",
                      "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordResetPasswordConsumeToken",
    "summary": "Consume password reset token",
    "description": "Consume a password reset token\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "token": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Consume a password reset token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "email": {
                      "type": "string",
                      "example": "johndoe@gmail.com"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RESET_PASSWORD_INVALID_TOKEN_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "userImport",
    "summary": "Import user with hash",
    "description": "Import a user with email ID and password hash\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              },
              "passwordHash": {
                "type": "string",
                "example": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw"
              },
              "hashingAlgorithm": {
                "type": "string",
                "enum": [
                  "argon2",
                  "bcrypt",
                  "firebase_scrypt"
                ]
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "import user response",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "user": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "isPrimaryUser": {
                      "type": "boolean",
                      "example": true
                    },
                    "tenantIds": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "customer1"
                      }
                    },
                    "timeJoined": {
                      "type": "number",
                      "example": 1623918032231
                    },
                    "emails": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "johndoe@gmail.com"
                      }
                    },
                    "phoneNumbers": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "+14155552671"
                      }
                    },
                    "thirdParty": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "google"
                          },
                          "userId": {
                            "type": "string",
                            "example": 106347997792363870000
                          }
                        }
                      }
                    },
                    "loginMethods": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "tenantIds": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "customer1"
                            }
                          },
                          "recipeUserId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                          },
                          "verified": {
                            "type": "boolean",
                            "example": true
                          },
                          "timeJoined": {
                            "type": "number",
                            "example": 1623918032231
                          },
                          "recipeId": {
                            "type": "string",
                            "enum": [
                              "emailpassword",
                              "passwordless",
                              "thirdparty"
                            ]
                          },
                          "email": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          },
                          "phoneNumber": {
                            "type": "string",
                            "example": "+14155552671"
                          },
                          "thirdParty": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "didUserAlreadyExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordGetUser",
    "summary": "Get email password user",
    "deprecated": true,
    "description": "Get a user's information\n\nAPI is tenant specific if querying by email.\nIf querying by userId, tenantId will be ignored.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "description": "use either email or userId, not both",
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      },
      {
        "in": "query",
        "name": "userId",
        "description": "use either email or userId, not both",
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "get user's information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR",
                        "UNKNOWN_EMAIL_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "EmailPassword Recipe"
    ],
    "operationId": "emailPasswordPutUser",
    "summary": "Update user info",
    "description": "Update a user's information\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "emailpassword",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              },
              "password": {
                "type": "string",
                "example": "password123"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "update user's information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "UNKNOWN_USER_ID_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_CHANGE_NOT_ALLOWED_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "getTotpDevices",
    "summary": "List user TOTP devices",
    "description": "Retrieve a list of TOTP devices for a user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "userId",
        "schema": {
          "type": "string",
          "description": "The user ID to get TOTP devices for"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "Retrives all TOTP devices",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Devices List",
                  "description": "Response containing list of TOTP devices",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "devices": {
                      "type": "array",
                      "description": "List of TOTP devices",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Name of the TOTP device"
                          },
                          "period": {
                            "type": "number",
                            "description": "Time period in seconds for TOTP code generation"
                          },
                          "skew": {
                            "type": "number",
                            "description": "Time skew in seconds for TOTP validation"
                          },
                          "verified": {
                            "type": "boolean",
                            "description": "Whether the device has been verified"
                          }
                        }
                      }
                    }
                  },
                  "required": [
                    "status"
                  ]
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "verifyTotpDevice",
    "summary": "Verify TOTP device",
    "description": "Mark a TOTP device as verified if the given TOTP code is valid for that device.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "deviceName": {
                "type": "string",
                "description": "Name of the TOTP device to verify",
                "example": "My Authy App"
              },
              "totp": {
                "type": "string",
                "description": "The TOTP code to verify",
                "example": "123456"
              }
            },
            "required": [
              "userId",
              "deviceName",
              "totp"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Device Verification Success",
                  "description": "Response when TOTP device is verified successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "wasAlreadyVerified": {
                      "type": "boolean",
                      "description": "Indicates if the device was already verified",
                      "example": false
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Unknown Device Error",
                  "description": "Response when TOTP device is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_DEVICE_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Invalid TOTP Error",
                  "description": "Response when TOTP code is invalid",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_TOTP_ERROR"
                      ]
                    },
                    "currentNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Current number of failed verification attempts",
                      "example": 2
                    },
                    "maxNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Maximum allowed failed verification attempts",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Rate Limit Error",
                  "description": "Response when rate limit is reached",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "LIMIT_REACHED_ERROR"
                      ]
                    },
                    "retryAfterMs": {
                      "type": "number",
                      "description": "Time in milliseconds to wait before retrying",
                      "example": 90000
                    },
                    "currentNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Current number of failed verification attempts",
                      "example": 2
                    },
                    "maxNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Maximum allowed failed verification attempts",
                      "example": 5
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "verifyTotpCode",
    "summary": "Verify TOTP code",
    "description": "Check if a TOTP code is valid against any of the TOTP devices for a user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "totp": {
                "type": "string",
                "description": "The TOTP code to verify",
                "example": "123456"
              },
              "allowUnverifiedDevices": {
                "type": "boolean",
                "description": "Whether to allow verification against unverified devices",
                "example": false
              }
            },
            "required": [
              "userId",
              "totp",
              "allowUnverifiedDevices"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Verification Success",
                  "description": "Response when TOTP code is valid",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Invalid TOTP Error",
                  "description": "Response when TOTP code is invalid",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_TOTP_ERROR"
                      ]
                    },
                    "currentNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Current number of failed verification attempts",
                      "example": 2
                    },
                    "maxNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Maximum allowed failed verification attempts",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Unknown User Error",
                  "description": "Response when user ID is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Rate Limit Error",
                  "description": "Response when rate limit is reached",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "LIMIT_REACHED_ERROR"
                      ]
                    },
                    "retryAfterMs": {
                      "type": "number",
                      "description": "Time in milliseconds to wait before retrying",
                      "example": 90000
                    },
                    "currentNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Current number of failed verification attempts",
                      "example": 2
                    },
                    "maxNumberOfFailedAttempts": {
                      "type": "number",
                      "description": "Maximum allowed failed verification attempts",
                      "example": 5
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "createTotpDevice",
    "summary": "Add TOTP device for user",
    "description": "Add a TOTP device for a user and enable TOTP if not already enabled.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "deviceName": {
                "type": "string",
                "description": "Name of the TOTP device",
                "example": "My Authy App"
              },
              "skew": {
                "type": "number",
                "description": "Time skew in seconds for TOTP validation",
                "example": 0
              },
              "period": {
                "type": "number",
                "description": "Time period in seconds for TOTP code generation",
                "example": 30
              }
            },
            "required": [
              "userId",
              "skew",
              "period"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status and secret properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Creation Success",
                  "description": "Response when TOTP device is created successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "secret": {
                      "type": "string",
                      "description": "The TOTP secret key for the device",
                      "example": "JBSWY3DPEHPK3PXP"
                    },
                    "deviceName": {
                      "type": "string",
                      "description": "Name of the created TOTP device",
                      "example": "d1"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Device Already Exists Error",
                  "description": "Response when TOTP device already exists",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "DEVICE_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "updateTotpDeviceName",
    "summary": "Update TOTP device name",
    "description": "Update the name of a TOTP device for a user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "existingDeviceName": {
                "type": "string",
                "description": "Current name of the TOTP device",
                "example": "My Authy App"
              },
              "newDeviceName": {
                "type": "string",
                "description": "New name for the TOTP device",
                "example": "A better name for my TOTP device"
              }
            },
            "required": [
              "userId",
              "existingDeviceName",
              "newDeviceName"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Device Name Update Success",
                  "description": "Response when TOTP device name is updated successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Unknown Device Error",
                  "description": "Response when TOTP device is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_DEVICE_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Device Already Exists Error",
                  "description": "Response when new device name already exists",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "DEVICE_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "removeTotpDevice",
    "summary": "Remove TOTP device",
    "description": "Remove a TOTP device for a user. If all devices are removed, TOTP is disabled for the user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "deviceName": {
                "type": "string",
                "description": "Name of the TOTP device to remove",
                "example": "My Authy App"
              }
            },
            "required": [
              "userId",
              "deviceName"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Removal Success",
                  "description": "Response when TOTP device is removed successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didDeviceExist": {
                      "type": "boolean",
                      "description": "Indicates if the device existed before removal",
                      "example": true
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "importTotpDevice",
    "summary": "Import existing TOTP device",
    "description": "Add a TOTP device for a user and enable TOTP if not already enabled.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "deviceName": {
                "type": "string",
                "description": "Name of the TOTP device",
                "example": "My Authy App"
              },
              "skew": {
                "type": "number",
                "description": "Time skew in seconds for TOTP validation",
                "example": 0
              },
              "period": {
                "type": "number",
                "description": "Time period in seconds for TOTP code generation",
                "example": 30
              },
              "secretKey": {
                "type": "string",
                "description": "The TOTP secret key for the device",
                "example": "BSWY3DPEMOWNFUWJLDIWNDNDPONBIUFG"
              }
            },
            "required": [
              "userId",
              "skew",
              "period",
              "secretKey"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status and secret properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Import Success",
                  "description": "Response when TOTP device is imported successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "deviceName": {
                      "type": "string",
                      "description": "Name of the imported TOTP device",
                      "example": "d1"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Device Already Exists Error",
                  "description": "Response when TOTP device already exists",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "DEVICE_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "createTotpDevice",
    "summary": "Add TOTP device for user",
    "description": "Add a TOTP device for a user and enable TOTP if not already enabled.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "deviceName": {
                "type": "string",
                "description": "Name of the TOTP device",
                "example": "My Authy App"
              },
              "skew": {
                "type": "number",
                "description": "Time skew in seconds for TOTP validation",
                "example": 0
              },
              "period": {
                "type": "number",
                "description": "Time period in seconds for TOTP code generation",
                "example": 30
              }
            },
            "required": [
              "userId",
              "skew",
              "period"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status and secret properties",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "TOTP Device Creation Success",
                  "description": "Response when TOTP device is created successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "secret": {
                      "type": "string",
                      "description": "The TOTP secret key for the device",
                      "example": "JBSWY3DPEHPK3PXP"
                    },
                    "deviceName": {
                      "type": "string",
                      "description": "Name of the created TOTP device",
                      "example": "d1"
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Device Already Exists Error",
                  "description": "Response when TOTP device already exists",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "DEVICE_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Totp Recipe"
    ],
    "operationId": "updateTotpDeviceName",
    "summary": "Update TOTP device name",
    "description": "Update the name of a TOTP device for a user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "totp",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "existingDeviceName": {
                "type": "string",
                "description": "Current name of the TOTP device",
                "example": "My Authy App"
              },
              "newDeviceName": {
                "type": "string",
                "description": "New name for the TOTP device",
                "example": "A better name for my TOTP device"
              }
            },
            "required": [
              "userId",
              "existingDeviceName",
              "newDeviceName"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Device Name Update Success",
                  "description": "Response when TOTP device name is updated successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Unknown Device Error",
                  "description": "Response when TOTP device is not found",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_DEVICE_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Device Already Exists Error",
                  "description": "Response when new device name already exists",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "DEVICE_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get tenant configuration",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still returns `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` values for backward compatibility, and it's values are derived from the `firstFactors` and `requiredSecondaryFactors` configured for the tenant. The detailed computation of the values as per CDI version is described here: https://github.com/supertokens/supertokens-core/issues/979#issuecomment-2099971371\n\nGet a tenant config of the tenant specified by the url prefix.\n\nSuperTokens subscription license key is required if querying any tenant other than the base tenant.\n\nReturns recipes with their enabled flag and recipe specific configs saved in core\n",
    "operationId": "tenantConfigGet",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Tenant config result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "tenantId": {
                      "type": "string",
                      "example": "customer1"
                    },
                    "emailPassword": {
                      "type": "object",
                      "required": [
                        "enabled"
                      ],
                      "properties": {
                        "enabled": {
                          "type": "boolean"
                        }
                      }
                    },
                    "thirdParty": {
                      "type": "object",
                      "required": [
                        "enabled"
                      ],
                      "properties": {
                        "enabled": {
                          "type": "boolean"
                        },
                        "providers": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "required": [
                              "thirdPartyId"
                            ],
                            "properties": {
                              "thirdPartyId": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              },
                              "clients": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "clientType": {
                                      "type": "string"
                                    },
                                    "clientId": {
                                      "type": "string"
                                    },
                                    "clientSecret": {
                                      "type": "string"
                                    },
                                    "scope": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "forcePKCE": {
                                      "type": "boolean"
                                    },
                                    "additionalConfig": {
                                      "type": "object"
                                    }
                                  }
                                }
                              },
                              "authorizationEndpoint": {
                                "type": "string"
                              },
                              "authorizationEndpointQueryParams": {
                                "type": "object"
                              },
                              "tokenEndpoint": {
                                "type": "string"
                              },
                              "tokenEndpointBodyParams": {
                                "type": "object"
                              },
                              "userInfoEndpoint": {
                                "type": "string"
                              },
                              "userInfoEndpointQueryParams": {
                                "type": "object"
                              },
                              "userInfoEndpointHeaders": {
                                "type": "object"
                              },
                              "jwksURI": {
                                "type": "string"
                              },
                              "oidcDiscoveryEndpoint": {
                                "type": "string"
                              },
                              "requireEmail": {
                                "type": "boolean",
                                "default": true
                              },
                              "userInfoMap": {
                                "type": "object",
                                "properties": {
                                  "fromIdTokenPayload": {
                                    "type": "object",
                                    "properties": {
                                      "userId": {
                                        "type": "string"
                                      },
                                      "email": {
                                        "type": "string"
                                      },
                                      "emailVerified": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  "fromUserInfoAPI": {
                                    "type": "object",
                                    "properties": {
                                      "userId": {
                                        "type": "string"
                                      },
                                      "email": {
                                        "type": "string"
                                      },
                                      "emailVerified": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "passwordless": {
                      "type": "object",
                      "required": [
                        "enabled"
                      ],
                      "properties": {
                        "enabled": {
                          "type": "boolean"
                        }
                      }
                    },
                    "firstFactors": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "emailpassword"
                      }
                    },
                    "requiredSecondaryFactors": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "otp-phone"
                      }
                    },
                    "coreConfig": {
                      "type": "object"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "TENANT_NOT_FOUND_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get tenant configuration",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Get a tenant config of the tenant specified by the url prefix.\n\nThe value of `firstFactors` can be as follows:\n- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK\n- `[]` (empty array): No first factors would be enabled for the tenant\n- non-empty array: The first factors that are enabled for the tenant\n\nSuperTokens subscription license key is required if querying any tenant other than the base tenant.\n\nReturns recipes with their enabled flag and recipe specific configs saved in core\n",
    "operationId": "tenantConfigV2Get",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Tenant config result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "tenantId": {
                      "type": "string",
                      "example": "customer1"
                    },
                    "thirdParty": {
                      "type": "object",
                      "properties": {
                        "providers": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "required": [
                              "thirdPartyId"
                            ],
                            "properties": {
                              "thirdPartyId": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              },
                              "clients": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "clientType": {
                                      "type": "string"
                                    },
                                    "clientId": {
                                      "type": "string"
                                    },
                                    "clientSecret": {
                                      "type": "string"
                                    },
                                    "scope": {
                                      "type": "array",
                                      "items": {
                                        "type": "string"
                                      }
                                    },
                                    "forcePKCE": {
                                      "type": "boolean"
                                    },
                                    "additionalConfig": {
                                      "type": "object"
                                    }
                                  }
                                }
                              },
                              "authorizationEndpoint": {
                                "type": "string"
                              },
                              "authorizationEndpointQueryParams": {
                                "type": "object"
                              },
                              "tokenEndpoint": {
                                "type": "string"
                              },
                              "tokenEndpointBodyParams": {
                                "type": "object"
                              },
                              "userInfoEndpoint": {
                                "type": "string"
                              },
                              "userInfoEndpointQueryParams": {
                                "type": "object"
                              },
                              "userInfoEndpointHeaders": {
                                "type": "object"
                              },
                              "jwksURI": {
                                "type": "string"
                              },
                              "oidcDiscoveryEndpoint": {
                                "type": "string"
                              },
                              "requireEmail": {
                                "type": "boolean",
                                "default": true
                              },
                              "userInfoMap": {
                                "type": "object",
                                "properties": {
                                  "fromIdTokenPayload": {
                                    "type": "object",
                                    "properties": {
                                      "userId": {
                                        "type": "string"
                                      },
                                      "email": {
                                        "type": "string"
                                      },
                                      "emailVerified": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  "fromUserInfoAPI": {
                                    "type": "object",
                                    "properties": {
                                      "userId": {
                                        "type": "string"
                                      },
                                      "email": {
                                        "type": "string"
                                      },
                                      "emailVerified": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "firstFactors": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "emailpassword"
                      }
                    },
                    "requiredSecondaryFactors": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "otp-phone"
                      }
                    },
                    "coreConfig": {
                      "type": "object"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "TENANT_NOT_FOUND_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List tenants in an app",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still returns `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` values for backward compatibility, and it's values are derived from the `firstFactors` and `requiredSecondaryFactors` configured for the tenant. The detailed computation of the values as per CDI version is described here: https://github.com/supertokens/supertokens-core/issues/979#issuecomment-2099971371\n\nGet a list of all tenants in an app.\n\nRequest must originate from public tenant.\n",
    "operationId": "tenantListGET",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of tenants",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "tenants"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "emailPassword",
                      "thirdParty",
                      "passwordless",
                      "coreConfig",
                      "tenantId"
                    ],
                    "properties": {
                      "tenantId": {
                        "type": "string",
                        "example": "customer1"
                      },
                      "emailPassword": {
                        "type": "object",
                        "required": [
                          "enabled"
                        ],
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        }
                      },
                      "thirdParty": {
                        "type": "object",
                        "required": [
                          "enabled"
                        ],
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "providers": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "required": [
                                "thirdPartyId"
                              ],
                              "properties": {
                                "thirdPartyId": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "clients": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "clientType": {
                                        "type": "string"
                                      },
                                      "clientId": {
                                        "type": "string"
                                      },
                                      "clientSecret": {
                                        "type": "string"
                                      },
                                      "scope": {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        }
                                      },
                                      "forcePKCE": {
                                        "type": "boolean"
                                      },
                                      "additionalConfig": {
                                        "type": "object"
                                      }
                                    }
                                  }
                                },
                                "authorizationEndpoint": {
                                  "type": "string"
                                },
                                "authorizationEndpointQueryParams": {
                                  "type": "object"
                                },
                                "tokenEndpoint": {
                                  "type": "string"
                                },
                                "tokenEndpointBodyParams": {
                                  "type": "object"
                                },
                                "userInfoEndpoint": {
                                  "type": "string"
                                },
                                "userInfoEndpointQueryParams": {
                                  "type": "object"
                                },
                                "userInfoEndpointHeaders": {
                                  "type": "object"
                                },
                                "jwksURI": {
                                  "type": "string"
                                },
                                "oidcDiscoveryEndpoint": {
                                  "type": "string"
                                },
                                "requireEmail": {
                                  "type": "boolean",
                                  "default": true
                                },
                                "userInfoMap": {
                                  "type": "object",
                                  "properties": {
                                    "fromIdTokenPayload": {
                                      "type": "object",
                                      "properties": {
                                        "userId": {
                                          "type": "string"
                                        },
                                        "email": {
                                          "type": "string"
                                        },
                                        "emailVerified": {
                                          "type": "string"
                                        }
                                      }
                                    },
                                    "fromUserInfoAPI": {
                                      "type": "object",
                                      "properties": {
                                        "userId": {
                                          "type": "string"
                                        },
                                        "email": {
                                          "type": "string"
                                        },
                                        "emailVerified": {
                                          "type": "string"
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "passwordless": {
                        "type": "object",
                        "required": [
                          "enabled"
                        ],
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        }
                      },
                      "firstFactors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "emailpassword"
                        }
                      },
                      "requiredSecondaryFactors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "otp-phone"
                        }
                      },
                      "coreConfig": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List tenants in an app",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Get a list of all tenants in an app.\n\nThe value of `firstFactors` can be as follows:\n- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK\n- `[]` (empty array): No first factors would be enabled for the tenant\n- non-empty array: The first factors that are enabled for the tenant\n\nRequest must originate from public tenant.\n",
    "operationId": "tenantListV2GET",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of tenants",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "tenants"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "tenants": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "thirdParty",
                      "coreConfig",
                      "tenantId"
                    ],
                    "properties": {
                      "tenantId": {
                        "type": "string",
                        "example": "customer1"
                      },
                      "thirdParty": {
                        "type": "object",
                        "properties": {
                          "providers": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "required": [
                                "thirdPartyId"
                              ],
                              "properties": {
                                "thirdPartyId": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "clients": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "clientType": {
                                        "type": "string"
                                      },
                                      "clientId": {
                                        "type": "string"
                                      },
                                      "clientSecret": {
                                        "type": "string"
                                      },
                                      "scope": {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        }
                                      },
                                      "forcePKCE": {
                                        "type": "boolean"
                                      },
                                      "additionalConfig": {
                                        "type": "object"
                                      }
                                    }
                                  }
                                },
                                "authorizationEndpoint": {
                                  "type": "string"
                                },
                                "authorizationEndpointQueryParams": {
                                  "type": "object"
                                },
                                "tokenEndpoint": {
                                  "type": "string"
                                },
                                "tokenEndpointBodyParams": {
                                  "type": "object"
                                },
                                "userInfoEndpoint": {
                                  "type": "string"
                                },
                                "userInfoEndpointQueryParams": {
                                  "type": "object"
                                },
                                "userInfoEndpointHeaders": {
                                  "type": "object"
                                },
                                "jwksURI": {
                                  "type": "string"
                                },
                                "oidcDiscoveryEndpoint": {
                                  "type": "string"
                                },
                                "requireEmail": {
                                  "type": "boolean",
                                  "default": true
                                },
                                "userInfoMap": {
                                  "type": "object",
                                  "properties": {
                                    "fromIdTokenPayload": {
                                      "type": "object",
                                      "properties": {
                                        "userId": {
                                          "type": "string"
                                        },
                                        "email": {
                                          "type": "string"
                                        },
                                        "emailVerified": {
                                          "type": "string"
                                        }
                                      }
                                    },
                                    "fromUserInfoAPI": {
                                      "type": "object",
                                      "properties": {
                                        "userId": {
                                          "type": "string"
                                        },
                                        "email": {
                                          "type": "string"
                                        },
                                        "emailVerified": {
                                          "type": "string"
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "firstFactors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "emailpassword"
                        }
                      },
                      "requiredSecondaryFactors": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "otp-phone"
                        }
                      },
                      "coreConfig": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List apps",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still returns `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` values for backward compatibility, and it's values are derived from the `firstFactors` and `requiredSecondaryFactors` configured for the tenant. The detailed computation of the values as per CDI version is described here: https://github.com/supertokens/supertokens-core/issues/979#issuecomment-2099971371\n\nGet a list of all apps in a connection uri domain.\n\nRequest must originate from public app and tenant.\n",
    "operationId": "appListGET",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of apps",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "apps"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "apps": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "appId": {
                        "type": "string",
                        "example": "app1"
                      },
                      "tenants": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "required": [
                            "emailPassword",
                            "thirdParty",
                            "passwordless",
                            "coreConfig",
                            "tenantId"
                          ],
                          "properties": {
                            "tenantId": {
                              "type": "string",
                              "example": "customer1"
                            },
                            "emailPassword": {
                              "type": "object",
                              "required": [
                                "enabled"
                              ],
                              "properties": {
                                "enabled": {
                                  "type": "boolean"
                                }
                              }
                            },
                            "thirdParty": {
                              "type": "object",
                              "required": [
                                "enabled"
                              ],
                              "properties": {
                                "enabled": {
                                  "type": "boolean"
                                },
                                "providers": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "required": [
                                      "thirdPartyId"
                                    ],
                                    "properties": {
                                      "thirdPartyId": {
                                        "type": "string"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "clients": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "clientType": {
                                              "type": "string"
                                            },
                                            "clientId": {
                                              "type": "string"
                                            },
                                            "clientSecret": {
                                              "type": "string"
                                            },
                                            "scope": {
                                              "type": "array",
                                              "items": {
                                                "type": "string"
                                              }
                                            },
                                            "forcePKCE": {
                                              "type": "boolean"
                                            },
                                            "additionalConfig": {
                                              "type": "object"
                                            }
                                          }
                                        }
                                      },
                                      "authorizationEndpoint": {
                                        "type": "string"
                                      },
                                      "authorizationEndpointQueryParams": {
                                        "type": "object"
                                      },
                                      "tokenEndpoint": {
                                        "type": "string"
                                      },
                                      "tokenEndpointBodyParams": {
                                        "type": "object"
                                      },
                                      "userInfoEndpoint": {
                                        "type": "string"
                                      },
                                      "userInfoEndpointQueryParams": {
                                        "type": "object"
                                      },
                                      "userInfoEndpointHeaders": {
                                        "type": "object"
                                      },
                                      "jwksURI": {
                                        "type": "string"
                                      },
                                      "oidcDiscoveryEndpoint": {
                                        "type": "string"
                                      },
                                      "requireEmail": {
                                        "type": "boolean",
                                        "default": true
                                      },
                                      "userInfoMap": {
                                        "type": "object",
                                        "properties": {
                                          "fromIdTokenPayload": {
                                            "type": "object",
                                            "properties": {
                                              "userId": {
                                                "type": "string"
                                              },
                                              "email": {
                                                "type": "string"
                                              },
                                              "emailVerified": {
                                                "type": "string"
                                              }
                                            }
                                          },
                                          "fromUserInfoAPI": {
                                            "type": "object",
                                            "properties": {
                                              "userId": {
                                                "type": "string"
                                              },
                                              "email": {
                                                "type": "string"
                                              },
                                              "emailVerified": {
                                                "type": "string"
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            },
                            "passwordless": {
                              "type": "object",
                              "required": [
                                "enabled"
                              ],
                              "properties": {
                                "enabled": {
                                  "type": "boolean"
                                }
                              }
                            },
                            "firstFactors": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "emailpassword"
                              }
                            },
                            "requiredSecondaryFactors": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "otp-phone"
                              }
                            },
                            "coreConfig": {
                              "type": "object"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List apps",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Get a list of all apps in a connection uri domain.\n\nThe value of `firstFactors` can be as follows:\n- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK\n- `[]` (empty array): No first factors would be enabled for the tenant\n- non-empty array: The first factors that are enabled for the tenant\n\nRequest must originate from public app and tenant.\n",
    "operationId": "appListV2GET",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of apps",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "apps"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "apps": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "appId": {
                        "type": "string",
                        "example": "app1"
                      },
                      "tenants": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "required": [
                            "thirdParty",
                            "coreConfig",
                            "tenantId"
                          ],
                          "properties": {
                            "tenantId": {
                              "type": "string",
                              "example": "customer1"
                            },
                            "thirdParty": {
                              "type": "object",
                              "properties": {
                                "providers": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "required": [
                                      "thirdPartyId"
                                    ],
                                    "properties": {
                                      "thirdPartyId": {
                                        "type": "string"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "clients": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "clientType": {
                                              "type": "string"
                                            },
                                            "clientId": {
                                              "type": "string"
                                            },
                                            "clientSecret": {
                                              "type": "string"
                                            },
                                            "scope": {
                                              "type": "array",
                                              "items": {
                                                "type": "string"
                                              }
                                            },
                                            "forcePKCE": {
                                              "type": "boolean"
                                            },
                                            "additionalConfig": {
                                              "type": "object"
                                            }
                                          }
                                        }
                                      },
                                      "authorizationEndpoint": {
                                        "type": "string"
                                      },
                                      "authorizationEndpointQueryParams": {
                                        "type": "object"
                                      },
                                      "tokenEndpoint": {
                                        "type": "string"
                                      },
                                      "tokenEndpointBodyParams": {
                                        "type": "object"
                                      },
                                      "userInfoEndpoint": {
                                        "type": "string"
                                      },
                                      "userInfoEndpointQueryParams": {
                                        "type": "object"
                                      },
                                      "userInfoEndpointHeaders": {
                                        "type": "object"
                                      },
                                      "jwksURI": {
                                        "type": "string"
                                      },
                                      "oidcDiscoveryEndpoint": {
                                        "type": "string"
                                      },
                                      "requireEmail": {
                                        "type": "boolean",
                                        "default": true
                                      },
                                      "userInfoMap": {
                                        "type": "object",
                                        "properties": {
                                          "fromIdTokenPayload": {
                                            "type": "object",
                                            "properties": {
                                              "userId": {
                                                "type": "string"
                                              },
                                              "email": {
                                                "type": "string"
                                              },
                                              "emailVerified": {
                                                "type": "string"
                                              }
                                            }
                                          },
                                          "fromUserInfoAPI": {
                                            "type": "object",
                                            "properties": {
                                              "userId": {
                                                "type": "string"
                                              },
                                              "email": {
                                                "type": "string"
                                              },
                                              "emailVerified": {
                                                "type": "string"
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            },
                            "firstFactors": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "emailpassword"
                              }
                            },
                            "requiredSecondaryFactors": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "otp-phone"
                              }
                            },
                            "coreConfig": {
                              "type": "object"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List connection uri domains",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still returns `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` values for backward compatibility, and it's values are derived from the `firstFactors` and `requiredSecondaryFactors` configured for the tenant. The detailed computation of the values as per CDI version is described here: https://github.com/supertokens/supertokens-core/issues/979#issuecomment-2099971371\n\nGet a list of all connection uri domains.\n\nRequest must originate from base connection uri domain and public app and tenant.\n",
    "operationId": "connectionUriDomainListGET",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of connection uri domains",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "connectionUriDomains"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "connectionUriDomains": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "connectionUriDomain": {
                        "type": "string",
                        "example": "core-1234.supertokens.io:3567"
                      },
                      "apps": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "appId": {
                              "type": "string",
                              "example": "app1"
                            },
                            "tenants": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "required": [
                                  "emailPassword",
                                  "thirdParty",
                                  "passwordless",
                                  "coreConfig",
                                  "tenantId"
                                ],
                                "properties": {
                                  "tenantId": {
                                    "type": "string",
                                    "example": "customer1"
                                  },
                                  "emailPassword": {
                                    "type": "object",
                                    "required": [
                                      "enabled"
                                    ],
                                    "properties": {
                                      "enabled": {
                                        "type": "boolean"
                                      }
                                    }
                                  },
                                  "thirdParty": {
                                    "type": "object",
                                    "required": [
                                      "enabled"
                                    ],
                                    "properties": {
                                      "enabled": {
                                        "type": "boolean"
                                      },
                                      "providers": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "required": [
                                            "thirdPartyId"
                                          ],
                                          "properties": {
                                            "thirdPartyId": {
                                              "type": "string"
                                            },
                                            "name": {
                                              "type": "string"
                                            },
                                            "clients": {
                                              "type": "array",
                                              "items": {
                                                "type": "object",
                                                "properties": {
                                                  "clientType": {
                                                    "type": "string"
                                                  },
                                                  "clientId": {
                                                    "type": "string"
                                                  },
                                                  "clientSecret": {
                                                    "type": "string"
                                                  },
                                                  "scope": {
                                                    "type": "array",
                                                    "items": {
                                                      "type": "string"
                                                    }
                                                  },
                                                  "forcePKCE": {
                                                    "type": "boolean"
                                                  },
                                                  "additionalConfig": {
                                                    "type": "object"
                                                  }
                                                }
                                              }
                                            },
                                            "authorizationEndpoint": {
                                              "type": "string"
                                            },
                                            "authorizationEndpointQueryParams": {
                                              "type": "object"
                                            },
                                            "tokenEndpoint": {
                                              "type": "string"
                                            },
                                            "tokenEndpointBodyParams": {
                                              "type": "object"
                                            },
                                            "userInfoEndpoint": {
                                              "type": "string"
                                            },
                                            "userInfoEndpointQueryParams": {
                                              "type": "object"
                                            },
                                            "userInfoEndpointHeaders": {
                                              "type": "object"
                                            },
                                            "jwksURI": {
                                              "type": "string"
                                            },
                                            "oidcDiscoveryEndpoint": {
                                              "type": "string"
                                            },
                                            "requireEmail": {
                                              "type": "boolean",
                                              "default": true
                                            },
                                            "userInfoMap": {
                                              "type": "object",
                                              "properties": {
                                                "fromIdTokenPayload": {
                                                  "type": "object",
                                                  "properties": {
                                                    "userId": {
                                                      "type": "string"
                                                    },
                                                    "email": {
                                                      "type": "string"
                                                    },
                                                    "emailVerified": {
                                                      "type": "string"
                                                    }
                                                  }
                                                },
                                                "fromUserInfoAPI": {
                                                  "type": "object",
                                                  "properties": {
                                                    "userId": {
                                                      "type": "string"
                                                    },
                                                    "email": {
                                                      "type": "string"
                                                    },
                                                    "emailVerified": {
                                                      "type": "string"
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  },
                                  "passwordless": {
                                    "type": "object",
                                    "required": [
                                      "enabled"
                                    ],
                                    "properties": {
                                      "enabled": {
                                        "type": "boolean"
                                      }
                                    }
                                  },
                                  "firstFactors": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "example": "emailpassword"
                                    }
                                  },
                                  "requiredSecondaryFactors": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "example": "otp-phone"
                                    }
                                  },
                                  "coreConfig": {
                                    "type": "object"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List connection uri domains",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Get a list of all connection uri domains.\n\nThe value of `firstFactors` can be as follows:\n- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK\n- `[]` (empty array): No first factors would be enabled for the tenant\n- non-empty array: The first factors that are enabled for the tenant\n\nRequest must originate from base connection uri domain and public app and tenant.\n",
    "operationId": "connectionUriDomainListV2GET",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of connection uri domains",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "connectionUriDomains"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "connectionUriDomains": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "connectionUriDomain": {
                        "type": "string",
                        "example": "core-1234.supertokens.io:3567"
                      },
                      "apps": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "appId": {
                              "type": "string",
                              "example": "app1"
                            },
                            "tenants": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "required": [
                                  "thirdParty",
                                  "coreConfig",
                                  "tenantId"
                                ],
                                "properties": {
                                  "tenantId": {
                                    "type": "string",
                                    "example": "customer1"
                                  },
                                  "thirdParty": {
                                    "type": "object",
                                    "properties": {
                                      "providers": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "required": [
                                            "thirdPartyId"
                                          ],
                                          "properties": {
                                            "thirdPartyId": {
                                              "type": "string"
                                            },
                                            "name": {
                                              "type": "string"
                                            },
                                            "clients": {
                                              "type": "array",
                                              "items": {
                                                "type": "object",
                                                "properties": {
                                                  "clientType": {
                                                    "type": "string"
                                                  },
                                                  "clientId": {
                                                    "type": "string"
                                                  },
                                                  "clientSecret": {
                                                    "type": "string"
                                                  },
                                                  "scope": {
                                                    "type": "array",
                                                    "items": {
                                                      "type": "string"
                                                    }
                                                  },
                                                  "forcePKCE": {
                                                    "type": "boolean"
                                                  },
                                                  "additionalConfig": {
                                                    "type": "object"
                                                  }
                                                }
                                              }
                                            },
                                            "authorizationEndpoint": {
                                              "type": "string"
                                            },
                                            "authorizationEndpointQueryParams": {
                                              "type": "object"
                                            },
                                            "tokenEndpoint": {
                                              "type": "string"
                                            },
                                            "tokenEndpointBodyParams": {
                                              "type": "object"
                                            },
                                            "userInfoEndpoint": {
                                              "type": "string"
                                            },
                                            "userInfoEndpointQueryParams": {
                                              "type": "object"
                                            },
                                            "userInfoEndpointHeaders": {
                                              "type": "object"
                                            },
                                            "jwksURI": {
                                              "type": "string"
                                            },
                                            "oidcDiscoveryEndpoint": {
                                              "type": "string"
                                            },
                                            "requireEmail": {
                                              "type": "boolean",
                                              "default": true
                                            },
                                            "userInfoMap": {
                                              "type": "object",
                                              "properties": {
                                                "fromIdTokenPayload": {
                                                  "type": "object",
                                                  "properties": {
                                                    "userId": {
                                                      "type": "string"
                                                    },
                                                    "email": {
                                                      "type": "string"
                                                    },
                                                    "emailVerified": {
                                                      "type": "string"
                                                    }
                                                  }
                                                },
                                                "fromUserInfoAPI": {
                                                  "type": "object",
                                                  "properties": {
                                                    "userId": {
                                                      "type": "string"
                                                    },
                                                    "email": {
                                                      "type": "string"
                                                    },
                                                    "emailVerified": {
                                                      "type": "string"
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  },
                                  "firstFactors": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "example": "emailpassword"
                                    }
                                  },
                                  "requiredSecondaryFactors": {
                                    "type": "array",
                                    "items": {
                                      "type": "string",
                                      "example": "otp-phone"
                                    }
                                  },
                                  "coreConfig": {
                                    "type": "object"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Delete ThirdParty Provider configuration",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Delete ThirdParty Provider configuration for a tenant.\n",
    "operationId": "deleteTenantConfigPOST",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "thirdPartyId"
            ],
            "properties": {
              "thirdPartyId": {
                "type": "string",
                "example": "google"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Remove thirdParty config result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didConfigExist": {
                      "type": "boolean"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Add user tenant association",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Add user's association with the tenant.\n\nUser will be added to the tenant based on the url prefix of the request.\n\nNote: To associate a user to a tenant, the tenant must be in the same database\nand user must already exist in the app\n",
    "operationId": "addUserToTenant",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "recipeUserId"
            ],
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Association result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status",
                    "wasAlreadyAssociated"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "wasAlreadyAssociated": {
                      "type": "boolean"
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR",
                        "PHONE_NUMBER_ALREADY_EXISTS_ERROR",
                        "THIRD_PARTY_USER_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ASSOCIATION_NOT_ALLOWED_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Remove user tenant association",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Remove user's association with the tenant\n\nUser will be removed from the tenant based on the url prefix of the request.\n",
    "operationId": "removeUserFromTenant",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "recipeUserId"
            ],
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Disassociation result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "wasAssociated"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "wasAssociated": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Delete a tenant",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Delete a tenant.\n\nRequest must originate from public tenant.\n",
    "operationId": "deleteTenantPOST",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "tenantId"
            ],
            "properties": {
              "tenantId": {
                "type": "string",
                "example": "customer1"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Remove tenant result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "didExist"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Delete app",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Delete an app.\n\nRequest must originate from public app and tenant.\n\nNote: No tenants (other than the public tenant) must belong to the app to be able to delete it.\n",
    "operationId": "deleteAppPOST",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "appId"
            ],
            "properties": {
              "appId": {
                "type": "string",
                "example": "app1"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Remove app result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "didExist"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Remove connection uri domain",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Delete a connection uri domain.\n\nDeletion of base connection uri domain is not allowed.\n\nThe request must originate from base connection uri domain and public app and tenant.\n\nNote: There should be no apps or tenants (other than the public app and public tenant) belonging to the connection uri domain to be able to delete it.\n",
    "operationId": "deleteConnectionUriDomainPOST",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "connectionUriDomain"
            ],
            "properties": {
              "connectionUriDomain": {
                "type": "string",
                "example": "core-1234.supertokens.io:3567"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Remove connection uri domain result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "didExist"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didExist": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Upsert ThirdParty Provider configuration",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Creates or updates ThirdParty Provider Config for a tenant.\n\nIf `skipValidation` is set to true, the config will be saved without any validation.\n\nIf the config already exists for the given `tenantId` and `thirdPartyId`, the config in the core will be completely replaced with the config provided in the request body.\n\n**Validations done by the core:**\n\n`thirdPartyId` and `name` are required\n\nCommon to all providers:\n  - `clients` list:\n    - can be undefined or empty\n    - if contains 1 element, clientType can be empty or undefined\n    - if contains more than 1 element, clientType must be defined and unique\n  - for each element in `clients`:\n    - `clientId` must not be empty\n\nBuilt-in provider's specific validation is invoked if the `thirdPartyId` starts with the provider's id\n\nApple (id: apple):\n  - `clients`\n    - if it contains elements, each of them are validated as follows:\n      - `clientSecret` must be empty or undefined\n      - `additionalConfig` should contain the following keys:\n        - `keyId` must be a non empty string\n        - `teamId` must be a non empty string\n        - `privateKey` must be a non empty string\n\nGoogle Workspaces (id: google-workspaces):\n  - `clients`\n    - if it contains elements, each of them are validated as follows:\n      - `additionalConfig` may contain the key `hd`\n        - `hd` is optional\n        - if specified, it must be either `\"*\"`, or a valid domain\n\nBoxy SAML (id: boxy-saml):\n  - `clients`\n    - `additionalConfig` in the each element must contain `boxyURL` and must be non-empty string\n",
    "operationId": "createOrUpdateTenantConfigPUT",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "config"
            ],
            "properties": {
              "config": {
                "type": "object",
                "required": [
                  "thirdPartyId"
                ],
                "properties": {
                  "thirdPartyId": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "clients": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "clientType": {
                          "type": "string"
                        },
                        "clientId": {
                          "type": "string"
                        },
                        "clientSecret": {
                          "type": "string"
                        },
                        "scope": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "forcePKCE": {
                          "type": "boolean"
                        },
                        "additionalConfig": {
                          "type": "object"
                        }
                      }
                    }
                  },
                  "authorizationEndpoint": {
                    "type": "string"
                  },
                  "authorizationEndpointQueryParams": {
                    "type": "object"
                  },
                  "tokenEndpoint": {
                    "type": "string"
                  },
                  "tokenEndpointBodyParams": {
                    "type": "object"
                  },
                  "userInfoEndpoint": {
                    "type": "string"
                  },
                  "userInfoEndpointQueryParams": {
                    "type": "object"
                  },
                  "userInfoEndpointHeaders": {
                    "type": "object"
                  },
                  "jwksURI": {
                    "type": "string"
                  },
                  "oidcDiscoveryEndpoint": {
                    "type": "string"
                  },
                  "requireEmail": {
                    "type": "boolean",
                    "default": true
                  },
                  "userInfoMap": {
                    "type": "object",
                    "properties": {
                      "fromIdTokenPayload": {
                        "type": "object",
                        "properties": {
                          "userId": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "emailVerified": {
                            "type": "string"
                          }
                        }
                      },
                      "fromUserInfoAPI": {
                        "type": "object",
                        "properties": {
                          "userId": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "emailVerified": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                }
              },
              "skipValidation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status",
                    "createdNew"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "createdNew": {
                      "type": "boolean"
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "reason"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "CONFIG_VALIDATION_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Upsert tenant",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still accepts those `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs for backward compatibility.\n\nCreates or updates a tenant.\n\nSuperTokens subscription license key is required.\n\nIf creating a new tenant, only the login methods set to true will be enabled and rest will be disabled by default.\n\n`firstFactors` and `requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.\n\nNote: the create/update will fail if a login method is not enabled and a relavant factor is added to either `firstFactors` or `requiredSecondaryFactors`. For example, `emailPasswordEnabled` cannot be set to `false` if `emailpassword` is present in the `firstFactors` array.\n\nIf updating an existing tenant,\n1. core will keep the existing state of login methods and only update the ones that are specified in the request body.\n2. Core config will be merged into existing config. To delete a key in the config, use a null value\n\nThe request must originate from public tenant, and the new tenant will use connectionUriDomain and app from which the request originates.\n\nNote: Updation of core config is not allowed for the default connectionUriDomain, public app and tenant. In order to update config for the default connectionUriDomain, public app and tenant, you must edit the config.yaml or the docker env directly.\n",
    "operationId": "createOrUpdateTenantPUT",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "tenantId"
            ],
            "properties": {
              "tenantId": {
                "type": "string",
                "example": "customer1"
              },
              "emailPasswordEnabled": {
                "type": "boolean"
              },
              "thirdPartyEnabled": {
                "type": "boolean"
              },
              "passwordlessEnabled": {
                "type": "boolean"
              },
              "firstFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "emailpassword"
                }
              },
              "requiredSecondaryFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "otp-phone"
                }
              },
              "coreConfig": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update tenant result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "createdNew"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNew": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Upsert tenant",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Creates or updates a tenant.\n\nSuperTokens subscription license key is required.\n\nThe `firstFactors` can be set to following values:\n\n- `null`: When set to `null`, all the login methods will be available for the tenant.\n- `[]` (empty array): No login methods will be enabled for the tenant.\n- `['factor1', 'factor2', ...]` (non-empty array): The list of login methods to enable for the tenant. For eg. if this is set to `['emailpassword', 'thirdparty']`, the users of the tenant will be able to login using emailpassword and third party providers.\n\nList of built-in first factors are as follows:\n\n- Email password auth: `emailpassword`\n- Social login / enterprise SSO auth: `thirdparty`\n- Passwordless:\n  - With email OTP: `otp-email`\n  - With SMS OTP: `otp-phone`\n  - With email magic link: `link-email`\n  - With SMS magic link: `link-phone`\n\nIf first factors are not specified while creating a new tenant, all the login methods will be disabled by default.\n\nThe `requiredSecondaryFactors` can be set to following values:\n- `null`: When set to `null`, no secondary factors will be required for the users of the tenant.\n- `['factor1', 'factor2', ...]` (non-empty array): The list of factors that the users of the tenant must complete post the first factor login. For eg. if this is set to `['otp-phone', 'totp']`, the users of the tenant will be required to complete either phone OTP or TOTP post the first factor login.\n\nList of built-in secondary factors are as follows:\n\n- Email password auth: `emailpassword`\n- Social login / enterprise SSO auth: `thirdparty`\n- Passwordless:\n  - With email OTP: `otp-email`\n  - With SMS OTP: `otp-phone`\n  - With email magic link: `link-email`\n  - With SMS magic link: `link-phone`\n- Time based OTP: `totp`\n\nIf updating an existing tenant,\n1. core will keep the existing state of login methods and only update the ones that are specified in the request body.\n2. Core config will be merged into existing config. To delete a key in the config, use a null value\n\nThe request must originate from public tenant, and the new tenant will use connectionUriDomain and app from which the request originates.\n\nNote: Updation of core config is not allowed for the default connectionUriDomain, public app and tenant. In order to update config for the default connectionUriDomain, public app and tenant, you must edit the config.yaml or the docker env directly.\n",
    "operationId": "createOrUpdateTenantV2PUT",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "tenantId"
            ],
            "properties": {
              "tenantId": {
                "type": "string",
                "example": "customer1"
              },
              "firstFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "emailpassword"
                }
              },
              "requiredSecondaryFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "otp-phone"
                }
              },
              "coreConfig": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update tenant result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "createdNew"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNew": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Upsert app",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still accepts those `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs for backward compatibility.\n\nCreate or update an app.\nSuperTokens subscription license key is required.\n\nIf creating a new app, only the login methods set to true will be enabled and rest will be disabled by default.\n\n`firstFactors` and `requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.\n\nNote: the create/update will fail if a login method is not enabled and a relavant factor is added to either `firstFactors` or `requiredSecondaryFactors`. For example, `emailPasswordEnabled` cannot be set to `false` if `emailpassword` is present in the `firstFactors` array.\n\nIf updating an existing app,\n1. core will keep the existing state of login methods and only update the ones that are specified in the request body.\n2. Core config will be merged into existing config. To delete a key in the config, use a null value\n\nNote: the newly created app will use the same connection uri domain from which\nthis request originates and the request must originate from public app and public tenant.\n\nNote: Updation of core config is not allowed for the default connectionUriDomain, public app. In order to update config for the default connectionUriDomain and public app, you must edit the config.yaml or the docker env directly.\n",
    "operationId": "createOrUpdateAppPUT",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "appId"
            ],
            "properties": {
              "appId": {
                "type": "string",
                "example": "app1"
              },
              "emailPasswordEnabled": {
                "type": "boolean"
              },
              "thirdPartyEnabled": {
                "type": "boolean"
              },
              "passwordlessEnabled": {
                "type": "boolean"
              },
              "firstFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "emailpassword"
                }
              },
              "requiredSecondaryFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "otp-phone"
                }
              },
              "coreConfig": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update app result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "createdNew"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNew": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Upsert app",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Create or update an app.\n\nSuperTokens subscription license key is required.\n\nThe `firstFactors` can be set to following values:\n\n- `null`: When set to `null`, all the login methods will be available for the app (public tenant).\n- `[]` (empty array): No login methods will be enabled for the app (public tenant).\n- `['factor1', 'factor2', ...]` (non-empty array): The list of login methods to enable for the app (public tenant). For eg. if this is set to `['emailpassword', 'thirdparty']`, the users of the tenant will be able to login using emailpassword and third party providers.\n\nList of built-in first factors are as follows:\n\n- Email password auth: `emailpassword`\n- Social login / enterprise SSO auth: `thirdparty`\n- Passwordless:\n  - With email OTP: `otp-email`\n  - With SMS OTP: `otp-phone`\n  - With email magic link: `link-email`\n  - With SMS magic link: `link-phone`\n\nIf first factors are not specified while creating a new app, all the login methods will be enabled by default.\n\nThe `requiredSecondaryFactors` can be set to following values:\n- `null`: When set to `null`, no secondary factors will be required for the users of the app (public tenant).\n- `['factor1', 'factor2', ...]` (non-empty array): The list of factors that the users of the app (public tenant) must complete post the first factor login. For eg. if this is set to `['otp-phone', 'totp']`, the users of the tenant will be required to complete either phone OTP or TOTP post the first factor login.\n\nList of built-in secondary factors are as follows:\n\n- Email password auth: `emailpassword`\n- Social login / enterprise SSO auth: `thirdparty`\n- Passwordless:\n  - With email OTP: `otp-email`\n  - With SMS OTP: `otp-phone`\n  - With email magic link: `link-email`\n  - With SMS magic link: `link-phone`\n- Time based OTP: `totp`\n\nIf updating an existing app,\n1. core will keep the existing state of login methods and only update the ones that are specified in the request body.\n2. Core config will be merged into existing config. To delete a key in the config, use a null value\n\nNote: the newly created app will use the same connection uri domain from which\nthis request originates and the request must originate from public app and public tenant.\n\nNote: Updation of core config is not allowed for the default connectionUriDomain, public app. In order to update config for the default connectionUriDomain and public app, you must edit the config.yaml or the docker env directly.\n",
    "operationId": "createOrUpdateAppV2PUT",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "appId"
            ],
            "properties": {
              "appId": {
                "type": "string",
                "example": "app1"
              },
              "firstFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "emailpassword"
                }
              },
              "requiredSecondaryFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "otp-phone"
                }
              },
              "coreConfig": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update app result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "createdNew"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNew": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "Multitenancy Recipe"
    ],
    "summary": "Upsert connection URI domain",
    "description": "This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.\n\nNote: This deprecated API still accepts those `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs for backward compatibility.\n\nCreate or update a connection uri domain.\n\nSuperTokens subscription license key is required, if not using the base connection uri domain.\n\nThis request must originate from public app and public tenant on the base\nconnection uri domain.\n\nIf creating a new connection uri domain, only the login methods set to true will be enabled and rest will be disabled by default.\n\n`firstFactors` and `requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.\n\nNote: the create/update will fail if a login method is not enabled and a relavant factor is added to either `firstFactors` or `requiredSecondaryFactors`. For example, `emailPasswordEnabled` cannot be set to `false` if `emailpassword` is present in the `firstFactors` array.\n\nIf updating an existing connection uri domain,\n1. core will keep the existing state of login methods and only update the ones that are specified in the request body.\n2. Core config will be merged into existing config. To delete a key in the config, use a null value\n\nNote: The core config must contain a unique connection to the storage layer, because sharing of database between 2 different connection uri domains is not allowed.\n\nNote: Updation of core config is not allowed for the default connectionUriDomain. In order to update config for the default connectionUriDomain, you must edit the config.yaml or the docker env directly.\n",
    "operationId": "createOrUpdateConnectionURIDomainPUT",
    "deprecated": true,
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "connectionUriDomain"
            ],
            "properties": {
              "connectionUriDomain": {
                "type": "string",
                "example": "core-1234.supertokens.io:3567"
              },
              "emailPasswordEnabled": {
                "type": "boolean"
              },
              "thirdPartyEnabled": {
                "type": "boolean"
              },
              "passwordlessEnabled": {
                "type": "boolean"
              },
              "firstFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "emailpassword"
                }
              },
              "requiredSecondaryFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "otp-phone"
                }
              },
              "coreConfig": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update connection uri domain result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "createdNew"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNew": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Upsert connection uri domain",
    "tags": [
      "Multitenancy Recipe"
    ],
    "description": "Create or update a connection uri domain.\n\nSuperTokens subscription license key is required, if not using the base connection uri domain.\n\nThis request must originate from public app and public tenant on the base\nconnection uri domain.\n\nThe `firstFactors` can be set to following values:\n\n- `null`: When set to `null`, all the login methods will be available for the connection URI domain (public app, public tenant).\n- `[]` (empty array): No login methods will be enabled for the connection URI domain (public app, public tenant).\n- `['factor1', 'factor2', ...]` (non-empty array): The list of login methods to enable for the connection URI domain (public app, public tenant). For eg. if this is set to `['emailpassword', 'thirdparty']`, the users of the tenant will be able to login using emailpassword and third party providers.\n\nList of built-in first factors are as follows:\n\n- Email password auth: `emailpassword`\n- Social login / enterprise SSO auth: `thirdparty`\n- Passwordless:\n  - With email OTP: `otp-email`\n  - With SMS OTP: `otp-phone`\n  - With email magic link: `link-email`\n  - With SMS magic link: `link-phone`\n\nIf first factors are not specified while creating a new connection uri domain, all the login methods will be enabled by default.\n\nThe `requiredSecondaryFactors` can be set to following values:\n- `null`: When set to `null`, no secondary factors will be required for the users of the connection URI domain (public app, public tenant).\n- `['factor1', 'factor2', ...]` (non-empty array): The list of factors that the users of the connection URI domain (public app, public tenant) must complete post the first factor login. For eg. if this is set to `['otp-phone', 'totp']`, the users of the tenant will be required to complete either phone OTP or TOTP post the first factor login.\n\nList of built-in secondary factors are as follows:\n\n- Email password auth: `emailpassword`\n- Social login / enterprise SSO auth: `thirdparty`\n- Passwordless:\n  - With email OTP: `otp-email`\n  - With SMS OTP: `otp-phone`\n  - With email magic link: `link-email`\n  - With SMS magic link: `link-phone`\n- Time based OTP: `totp`\n\nIf updating an existing connection uri domain,\n1. core will keep the existing state of login methods and only update the ones that are specified in the request body.\n2. Core config will be merged into existing config. To delete a key in the config, use a null value\n\nNote: The core config must contain a unique connection to the storage layer, because sharing of database between 2 different connection uri domains is not allowed.\n\nNote: Updation of core config is not allowed for the default connectionUriDomain. In order to update config for the default connectionUriDomain, you must edit the config.yaml or the docker env directly.\n",
    "operationId": "createOrUpdateConnectionURIDomainV2PUT",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "multitenancy",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "connectionUriDomain"
            ],
            "properties": {
              "connectionUriDomain": {
                "type": "string",
                "example": "core-1234.supertokens.io:3567"
              },
              "firstFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "emailpassword"
                }
              },
              "requiredSecondaryFactors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "otp-phone"
                }
              },
              "coreConfig": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create or Update connection uri domain result",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "createdNew"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNew": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Core"
    ],
    "operationId": "getWellKnownJWKS",
    "summary": "Get well-known JWT keys",
    "description": "Retrieve JWKs for JWT verification, containing both static and dynamic keys.\n",
    "responses": {
      "200": {
        "description": "Retrieve JWKs for JWT verification, containing both static and dynamic keys.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "keys": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "description": "A JWK that can be used to verify a JWT",
                    "properties": {
                      "alg": {
                        "type": "string",
                        "description": "The algorithm to use when creating the JWT.",
                        "enum": [
                          "RS256"
                        ]
                      },
                      "kty": {
                        "type": "string",
                        "example": "RSA"
                      },
                      "use": {
                        "type": "string",
                        "example": "sig"
                      },
                      "kid": {
                        "type": "string",
                        "description": "Unique identifier for the JWK"
                      },
                      "x5c": {
                        "type": "array",
                        "description": "X.509 Certificate Chain",
                        "items": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "JWT Recipe"
    ],
    "operationId": "getJWKS",
    "summary": "Get JWT keys",
    "description": "Retrieve JWKs for JWT verification, containing both static and dynamic keys.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "jwt",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Retrieve JWKs for JWT verification, containing both static and dynamic keys.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "keys": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "description": "A JWK that can be used to verify a JWT",
                    "properties": {
                      "alg": {
                        "type": "string",
                        "description": "The algorithm to use when creating the JWT.",
                        "enum": [
                          "RS256"
                        ]
                      },
                      "kty": {
                        "type": "string",
                        "example": "RSA"
                      },
                      "use": {
                        "type": "string",
                        "example": "sig"
                      },
                      "kid": {
                        "type": "string",
                        "description": "Unique identifier for the JWK"
                      },
                      "x5c": {
                        "type": "array",
                        "description": "X.509 Certificate Chain",
                        "items": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Auth",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Auth\n",
    "operationId": "getOAuth2Auth",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Auth Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Consent Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Consent Request\n",
    "operationId": "getOAuth2ConsentRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "consentChallenge",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Consent Request Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "client": {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    },
                    "requestedScope": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "requestedAudience": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "requestedClaims": {
                      "type": "object",
                      "properties": {
                        "idToken": {
                          "type": "object",
                          "properties": {
                            "property1": {
                              "type": "string"
                            },
                            "property2": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "loginHint": {
                      "type": "string"
                    },
                    "uiLocales": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "acrValues": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "subject": {
                      "type": "string"
                    },
                    "requestUrl": {
                      "type": "string"
                    },
                    "skip": {
                      "type": "boolean"
                    },
                    "clientId": {
                      "type": "string"
                    },
                    "redirectUri": {
                      "type": "string"
                    },
                    "forceSubjectIdentifier": {
                      "type": "string"
                    },
                    "requestedAccessTokenAudience": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "context": {
                      "type": "object"
                    },
                    "sessionId": {
                      "type": "string"
                    },
                    "loginSessionId": {
                      "type": "string"
                    },
                    "loginChallenge": {
                      "type": "string"
                    },
                    "loginRequestedAt": {
                      "type": "string"
                    },
                    "consentRequestedAt": {
                      "type": "string"
                    },
                    "consentChallenge": {
                      "type": "string"
                    },
                    "consentSkip": {
                      "type": "boolean"
                    },
                    "consentRemember": {
                      "type": "boolean"
                    },
                    "consentRememberFor": {
                      "type": "integer"
                    },
                    "consentError": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    },
                    "consentErrorDebug": {
                      "type": "string"
                    },
                    "consentErrorDescription": {
                      "type": "string"
                    },
                    "consentErrorHint": {
                      "type": "string"
                    },
                    "consentErrorCode": {
                      "type": "string"
                    },
                    "consentStatusCode": {
                      "type": "integer"
                    },
                    "sessionIdToken": {
                      "type": "object",
                      "properties": {
                        "property1": {
                          "type": "string"
                        },
                        "property2": {
                          "type": "string"
                        }
                      }
                    },
                    "sessionAccessToken": {
                      "type": "object",
                      "properties": {
                        "property1": {
                          "type": "string"
                        },
                        "property2": {
                          "type": "string"
                        }
                      }
                    },
                    "sessionToken": {
                      "type": "object",
                      "properties": {
                        "property1": {
                          "type": "string"
                        },
                        "property2": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Login Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Login Request\n",
    "operationId": "getOAuth2LoginRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "loginChallenge",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Login Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "challenge": {
                      "type": "string"
                    },
                    "client": {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    },
                    "oidcContext": {
                      "type": "object",
                      "properties": {
                        "acrValues": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "display": {
                          "type": "string"
                        },
                        "idTokenHintClaims": {
                          "type": "object"
                        },
                        "loginHint": {
                          "type": "string"
                        },
                        "uiLocales": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "requestUrl": {
                          "type": "string"
                        },
                        "requestedAccessTokenAudience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "requestedScope": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "sessionId": {
                          "type": "string"
                        },
                        "skip": {
                          "type": "boolean"
                        },
                        "subject": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Client\n",
    "operationId": "getOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "clientId",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "abcd"
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "summary": "Create OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Create OAuth2 Client\n",
    "operationId": "createOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              },
              "clientName": {
                "type": "string",
                "example": "Hello"
              },
              "clientSecret": {
                "type": "string",
                "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
              },
              "redirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000/auth/callback/ory"
                ]
              },
              "grantTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "authorization_code",
                  "refresh_token"
                ]
              },
              "responseTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "code",
                  "id_token"
                ]
              },
              "scope": {
                "type": "string",
                "example": "offline_access openid email"
              },
              "audience": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "policyUri": {
                "type": "string",
                "example": ""
              },
              "allowedCorsOrigins": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "tosUri": {
                "type": "string",
                "example": ""
              },
              "clientUri": {
                "type": "string",
                "example": ""
              },
              "logoUri": {
                "type": "string",
                "example": ""
              },
              "tokenEndpointAuthMethod": {
                "type": "string",
                "example": "client_secret_post"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40Z"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40.362463Z"
              },
              "postLogoutRedirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000"
                ]
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "example": {}
              },
              "authorizationCodeGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "clientCredentialsGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "enableRefreshTokenRotation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "summary": "Update OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Update OAuth2 Client\n",
    "operationId": "updateOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              },
              "clientName": {
                "type": "string",
                "example": "Hello"
              },
              "clientSecret": {
                "type": "string",
                "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
              },
              "redirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000/auth/callback/ory"
                ]
              },
              "grantTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "authorization_code",
                  "refresh_token"
                ]
              },
              "responseTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "code",
                  "id_token"
                ]
              },
              "scope": {
                "type": "string",
                "example": "offline_access openid email"
              },
              "audience": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "policyUri": {
                "type": "string",
                "example": ""
              },
              "allowedCorsOrigins": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "tosUri": {
                "type": "string",
                "example": ""
              },
              "clientUri": {
                "type": "string",
                "example": ""
              },
              "logoUri": {
                "type": "string",
                "example": ""
              },
              "tokenEndpointAuthMethod": {
                "type": "string",
                "example": "client_secret_post"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40Z"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40.362463Z"
              },
              "postLogoutRedirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000"
                ]
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "example": {}
              },
              "authorizationCodeGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "clientCredentialsGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "enableRefreshTokenRotation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List OAuth2 Clients",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "List OAuth2 Clients\n",
    "operationId": "listOAuth2Clients",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "pageSize",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "example": 250
        }
      },
      {
        "name": "pageToken",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      },
      {
        "name": "clientName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "My App"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "clients": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "clientId": {
                            "type": "string",
                            "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                          },
                          "clientName": {
                            "type": "string",
                            "example": "Hello"
                          },
                          "clientSecret": {
                            "type": "string",
                            "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                          },
                          "redirectUris": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "example": [
                              "http://localhost:3000/auth/callback/ory"
                            ]
                          },
                          "grantTypes": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "example": [
                              "authorization_code",
                              "refresh_token"
                            ]
                          },
                          "responseTypes": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "example": [
                              "code",
                              "id_token"
                            ]
                          },
                          "scope": {
                            "type": "string",
                            "example": "offline_access openid email"
                          },
                          "audience": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "example": []
                          },
                          "policyUri": {
                            "type": "string",
                            "example": ""
                          },
                          "allowedCorsOrigins": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "example": []
                          },
                          "tosUri": {
                            "type": "string",
                            "example": ""
                          },
                          "clientUri": {
                            "type": "string",
                            "example": ""
                          },
                          "logoUri": {
                            "type": "string",
                            "example": ""
                          },
                          "tokenEndpointAuthMethod": {
                            "type": "string",
                            "example": "client_secret_post"
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time",
                            "example": "2025-02-24T08:14:40Z"
                          },
                          "updatedAt": {
                            "type": "string",
                            "format": "date-time",
                            "example": "2025-02-24T08:14:40.362463Z"
                          },
                          "postLogoutRedirectUris": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "example": [
                              "http://localhost:3000"
                            ]
                          },
                          "metadata": {
                            "type": "object",
                            "additionalProperties": true,
                            "example": {}
                          },
                          "authorizationCodeGrantAccessTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "authorizationCodeGrantIdTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "authorizationCodeGrantRefreshTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "clientCredentialsGrantAccessTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "implicitGrantAccessTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "implicitGrantIdTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "refreshTokenGrantIdTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "refreshTokenGrantAccessTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "refreshTokenGrantRefreshTokenLifespan": {
                            "type": "string",
                            "nullable": true,
                            "example": "1h0m0s"
                          },
                          "enableRefreshTokenRotation": {
                            "type": "boolean",
                            "example": false
                          }
                        }
                      }
                    },
                    "nextPaginationToken": {
                      "type": "string"
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Sessions Logout",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Sessions Logout\n",
    "operationId": "getOAuth2SessionsLogout",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "clientId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a"
        }
      },
      {
        "name": "idTokenHint",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "postLogoutRedirectUri",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "state",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Sessions Logout Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "redirectTo": {
                      "type": "string",
                      "example": "{apiDomain}/oauth/logout?..."
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Client\n",
    "operationId": "getOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "clientId",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "abcd"
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "summary": "Create OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Create OAuth2 Client\n",
    "operationId": "createOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              },
              "clientName": {
                "type": "string",
                "example": "Hello"
              },
              "clientSecret": {
                "type": "string",
                "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
              },
              "redirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000/auth/callback/ory"
                ]
              },
              "grantTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "authorization_code",
                  "refresh_token"
                ]
              },
              "responseTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "code",
                  "id_token"
                ]
              },
              "scope": {
                "type": "string",
                "example": "offline_access openid email"
              },
              "audience": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "policyUri": {
                "type": "string",
                "example": ""
              },
              "allowedCorsOrigins": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "tosUri": {
                "type": "string",
                "example": ""
              },
              "clientUri": {
                "type": "string",
                "example": ""
              },
              "logoUri": {
                "type": "string",
                "example": ""
              },
              "tokenEndpointAuthMethod": {
                "type": "string",
                "example": "client_secret_post"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40Z"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40.362463Z"
              },
              "postLogoutRedirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000"
                ]
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "example": {}
              },
              "authorizationCodeGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "clientCredentialsGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "enableRefreshTokenRotation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "summary": "Update OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Update OAuth2 Client\n",
    "operationId": "updateOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              },
              "clientName": {
                "type": "string",
                "example": "Hello"
              },
              "clientSecret": {
                "type": "string",
                "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
              },
              "redirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000/auth/callback/ory"
                ]
              },
              "grantTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "authorization_code",
                  "refresh_token"
                ]
              },
              "responseTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "code",
                  "id_token"
                ]
              },
              "scope": {
                "type": "string",
                "example": "offline_access openid email"
              },
              "audience": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "policyUri": {
                "type": "string",
                "example": ""
              },
              "allowedCorsOrigins": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "tosUri": {
                "type": "string",
                "example": ""
              },
              "clientUri": {
                "type": "string",
                "example": ""
              },
              "logoUri": {
                "type": "string",
                "example": ""
              },
              "tokenEndpointAuthMethod": {
                "type": "string",
                "example": "client_secret_post"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40Z"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40.362463Z"
              },
              "postLogoutRedirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000"
                ]
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "example": {}
              },
              "authorizationCodeGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "clientCredentialsGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "enableRefreshTokenRotation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Remove OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Remove OAuth2 Client\n",
    "operationId": "removeOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didExist": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Introspect OAuth2 Token",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Introspect OAuth2 Token\n",
    "operationId": "introspectOAuth2Token",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "token"
            ],
            "properties": {
              "token": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Token Introspection Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "active": {
                      "type": "boolean"
                    },
                    "iat": {
                      "type": "integer",
                      "example": 1740992368
                    },
                    "exp": {
                      "type": "integer",
                      "example": 1740995969
                    },
                    "client_id": {
                      "type": "string",
                      "example": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a"
                    },
                    "iss": {
                      "type": "string",
                      "example": "http://localhost:3001/auth"
                    },
                    "jti": {
                      "type": "string",
                      "example": "1c229efe-c55b-44c1-98cf-9fa3a366502e"
                    },
                    "nbf": {
                      "type": "integer",
                      "example": 1740992368
                    },
                    "scp": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "example": [
                        "openid",
                        "offline_access"
                      ]
                    },
                    "sub": {
                      "type": "string",
                      "example": "137d053d-0d69-4dea-8a19-06ddbdfa4f96"
                    },
                    "stt": {
                      "type": "integer",
                      "example": 1
                    },
                    "sessionHandle": {
                      "type": "string",
                      "example": "87bcc2d8-f159-4e10-a097-0898179a2d7d"
                    },
                    "rsub": {
                      "type": "string",
                      "example": "137d053d-0d69-4dea-8a19-06ddbdfa4f96"
                    },
                    "tId": {
                      "type": "string",
                      "example": "public"
                    },
                    "gid": {
                      "type": "string",
                      "example": "575b7130-d982-4945-be49-3ecde2a49eaa"
                    },
                    "token_type": {
                      "type": "string",
                      "example": "Bearer"
                    },
                    "token_use": {
                      "type": "string",
                      "example": "access_token"
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Revoke OAuth2 Session",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Revoke OAuth2 Session\n",
    "operationId": "revokeOAuth2Session",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "sessionHandle": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Session Revocation Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didExist": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Get OAuth2 Token",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Token\n",
    "operationId": "getOAuth2Token",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "iss": {
                "type": "string",
                "example": "https://api.auth.com"
              },
              "inputBody": {
                "type": "object",
                "example": {}
              },
              "useStaticSigningKey": {
                "type": "boolean",
                "example": false
              },
              "authorizationHeader": {
                "type": "string",
                "example": "Bearer 1234567890"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Token Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "required": [
                    "status",
                    "access_token"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "access_token": {
                      "type": "string",
                      "example": "eyJraWQiOiJzLTBjZmVmMDdkLWQ2NDktNGIwOC04MTVjLWJkYjZlYTczNWQyZCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpYXQiOjE3NDAzODU5MzcsImV4cCI6MTc0MDM4OTUzOCwiY2xpZW50X2lkIjoic3RjbF82NWUwODc1Mi0yYzU5LTQ5NjQtOTM0Yy02OTIwZDJmMDZlNjIiLCJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDEvYXV0aCIsImp0aSI6Ijc1NTc2MmFmLTUwYTUtNDc1ZS04YWRkLTg3MDA1ZmU3YWJlNiIsIm5iZiI6MTc0MDM4NTkzNywic2NwIjpbIm9wZW5pZCIsIm9mZmxpbmVfYWNjZXNzIl0sInN1YiI6InNvbWV1c2VyaWQiLCJzdHQiOjEsImdpZCI6ImRjOGQ0OGUzLTcwOTgtNDhhNi1hYjU0LTgxMWMyODQ4N2I4MiIsInRJZCI6InB1YmxpYyIsInJzdWIiOiJzb21ldXNlcmlkIiwic2Vzc2lvbkhhbmRsZSI6InNlc3Npb24taGFuZGxlIn0.DgVgtD2gXgzHrDsC2lIUBa-wsYm8KO4Pg8L1Ov3aSBVgjwtjiCO40ldjBZ9qKdQBq5Qqk0ElAZNj6Bzc40ESfQumLH3_N2XtOj568s71JPuEOIg5hs9XAdK4vYfXMhVQRWn9iPUKHKrpRVf73IIH0mpkN8i6_MhcDoMMOuG5XPlXajG9VOyoY_5saHA61-uTafZLdAgKqnmYGvS8KmNEcEbBWLGwFB4QQKiDAUvatIi5n3juFBUxyt9t6DrqT1D04shesRppa0XhCZbCFBv1dixSrprdtqKhlPOrMgvOGNZ3cBLbYBOG9zoJRD5YlVMGw-j_pE7IbvpDWKL7tTJS1Q"
                    },
                    "expires_in": {
                      "type": "integer",
                      "example": 3599
                    },
                    "id_token": {
                      "type": "string",
                      "example": "eyJraWQiOiJzLTBjZmVmMDdkLWQ2NDktNGIwOC04MTVjLWJkYjZlYTczNWQyZCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpYXQiOjE3NDAzODU5MzgsImV4cCI6MTc0MDM4OTUzOCwiYXRfaGFzaCI6IkNxOGNCSk01Nm5FcG9aaWREcnZvLVEiLCJhdWQiOiJzdGNsXzY1ZTA4NzUyLTJjNTktNDk2NC05MzRjLTY5MjBkMmYwNmU2MiIsImF1dGhfdGltZSI6MTc0MDM4NTkzNywiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDozMDAxL2F1dGgiLCJqdGkiOiIxZDA5OGUxZi04ZGIxLTQyNzUtYmMzYS0zYTA4NjdjOWE2NTAiLCJyYXQiOjE3NDAzODU3MzEsInNpZCI6InNlc3Npb24taGFuZGxlIiwic3ViIjoic29tZXVzZXJpZCIsInN0dCI6MiwiZ2lkIjoiYzk1OTVjYjItMWFjOS00MDI0LWFjNjMtNDJlZDEyODliY2RmIn0.PGsemf1qpLF-cE_616NHvKsRmanFiyba0yqF2j5fy87AWD5McI405A4eqi-wAlKsDxC-MPpuW8bx-08YUhs3x6ku4aFaDyA-M-Xhc65fJJ4SCPVaUL7qlUwl7wJwNs2rMRW3Ayyj4MDSlW5uqm39_K_bBqod2Qj1yqck-N0g78qh86uEcyX6Al3d5KSln1B21nwDsEgegk3xzE8lFMCQUTpZEYb5-1v2D0Bu_PblBfOCjA6mBtT1IIQkmSE27FvkTUS1H50EUyhFP4JH30kP3bUnQ9pOqGMTe405N2ruKtPyWsXHLPlQ4hcJCLO5GT5ZgtUjfz6Y3mCM9l69uDYDHg"
                    },
                    "refresh_token": {
                      "type": "string",
                      "example": "st_rt_d7LI9mGYHF2TAaVEFJi7fqOWo8ZQ8zEGpuxhHQs0R18.UZ0nbTuuYuDD8G54PCD8AKHdsh9cezu8BTxVlTy7pYw"
                    },
                    "scope": {
                      "type": "string",
                      "example": "openid offline_access"
                    },
                    "token_type": {
                      "type": "string",
                      "example": "bearer"
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Revoke OAuth2 Token",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Revoke OAuth2 Token\n",
    "operationId": "revokeOAuth2Token",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "token": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Token Revocation Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didExist": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Revoke OAuth2 Token",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Revoke OAuth2 Token\n",
    "operationId": "revokeOAuth2Tokens",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "client_id": {
                "type": "string",
                "example": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Token Revocation Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didExist": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Accept OAuth2 Consent Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Accept OAuth2 Consent Request\n",
    "operationId": "acceptOAuth2ConsentRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "consentChallenge",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "context": {
                "type": "object"
              },
              "grantAccessTokenAudience": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "grantScope": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "handledAt": {
                "type": "string",
                "format": "date-time",
                "example": "2019-08-24T14:15:22Z"
              },
              "remember": {
                "type": "boolean"
              },
              "rememberFor": {
                "type": "integer"
              },
              "session": {
                "type": "object",
                "properties": {
                  "accessToken": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "idToken": {
                    "type": "object",
                    "additionalProperties": true
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Consent Request Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "redirectTo": {
                      "type": "string",
                      "example": "{apiDomain}/oauth/consent?..."
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Reject OAuth2 Consent Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Reject OAuth2 Consent Request\n",
    "operationId": "rejectOAuth2ConsentRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "consentChallenge",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "errorDebug": {
                "type": "string"
              },
              "errorDescription": {
                "type": "string"
              },
              "errorHint": {
                "type": "string"
              },
              "statusCode": {
                "type": "integer",
                "example": 400
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Consent Request Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "redirectTo": {
                      "type": "string",
                      "example": "{apiDomain}/oauth/consent?..."
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Accept OAuth2 Login Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Accept OAuth2 Login Request\n",
    "operationId": "acceptOAuth2LoginRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "loginChallenge",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "subject"
            ],
            "properties": {
              "acr": {
                "type": "string"
              },
              "amr": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "context": {
                "type": "string",
                "nullable": true
              },
              "extendSessionLifespan": {
                "type": "boolean",
                "example": true
              },
              "forceSubjectIdentifier": {
                "type": "string"
              },
              "identityProviderSessionId": {
                "type": "string"
              },
              "remember": {
                "type": "boolean",
                "example": true
              },
              "rememberFor": {
                "type": "integer",
                "example": 0
              },
              "subject": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Login Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "redirectTo": {
                      "type": "string",
                      "example": "{apiDomain}/oauth/login?..."
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Reject OAuth2 Login Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Reject OAuth2 Login Request\n",
    "operationId": "rejectOAuth2LoginRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "loginChallenge",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "1234567890"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "errorDebug": {
                "type": "string"
              },
              "errorDescription": {
                "type": "string"
              },
              "errorHint": {
                "type": "string"
              },
              "statusCode": {
                "type": "integer",
                "example": 0
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Login Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "redirectTo": {
                      "type": "string",
                      "example": "{apiDomain}/oauth/login?..."
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Accept OAuth2 Logout Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Accept OAuth2 Logout Request\n",
    "operationId": "acceptOAuth2LogoutRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "challenge": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Logout Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "redirectTo": {
                      "type": "string",
                      "example": "{apiDomain}/oauth/logout?..."
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "summary": "Reject OAuth2 Logout Request",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Reject OAuth2 Logout Request\n",
    "operationId": "rejectOAuth2LogoutRequest",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "challenge": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Logout Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Get OAuth2 Client\n",
    "operationId": "getOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "clientId",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "abcd"
      }
    ],
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "post": {
    "summary": "Create OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Create OAuth2 Client\n",
    "operationId": "createOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              },
              "clientName": {
                "type": "string",
                "example": "Hello"
              },
              "clientSecret": {
                "type": "string",
                "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
              },
              "redirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000/auth/callback/ory"
                ]
              },
              "grantTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "authorization_code",
                  "refresh_token"
                ]
              },
              "responseTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "code",
                  "id_token"
                ]
              },
              "scope": {
                "type": "string",
                "example": "offline_access openid email"
              },
              "audience": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "policyUri": {
                "type": "string",
                "example": ""
              },
              "allowedCorsOrigins": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "tosUri": {
                "type": "string",
                "example": ""
              },
              "clientUri": {
                "type": "string",
                "example": ""
              },
              "logoUri": {
                "type": "string",
                "example": ""
              },
              "tokenEndpointAuthMethod": {
                "type": "string",
                "example": "client_secret_post"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40Z"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40.362463Z"
              },
              "postLogoutRedirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000"
                ]
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "example": {}
              },
              "authorizationCodeGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "clientCredentialsGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "enableRefreshTokenRotation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "summary": "Update OAuth2 Client",
    "tags": [
      "OAuth2Provider Recipe"
    ],
    "description": "Update OAuth2 Client\n",
    "operationId": "updateOAuth2Client",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/oauthRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "clientId": {
                "type": "string",
                "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
              },
              "clientName": {
                "type": "string",
                "example": "Hello"
              },
              "clientSecret": {
                "type": "string",
                "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
              },
              "redirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000/auth/callback/ory"
                ]
              },
              "grantTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "authorization_code",
                  "refresh_token"
                ]
              },
              "responseTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "code",
                  "id_token"
                ]
              },
              "scope": {
                "type": "string",
                "example": "offline_access openid email"
              },
              "audience": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "policyUri": {
                "type": "string",
                "example": ""
              },
              "allowedCorsOrigins": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": []
              },
              "tosUri": {
                "type": "string",
                "example": ""
              },
              "clientUri": {
                "type": "string",
                "example": ""
              },
              "logoUri": {
                "type": "string",
                "example": ""
              },
              "tokenEndpointAuthMethod": {
                "type": "string",
                "example": "client_secret_post"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40Z"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-02-24T08:14:40.362463Z"
              },
              "postLogoutRedirectUris": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "http://localhost:3000"
                ]
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "example": {}
              },
              "authorizationCodeGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "authorizationCodeGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "clientCredentialsGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "implicitGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantIdTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantAccessTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "refreshTokenGrantRefreshTokenLifespan": {
                "type": "string",
                "nullable": true,
                "example": "1h0m0s"
              },
              "enableRefreshTokenRotation": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OAuth2 Client Result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "enum": [
                            "OK"
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "clientId": {
                          "type": "string",
                          "example": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb"
                        },
                        "clientName": {
                          "type": "string",
                          "example": "Hello"
                        },
                        "clientSecret": {
                          "type": "string",
                          "example": "T98n1YIMWqr4wOM.~bV4HOPFmO"
                        },
                        "redirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000/auth/callback/ory"
                          ]
                        },
                        "grantTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "authorization_code",
                            "refresh_token"
                          ]
                        },
                        "responseTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "code",
                            "id_token"
                          ]
                        },
                        "scope": {
                          "type": "string",
                          "example": "offline_access openid email"
                        },
                        "audience": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "policyUri": {
                          "type": "string",
                          "example": ""
                        },
                        "allowedCorsOrigins": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": []
                        },
                        "tosUri": {
                          "type": "string",
                          "example": ""
                        },
                        "clientUri": {
                          "type": "string",
                          "example": ""
                        },
                        "logoUri": {
                          "type": "string",
                          "example": ""
                        },
                        "tokenEndpointAuthMethod": {
                          "type": "string",
                          "example": "client_secret_post"
                        },
                        "createdAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40Z"
                        },
                        "updatedAt": {
                          "type": "string",
                          "format": "date-time",
                          "example": "2025-02-24T08:14:40.362463Z"
                        },
                        "postLogoutRedirectUris": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "example": [
                            "http://localhost:3000"
                          ]
                        },
                        "metadata": {
                          "type": "object",
                          "additionalProperties": true,
                          "example": {}
                        },
                        "authorizationCodeGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "authorizationCodeGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "clientCredentialsGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "implicitGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantIdTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantAccessTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "refreshTokenGrantRefreshTokenLifespan": {
                          "type": "string",
                          "nullable": true,
                          "example": "1h0m0s"
                        },
                        "enableRefreshTokenRotation": {
                          "type": "boolean",
                          "example": false
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "object",
                  "required": [
                    "status",
                    "error",
                    "errorDescription",
                    "statusCode"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OAUTH_ERROR"
                      ]
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorDescription": {
                      "type": "string"
                    },
                    "statusCode": {
                      "type": "integer"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "402": {
        "description": "error code 402",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "License Error"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessListCodes",
    "summary": "List passwordless codes",
    "description": "Lists all active passwordless codes of the user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "description": "Use this parameter to get information about all devices associated with an email (without the other query params)",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "phoneNumber",
        "description": "Use this parameter to get information about all devices associated with a phoneNumber (without the other query params)",
        "schema": {
          "type": "string",
          "example": "+14155552671"
        }
      },
      {
        "in": "query",
        "name": "deviceId",
        "description": "Use this parameter to get information about a single device (without the other query params)",
        "schema": {
          "type": "string",
          "description": "A random identifier that should be stored on the device that started the sign in process.",
          "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
        }
      },
      {
        "in": "query",
        "name": "preAuthSessionId",
        "description": "Use this parameter to get information about a single device (without the other query params)",
        "schema": {
          "type": "string",
          "description": "A random identifier that can be used to identify the login attempt/device.",
          "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
        }
      }
    ],
    "responses": {
      "200": {
        "description": "List of all active passwordless codes of the user",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "devices": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "preAuthSessionId": {
                        "type": "string",
                        "description": "A random identifier that can be used to identify the login attempt/device.",
                        "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                      },
                      "failedCodeInputAttemptCount": {
                        "type": "number",
                        "example": 2
                      },
                      "email": {
                        "type": "string",
                        "example": "johndoe@gmail.com"
                      },
                      "phoneNumber": {
                        "type": "string",
                        "example": "+14155552671"
                      },
                      "codes": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "codeId": {
                              "type": "string",
                              "description": "Uniquely identifies a code",
                              "example": "QZ0Mx9zG9cfqNXmPI0I/67r9bpKghUBDQZeMMbayi+I="
                            },
                            "timeCreated": {
                              "type": "number",
                              "example": 1637262633029
                            },
                            "codeLifetime": {
                              "type": "number",
                              "description": "The maximum lifetime of the code in milliseconds",
                              "example": 900000
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessGetUser",
    "summary": "Get passwordless user",
    "deprecated": true,
    "description": "Get a user's information.\n\nAPI is tenant specific if querying by email or phone number.\nIf querying by userId, tenantId will be ignored.\n\nNote that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      },
      {
        "in": "query",
        "name": "email",
        "description": "Use exactly one of phoneNumber, email or userId",
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      },
      {
        "in": "query",
        "name": "phoneNumber",
        "description": "Use exactly one of phoneNumber, email or userId",
        "schema": {
          "type": "string",
          "example": "+14155552671"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get a user's information.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR",
                        "UNKNOWN_EMAIL_ERROR",
                        "UNKNOWN_PHONE_NUMBER_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessPutUser",
    "summary": "Update passwordless user",
    "description": "Update a user's information.\nIf the email or phoneNumber is set to null the previous value will be deleted. If they are not set (i.e., undefined/missing from the request), they are left as-is.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com",
                "nullable": true
              },
              "phoneNumber": {
                "type": "string",
                "example": "+14155552671",
                "nullable": true
              }
            },
            "required": [
              "userId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "update user's information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "UNKNOWN_USER_ID_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR",
                        "PHONE_NUMBER_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_CHANGE_NOT_ALLOWED_ERROR",
                        "PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessStartSignIn",
    "summary": "Start passwordless sign in",
    "description": "Starts a sign in process by requesting a linkCode and a deviceId + userInputCode combination the user can use to sign in.\nPassing the optional deviceId signifies a resend code flow.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "title": "Email Sign In",
                "description": "Request to start email-based sign in",
                "properties": {
                  "email": {
                    "type": "string",
                    "example": "johndoe@gmail.com"
                  },
                  "userInputCode": {
                    "type": "string",
                    "description": "This can be used to authenticate the user when paired with the deviceId",
                    "example": 456123
                  }
                },
                "example": {
                  "email": "test@example.com"
                },
                "required": [
                  "email"
                ]
              },
              {
                "type": "object",
                "title": "Phone Sign In",
                "description": "Request to start phone-based sign in",
                "properties": {
                  "phoneNumber": {
                    "type": "string",
                    "example": "+14155552671"
                  },
                  "userInputCode": {
                    "type": "string",
                    "description": "This can be used to authenticate the user when paired with the deviceId",
                    "example": 456123
                  }
                },
                "required": [
                  "phoneNumber"
                ]
              },
              {
                "type": "object",
                "title": "Resend Code",
                "description": "Request to resend code to existing device",
                "properties": {
                  "deviceId": {
                    "type": "string",
                    "description": "A random identifier that should be stored on the device that started the sign in process.",
                    "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
                  },
                  "userInputCode": {
                    "type": "string",
                    "description": "This can be used to authenticate the user when paired with the deviceId",
                    "example": 456123
                  }
                },
                "required": [
                  "deviceId"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Starts the passwordless login process",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "preAuthSessionId": {
                      "type": "string",
                      "description": "A random identifier that can be used to identify the login attempt/device.",
                      "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                    },
                    "codeId": {
                      "type": "string",
                      "description": "Uniquely identifies a code",
                      "example": "QZ0Mx9zG9cfqNXmPI0I/67r9bpKghUBDQZeMMbayi+I="
                    },
                    "deviceId": {
                      "type": "string",
                      "description": "A random identifier that should be stored on the device that started the sign in process.",
                      "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
                    },
                    "userInputCode": {
                      "type": "string",
                      "description": "This can be used to authenticate the user when paired with the deviceId",
                      "example": 456123
                    },
                    "linkCode": {
                      "type": "string",
                      "description": "URL-safe string that can be used to authenticate the user, without the deviceId",
                      "example": "b10lbT_SnDC4flA6Fn7pE5TtG5k5NfigLef4QMBeGA8"
                    },
                    "timeCreated": {
                      "type": "number",
                      "example": 1637262633029
                    },
                    "codeLifetime": {
                      "type": "number",
                      "description": "The maximum lifetime of the code in milliseconds",
                      "example": 900000
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RESTART_FLOW_ERROR",
                        "USER_INPUT_CODE_ALREADY_USED_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessCheckCode",
    "summary": "Check passwordless code",
    "description": "Tries to check if the passed userInputCode+deviceId combo or the linkCode is valid\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "title": "Link Code Check",
                "description": "Request to check a link code",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "A random identifier that can be used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  },
                  "linkCode": {
                    "type": "string",
                    "description": "URL-safe string that can be used to authenticate the user, without the deviceId",
                    "example": "b10lbT_SnDC4flA6Fn7pE5TtG5k5NfigLef4QMBeGA8"
                  }
                },
                "required": [
                  "preAuthSessionId",
                  "linkCode"
                ]
              },
              {
                "type": "object",
                "title": "User Input Code Check",
                "description": "Request to check a user input code",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "A random identifier that can be used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  },
                  "deviceId": {
                    "type": "string",
                    "description": "A random identifier that should be stored on the device that started the sign in process.",
                    "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
                  },
                  "userInputCode": {
                    "type": "string",
                    "description": "This can be used to authenticate the user when paired with the deviceId",
                    "example": 456123
                  }
                },
                "required": [
                  "preAuthSessionId",
                  "deviceId",
                  "userInputCode"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Code Check Success",
                  "description": "Response when code is valid",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "consumedDevice": {
                      "type": "object",
                      "description": "Information about the consumed device",
                      "required": [
                        "preAuthSessionId",
                        "failedCodeInputAttemptCount"
                      ],
                      "properties": {
                        "preAuthSessionId": {
                          "type": "string",
                          "description": "A random identifier that can be used to identify the login attempt/device.",
                          "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                        },
                        "failedCodeInputAttemptCount": {
                          "type": "number",
                          "description": "Number of failed code input attempts",
                          "example": 2
                        },
                        "email": {
                          "type": "string",
                          "example": "johndoe@gmail.com"
                        },
                        "phoneNumber": {
                          "type": "string",
                          "example": "+14155552671"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Invalid Code Error",
                  "description": "Response when code is invalid or expired",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INCORRECT_USER_INPUT_CODE_ERROR",
                        "EXPIRED_USER_INPUT_CODE_ERROR"
                      ]
                    },
                    "failedCodeInputAttemptCount": {
                      "type": "number",
                      "description": "Number of failed code input attempts",
                      "example": 2
                    },
                    "maximumCodeInputAttempts": {
                      "type": "number",
                      "description": "Maximum allowed code input attempts",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Restart Flow Error",
                  "description": "Response when flow needs to be restarted",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RESTART_FLOW_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessTryUseCode",
    "summary": "Consume passwordless code",
    "description": "Tries to consume the passed userInputCode+deviceId combo or the linkCode to sign the user in\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "title": "Link Code Consume",
                "description": "Request to consume a link code",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "A random identifier that can be used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  },
                  "linkCode": {
                    "type": "string",
                    "description": "URL-safe string that can be used to authenticate the user, without the deviceId",
                    "example": "b10lbT_SnDC4flA6Fn7pE5TtG5k5NfigLef4QMBeGA8"
                  }
                },
                "required": [
                  "preAuthSessionId",
                  "linkCode"
                ]
              },
              {
                "type": "object",
                "title": "User Input Code Consume",
                "description": "Request to consume a user input code",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "A random identifier that can be used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  },
                  "deviceId": {
                    "type": "string",
                    "description": "A random identifier that should be stored on the device that started the sign in process.",
                    "example": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk="
                  },
                  "userInputCode": {
                    "type": "string",
                    "description": "This can be used to authenticate the user when paired with the deviceId",
                    "example": 456123
                  }
                },
                "required": [
                  "preAuthSessionId",
                  "deviceId",
                  "userInputCode"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Indicates success with the status property",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "title": "Code Consume Success",
                  "description": "Response when code is consumed successfully",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "createdNewUser": {
                      "type": "boolean",
                      "description": "Indicates if a new user was created",
                      "example": true
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "consumedDevice": {
                      "type": "object",
                      "description": "Information about the consumed device",
                      "required": [
                        "preAuthSessionId",
                        "failedCodeInputAttemptCount"
                      ],
                      "properties": {
                        "preAuthSessionId": {
                          "type": "string",
                          "description": "A random identifier that can be used to identify the login attempt/device.",
                          "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                        },
                        "failedCodeInputAttemptCount": {
                          "type": "number",
                          "description": "Number of failed code input attempts",
                          "example": 2
                        },
                        "email": {
                          "type": "string",
                          "example": "johndoe@gmail.com"
                        },
                        "phoneNumber": {
                          "type": "string",
                          "example": "+14155552671"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Invalid Code Error",
                  "description": "Response when code is invalid or expired",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INCORRECT_USER_INPUT_CODE_ERROR",
                        "EXPIRED_USER_INPUT_CODE_ERROR"
                      ]
                    },
                    "failedCodeInputAttemptCount": {
                      "type": "number",
                      "description": "Number of failed code input attempts",
                      "example": 2
                    },
                    "maximumCodeInputAttempts": {
                      "type": "number",
                      "description": "Maximum allowed code input attempts",
                      "example": 5
                    }
                  }
                },
                {
                  "type": "object",
                  "title": "Restart Flow Error",
                  "description": "Response when flow needs to be restarted",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RESTART_FLOW_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessRevokeCode",
    "summary": "Revoke passwordless code",
    "description": "Revokes a code by id\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "codeId": {
                    "type": "string",
                    "description": "Uniquely identifies a code",
                    "example": "QZ0Mx9zG9cfqNXmPI0I/67r9bpKghUBDQZeMMbayi+I="
                  }
                },
                "required": [
                  "codeId"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "preAuthSessionId": {
                    "type": "string",
                    "description": "A random identifier that can be used to identify the login attempt/device.",
                    "example": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs="
                  }
                },
                "required": [
                  "preAuthSessionId"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessRevokeAllCodesOfUser",
    "summary": "Revoke all user codes",
    "description": "Revokes all codes issued for the user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "example": "johndoe@gmail.com"
                  }
                },
                "required": [
                  "email"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "phoneNumber": {
                    "type": "string",
                    "example": "+14155552671"
                  }
                },
                "required": [
                  "phoneNumber"
                ]
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessGetUser",
    "summary": "Get passwordless user",
    "deprecated": true,
    "description": "Get a user's information.\n\nAPI is tenant specific if querying by email or phone number.\nIf querying by userId, tenantId will be ignored.\n\nNote that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      },
      {
        "in": "query",
        "name": "email",
        "description": "Use exactly one of phoneNumber, email or userId",
        "schema": {
          "type": "string",
          "example": "johndoe@gmail.com"
        }
      },
      {
        "in": "query",
        "name": "phoneNumber",
        "description": "Use exactly one of phoneNumber, email or userId",
        "schema": {
          "type": "string",
          "example": "+14155552671"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get a user's information.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR",
                        "UNKNOWN_EMAIL_ERROR",
                        "UNKNOWN_PHONE_NUMBER_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Passwordless Recipe"
    ],
    "operationId": "passwordlessPutUser",
    "summary": "Update passwordless user",
    "description": "Update a user's information.\nIf the email or phoneNumber is set to null the previous value will be deleted. If they are not set (i.e., undefined/missing from the request), they are left as-is.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "passwordless",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com",
                "nullable": true
              },
              "phoneNumber": {
                "type": "string",
                "example": "+14155552671",
                "nullable": true
              }
            },
            "required": [
              "userId"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "update user's information",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "UNKNOWN_USER_ID_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR",
                        "PHONE_NUMBER_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_CHANGE_NOT_ALLOWED_ERROR",
                        "PHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "Session Recipe"
    ],
    "operationId": "getJWTData",
    "summary": "Get JWT data",
    "description": "Get JWT data for a session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "sessionHandle",
        "description": "Users session handle",
        "schema": {
          "type": "string",
          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get JWT Data",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userDataInJWT": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "putJWTData",
    "summary": "Update JWT data",
    "description": "Change JWT data for a session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "sessionHandle": {
                "type": "string",
                "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
              },
              "userDataInJWT": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Change JWT Data for a session",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "getUserSessionHandles",
    "summary": "Get user session handles",
    "description": "Get session handles for a user\n\nBy default, the session handles are fetched across all tenants. Set `fetchAcrossAllTenants` to `false` to get sessionHandles for the user for a particular tenant.\n\nNote: If `fetchAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      },
      {
        "name": "fetchAcrossAllTenants",
        "schema": {
          "type": "string",
          "enum": [
            "true",
            "false"
          ]
        },
        "required": false,
        "in": "query"
      }
    ],
    "responses": {
      "200": {
        "description": "Get user Session Handles",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "sessionHandles": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "getSessionInfo",
    "summary": "Get session info",
    "description": "Get user and session information for a given session handle\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "sessionHandle",
        "schema": {
          "type": "string",
          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get user and session information for a given session handle",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userDataInDatabase": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    },
                    "userDataInJWT": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    },
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "expiry": {
                      "type": "number",
                      "example": 1637262633029
                    },
                    "timeCreated": {
                      "type": "number",
                      "example": 1637262633029
                    },
                    "sessionHandle": {
                      "type": "string",
                      "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                    },
                    "tenantId": {
                      "type": "string",
                      "example": "customer1"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "Session Recipe"
    ],
    "operationId": "getSessionData",
    "summary": "Get session data",
    "description": "Get session data\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "sessionHandle",
        "description": "Users session handle",
        "schema": {
          "type": "string",
          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get Session Data",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userDataInDatabase": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "putSessionData",
    "summary": "Update session data",
    "description": "Change session data\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "sessionHandle": {
                "type": "string",
                "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
              },
              "userDataInDatabase": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Change Session Data",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "createNewSession",
    "summary": "Create new session",
    "description": "Create a new Session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "userDataInJWT": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              },
              "userDataInDatabase": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              },
              "enableAntiCsrf": {
                "type": "boolean",
                "example": false
              },
              "useDynamicSigningKey": {
                "type": "boolean",
                "description": "Decides if the token should be signed with a dynamic or static key, defaults to true",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create a new Session",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "session": {
                  "type": "object",
                  "properties": {
                    "handle": {
                      "type": "string",
                      "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                    },
                    "userId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    },
                    "userDataInJWT": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    },
                    "tenantId": {
                      "type": "string",
                      "example": "customer1"
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    }
                  }
                },
                "accessToken": {
                  "type": "object",
                  "properties": {
                    "token": {
                      "type": "string",
                      "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                    },
                    "expiry": {
                      "type": "number",
                      "example": 1637262633029
                    },
                    "createdTime": {
                      "type": "number",
                      "example": 1637262633029
                    }
                  }
                },
                "refreshToken": {
                  "type": "object",
                  "properties": {
                    "token": {
                      "type": "string",
                      "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                    },
                    "expiry": {
                      "type": "number",
                      "example": 1637262633029
                    },
                    "createdTime": {
                      "type": "number",
                      "example": 1637262633029
                    }
                  }
                },
                "antiCsrfToken": {
                  "type": "string",
                  "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "deleteSession",
    "summary": "Delete session",
    "description": "Delete a sesion\n\nIf revoking session by `userId`, the sessions are cleared across all tenants by default.\n\nNote: If `revokeAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "sessionHandles": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                    }
                  }
                }
              },
              {
                "type": "object",
                "required": [
                  "userId"
                ],
                "properties": {
                  "userId": {
                    "type": "string",
                    "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                  },
                  "revokeAcrossAllTenants": {
                    "type": "boolean"
                  }
                }
              }
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Delete a session",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "sessionHandlesRevoked": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "JWT Recipe"
    ],
    "operationId": "createSignedJWT",
    "summary": "Create signed JWT",
    "description": "Create a signed JWT\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "jwt",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "payload": {
                "type": "object",
                "description": "The payload of the JWT, should be a JSON object.",
                "example": {
                  "custom-claim": ""
                }
              },
              "algorithm": {
                "type": "string",
                "description": "The algorithm to use when creating the JWT.",
                "enum": [
                  "RS256"
                ]
              },
              "jwksDomain": {
                "type": "string",
                "description": "This is used as the value for the issuer claim in the JWT payload.",
                "example": "https://api.test.com/"
              },
              "validity": {
                "type": "number",
                "description": "Duration in seconds, used to calculate JWT expiry",
                "example": 86400
              },
              "useStaticSigningKey": {
                "type": "boolean",
                "description": "Decides if the token should be signed with a dynamic or static key, defaults to true",
                "example": true
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Create a signed JWT",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "jwt": {
                      "type": "string",
                      "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNSUPPORTED_ALGORITHM_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "refreshSession",
    "summary": "Refresh session",
    "description": "Refresh a Session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "refreshToken": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              },
              "enableAntiCsrf": {
                "type": "boolean",
                "example": false
              },
              "antiCsrfToken": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              },
              "useDynamicSigningKey": {
                "type": "boolean"
              }
            },
            "required": [
              "refreshToken",
              "enableAntiCsrf",
              "useDynamicSigningKey"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Refresh a session",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "session": {
                      "type": "object",
                      "properties": {
                        "handle": {
                          "type": "string",
                          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                        },
                        "userId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "userDataInJWT": {
                          "type": "object",
                          "description": "should be a JSON object (not a JSON literal nor an array)",
                          "example": {
                            "test": 123
                          }
                        },
                        "tenantId": {
                          "type": "string",
                          "example": "customer1"
                        },
                        "recipeUserId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        }
                      }
                    },
                    "accessToken": {
                      "type": "object",
                      "properties": {
                        "token": {
                          "type": "string",
                          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                        },
                        "expiry": {
                          "type": "number",
                          "example": 1637262633029
                        },
                        "createdTime": {
                          "type": "number",
                          "example": 1637262633029
                        }
                      }
                    },
                    "refreshToken": {
                      "type": "object",
                      "properties": {
                        "token": {
                          "type": "string",
                          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                        },
                        "expiry": {
                          "type": "number",
                          "example": 1637262633029
                        },
                        "createdTime": {
                          "type": "number",
                          "example": 1637262633029
                        }
                      }
                    },
                    "antiCsrfToken": {
                      "type": "string",
                      "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "TOKEN_THEFT_DETECTED"
                      ]
                    },
                    "session": {
                      "type": "object",
                      "properties": {
                        "handle": {
                          "type": "string",
                          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                        },
                        "userId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "regenerateSession",
    "summary": "Regenerate session",
    "description": "Regenerate a session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "accessToken": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              },
              "userDataInJWT": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Regenerate user session",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "session": {
                      "type": "object",
                      "properties": {
                        "handle": {
                          "type": "string",
                          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                        },
                        "userId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "userDataInJWT": {
                          "type": "object",
                          "description": "should be a JSON object (not a JSON literal nor an array)",
                          "example": {
                            "test": 123
                          }
                        },
                        "tenantId": {
                          "type": "string",
                          "example": "customer1"
                        },
                        "recipeUserId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        }
                      }
                    },
                    "accessToken": {
                      "type": "object",
                      "properties": {
                        "token": {
                          "type": "string",
                          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                        },
                        "expiry": {
                          "type": "number",
                          "example": 1637262633029
                        },
                        "createdTime": {
                          "type": "number",
                          "example": 1637262633029
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "verifySession",
    "summary": "Verify session",
    "description": "Verify a Session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "accessToken": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              },
              "enableAntiCsrf": {
                "type": "boolean",
                "example": false
              },
              "doAntiCsrfCheck": {
                "type": "boolean",
                "example": false
              },
              "checkDatabase": {
                "type": "boolean",
                "description": "Decides if we always check if the session exists in the DB or just do token validation, defaults to false.",
                "example": false
              },
              "antiCsrfToken": {
                "type": "string",
                "example": "ZTRiOTBjNz...jI5MTZlODkxw"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Verify a session",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "session": {
                      "type": "object",
                      "properties": {
                        "handle": {
                          "type": "string",
                          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
                        },
                        "userId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "userDataInJWT": {
                          "type": "object",
                          "description": "should be a JSON object (not a JSON literal nor an array)",
                          "example": {
                            "test": 123
                          }
                        },
                        "tenantId": {
                          "type": "string",
                          "example": "customer1"
                        },
                        "recipeUserId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        }
                      }
                    },
                    "accessToken": {
                      "type": "object",
                      "properties": {
                        "token": {
                          "type": "string",
                          "example": "ZTRiOTBjNz...jI5MTZlODkxw"
                        },
                        "expiry": {
                          "type": "number",
                          "example": 1637262633029
                        },
                        "createdTime": {
                          "type": "number",
                          "example": 1637262633029
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "TRY_REFRESH_TOKEN"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "Session Recipe"
    ],
    "operationId": "getJWTData",
    "summary": "Get JWT data",
    "description": "Get JWT data for a session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "sessionHandle",
        "description": "Users session handle",
        "schema": {
          "type": "string",
          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get JWT Data",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userDataInJWT": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "putJWTData",
    "summary": "Update JWT data",
    "description": "Change JWT data for a session\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "sessionHandle": {
                "type": "string",
                "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
              },
              "userDataInJWT": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Change JWT Data for a session",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "deprecated": true,
    "tags": [
      "Session Recipe"
    ],
    "operationId": "getSessionData",
    "summary": "Get session data",
    "description": "Get session data\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "sessionHandle",
        "description": "Users session handle",
        "schema": {
          "type": "string",
          "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get Session Data",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "userDataInDatabase": {
                      "type": "object",
                      "description": "should be a JSON object (not a JSON literal nor an array)",
                      "example": {
                        "test": 123
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "Session Recipe"
    ],
    "operationId": "putSessionData",
    "summary": "Update session data",
    "description": "Change session data\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "session",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "sessionHandle": {
                "type": "string",
                "example": "68en6gd6-865b-4af6-ba00-96e5c153257d"
              },
              "userDataInDatabase": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "test": 123
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Change Session Data",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNAUTHORISED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "example": "Error Message"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "ThirdParty Recipe"
    ],
    "operationId": "thirdPartyGetUser",
    "summary": "Get third party user",
    "deprecated": true,
    "description": "Get a user's information.\n\nAPI is tenant specific if querying by email.\nIf querying by userId, tenantId will be ignored.\n\nNote that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "thirdparty",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      },
      {
        "in": "query",
        "name": "thirdPartyId",
        "description": "Either use userId or thirdPartyId and thirdPartyUserId",
        "schema": {
          "type": "string",
          "example": "google"
        }
      },
      {
        "in": "query",
        "name": "thirdPartyUserId",
        "description": "Either use userId or thirdPartyId and thirdPartyUserId",
        "schema": {
          "type": "string",
          "example": 106347997792363870000
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get a user's information.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR",
                        "UNKNOWN_THIRD_PARTY_USER_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "operationId": "thirdPartyGetUsersByEmail",
    "summary": "Get users by email",
    "deprecated": true,
    "tags": [
      "ThirdParty Recipe"
    ],
    "description": "Get all users accounts associated with given email\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "thirdparty",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "email",
        "required": true,
        "description": "User's email",
        "schema": {
          "type": "string",
          "example": "john.doe@example.com"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get all users associated with given email",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                      },
                      "isPrimaryUser": {
                        "type": "boolean",
                        "example": true
                      },
                      "tenantIds": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "customer1"
                        }
                      },
                      "timeJoined": {
                        "type": "number",
                        "example": 1623918032231
                      },
                      "emails": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "johndoe@gmail.com"
                        }
                      },
                      "phoneNumbers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "+14155552671"
                        }
                      },
                      "thirdParty": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "example": "google"
                            },
                            "userId": {
                              "type": "string",
                              "example": 106347997792363870000
                            }
                          }
                        }
                      },
                      "loginMethods": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "tenantIds": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "customer1"
                              }
                            },
                            "recipeUserId": {
                              "type": "string",
                              "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                            },
                            "verified": {
                              "type": "boolean",
                              "example": true
                            },
                            "timeJoined": {
                              "type": "number",
                              "example": 1623918032231
                            },
                            "recipeId": {
                              "type": "string",
                              "enum": [
                                "emailpassword",
                                "passwordless",
                                "thirdparty"
                              ]
                            },
                            "email": {
                              "type": "string",
                              "example": "johndoe@gmail.com"
                            },
                            "phoneNumber": {
                              "type": "string",
                              "example": "+14155552671"
                            },
                            "thirdParty": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "example": "google"
                                },
                                "userId": {
                                  "type": "string",
                                  "example": 106347997792363870000
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "ThirdParty Recipe"
    ],
    "operationId": "thirdPartySigninup",
    "summary": "Sign in/up third party user",
    "description": "Signin/up a user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "thirdparty",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "thirdPartyId": {
                "type": "string",
                "example": "google"
              },
              "thirdPartyUserId": {
                "type": "string",
                "example": 106347997792363870000
              },
              "email": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "example": "johndoe@gmail.com"
                  },
                  "isVerified": {
                    "type": "boolean",
                    "example": true
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Signin/up a user",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "createdNewUser": {
                      "type": "boolean",
                      "example": true
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "EMAIL_CHANGE_NOT_ALLOWED_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Metadata Recipe"
    ],
    "operationId": "userMetadataRead",
    "summary": "Get user metadata",
    "description": "Gets the stored metadata object of the user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "usermetadata",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "metadata": {
                  "type": "object",
                  "description": "should be a JSON object (not a JSON literal nor an array)",
                  "example": {
                    "preferences": {
                      "theme": "dark"
                    },
                    "notifications": {
                      "email": true
                    },
                    "todos": [
                      "example"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "User Metadata Recipe"
    ],
    "operationId": "userMetadataUpdate",
    "summary": "Update user metadata",
    "description": "Updates the metadata object stored about the user by doing a shallow merge of the stored and the update JSONs\nand removing properties set to null on the root level of the update object. The merged object is then reserialized and stored.\n\ne.g.:\n  - stored: `{ \"preferences\": { \"theme\":\"dark\" }, \"notifications\": { \"email\": true }, \"todos\": [\"example\"] }`\n\n  - update: `{ \"notifications\": { \"sms\": true }, \"todos\": null }`\n\n  - result: `{ \"preferences\": { \"theme\":\"dark\" }, \"notifications\": { \"sms\": true } }`\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "usermetadata",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "metadataUpdate": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "notifications": {
                    "sms": true
                  },
                  "todos": null
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "metadata": {
                  "type": "object",
                  "description": "should be a JSON object (not a JSON literal nor an array)",
                  "example": {
                    "preferences": {
                      "theme": "dark"
                    },
                    "notifications": {
                      "email": true
                    },
                    "todos": [
                      "example"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "User Metadata Recipe"
    ],
    "operationId": "userMetadataDelete",
    "summary": "Remove user metadata",
    "description": "Removes the entire metadata JSON stored about the user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "usermetadata",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Metadata Recipe"
    ],
    "operationId": "userMetadataRead",
    "summary": "Get user metadata",
    "description": "Gets the stored metadata object of the user\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "usermetadata",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "metadata": {
                  "type": "object",
                  "description": "should be a JSON object (not a JSON literal nor an array)",
                  "example": {
                    "preferences": {
                      "theme": "dark"
                    },
                    "notifications": {
                      "email": true
                    },
                    "todos": [
                      "example"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  },
  "put": {
    "tags": [
      "User Metadata Recipe"
    ],
    "operationId": "userMetadataUpdate",
    "summary": "Update user metadata",
    "description": "Updates the metadata object stored about the user by doing a shallow merge of the stored and the update JSONs\nand removing properties set to null on the root level of the update object. The merged object is then reserialized and stored.\n\ne.g.:\n  - stored: `{ \"preferences\": { \"theme\":\"dark\" }, \"notifications\": { \"email\": true }, \"todos\": [\"example\"] }`\n\n  - update: `{ \"notifications\": { \"sms\": true }, \"todos\": null }`\n\n  - result: `{ \"preferences\": { \"theme\":\"dark\" }, \"notifications\": { \"sms\": true } }`\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "usermetadata",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "metadataUpdate": {
                "type": "object",
                "description": "should be a JSON object (not a JSON literal nor an array)",
                "example": {
                  "notifications": {
                    "sms": true
                  },
                  "todos": null
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "metadata": {
                  "type": "object",
                  "description": "should be a JSON object (not a JSON literal nor an array)",
                  "example": {
                    "preferences": {
                      "theme": "dark"
                    },
                    "notifications": {
                      "email": true
                    },
                    "todos": [
                      "example"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "getRoleUsers",
    "summary": "Get users with role",
    "description": "Retrive the users associated with the role.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "role",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "admin"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_ROLE_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "getUserRoles",
    "summary": "Get user roles",
    "description": "Retrive the roles associated with the user.\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "userId",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "roles": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "admin"
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "getPermissionRoles",
    "summary": "Get permission roles",
    "description": "Retrive the roles associated with the permission\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "permission",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "permission"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "roles": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "admin"
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "getRolePermissions",
    "summary": "Get role permissions",
    "description": "Retrive the permissions associated with a role\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "role",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string",
          "example": "admin"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "permissions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "permission"
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_ROLE_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "getRoles",
    "summary": "Get all roles",
    "description": "Retrive all created roles\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "roles": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "admin"
                  }
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "removeUserRole",
    "summary": "Remove user role",
    "description": "Removes a User Role mapping\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "role": {
                "type": "string",
                "example": "admin"
              }
            },
            "required": [
              "userId",
              "role"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didUserHaveRole": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_ROLE_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "removeRolePermissions",
    "summary": "Remove role permissions",
    "description": "Removes permissions mapped to a role, if no permissions are passed all permissions mapped to the role are removed\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "example": "admin"
              },
              "permissions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "permission"
                }
              }
            },
            "required": [
              "role"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_ROLE_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "removeRole",
    "summary": "Delete role",
    "description": "Deletes a role\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "example": "admin"
              }
            },
            "required": [
              "role"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "didRoleExist": {
                  "type": "boolean",
                  "example": true
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "addUserRole",
    "summary": "Add user role",
    "description": "Creates a User Role mapping\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "role": {
                "type": "string",
                "example": "admin"
              }
            },
            "required": [
              "userId",
              "role"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "didUserAlreadyHaveRole": {
                      "type": "boolean",
                      "example": true
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_ROLE_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "put": {
    "tags": [
      "User Roles Recipe"
    ],
    "operationId": "putRole",
    "summary": "Create or update role",
    "description": "Creates a role with permissions, can also be used to add permissions to a role\n",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "rid",
        "in": "header",
        "example": "userroles",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "example": "admin"
              },
              "permissions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "permission"
                }
              }
            },
            "required": [
              "role"
            ]
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The operation was successful",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "OK"
                  ]
                },
                "createdNewRole": {
                  "type": "boolean",
                  "example": true
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get WebAuthn options",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Get the WebAuthn options.",
    "operationId": "getWebAuthNOptions",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "webauthnGeneratedOptionsId",
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "WebAuthn options result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnGeneratedOptionsId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "relyingPartyId": {
                      "type": "string",
                      "example": "example.com"
                    },
                    "relyingPartyName": {
                      "type": "string",
                      "example": "Example"
                    },
                    "challenge": {
                      "type": "string",
                      "example": "TQvEVDV8B64w_2zIifzKaPzBPfthqpx2uJkq_2PIB0k"
                    },
                    "timeout": {
                      "type": "number",
                      "example": 10000
                    },
                    "origin": {
                      "type": "string",
                      "example": "http://example.com"
                    },
                    "email": {
                      "type": "string",
                      "example": "email@example.com"
                    },
                    "userVerification": {
                      "type": "string",
                      "example": "required"
                    },
                    "userPresence": {
                      "type": "boolean",
                      "example": true
                    },
                    "createdAt": {
                      "type": "number",
                      "example": 1741793746
                    },
                    "expiresAt": {
                      "type": "number",
                      "example": 1741793746
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Get WebAuthn credential",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Get the WebAuthn credential for the user.",
    "operationId": "getWebAuthNCredential",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "recipeUserId",
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        },
        "required": true
      },
      {
        "in": "query",
        "name": "webauthnCredentialId",
        "schema": {
          "type": "string",
          "example": "ea7a0931-b533-4478-9253-0fde890ca23"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "WebAuthn credential result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "credential": {
                      "type": "object",
                      "properties": {
                        "webauthnCredentialId": {
                          "type": "string",
                          "example": "ea7a0931-b533-4478-9253-0fde890ca23"
                        },
                        "recipeUserId": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-9253-0fde890c576"
                        },
                        "relyingPartyId": {
                          "type": "string",
                          "example": "example.com"
                        },
                        "createdAt": {
                          "type": "number",
                          "example": 1741793746
                        },
                        "updatedAt": {
                          "type": "number",
                          "example": 1741793746
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "CREDENTIAL_NOT_FOUND_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "List WebAuthn credentials",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "List credentials that were created by the user.",
    "operationId": "listWebAuthNCredentials",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "recipeUserId",
        "schema": {
          "type": "string",
          "example": "fa7a0841-b533-4478-9253-0fde890c576"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "WebAuthn credentials list result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "credentials": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "webauthnCredentialId": {
                            "type": "string",
                            "example": "ea7a0931-b533-4478-9253-0fde890ca23"
                          },
                          "recipeUserId": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-9253-0fde890c576"
                          },
                          "relyingPartyId": {
                            "type": "string",
                            "example": "example.com"
                          },
                          "createdAt": {
                            "type": "number",
                            "example": 1741793746
                          },
                          "updatedAt": {
                            "type": "number",
                            "example": 1741793746
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "get": {
    "summary": "Recover WebAuthn user",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Recover the user using the WebAuthn credential.",
    "operationId": "recoverWebAuthNUser",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      },
      {
        "in": "query",
        "name": "token",
        "schema": {
          "type": "string",
          "example": "ZmE3YTA4NDEtYjUzMy00NDc4LTkyNTMtMGZkZTg5MGM1NzY"
        },
        "required": true
      }
    ],
    "responses": {
      "200": {
        "description": "AuthRecipeUser for the token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Generate registration options",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Generate the webauthn options for registration.",
    "operationId": "generateRegistrationOptions",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "email",
              "relyingPartyId",
              "relyingPartyName",
              "origin"
            ],
            "properties": {
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              },
              "displayName": {
                "type": "string",
                "example": "John Doe"
              },
              "relyingPartyId": {
                "type": "string",
                "example": "example.com"
              },
              "relyingPartyName": {
                "type": "string",
                "example": "Example"
              },
              "origin": {
                "type": "string",
                "example": "http://example.com"
              },
              "timeout": {
                "type": "number",
                "example": 10000
              },
              "userVerification": {
                "type": "string",
                "example": "preferred"
              },
              "userPresence": {
                "type": "boolean",
                "example": false
              },
              "attestation": {
                "type": "string",
                "example": "none"
              },
              "residentKey": {
                "type": "string",
                "example": "required"
              },
              "supportedAlgorithmIDs": {
                "type": "array",
                "items": {
                  "type": "number",
                  "example": -7
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The generated register options response",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnGeneratedOptionsId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "rp": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "example.com"
                        },
                        "name": {
                          "type": "string",
                          "example": "Example"
                        }
                      }
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-9253-0fde890c576"
                        },
                        "name": {
                          "type": "string",
                          "example": "John Doe"
                        },
                        "displayName": {
                          "type": "string",
                          "example": "John Doe"
                        }
                      }
                    },
                    "email": {
                      "type": "string",
                      "example": "johndoe@gmail.com"
                    },
                    "challenge": {
                      "type": "string",
                      "example": "TQvEVDV8B64w_2zIifzKaPzBPfthqpx2uJkq_2PIB0k"
                    },
                    "timeout": {
                      "type": "number",
                      "example": 10000
                    },
                    "attestation": {
                      "type": "string",
                      "example": "none"
                    },
                    "createdAt": {
                      "type": "number",
                      "example": 1741793746
                    },
                    "expiresAt": {
                      "type": "number",
                      "example": 1741793746
                    },
                    "pubKeyCredParams": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "example": "public-key"
                          },
                          "alg": {
                            "type": "number",
                            "example": -7
                          }
                        }
                      }
                    },
                    "excludeCredentials": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "fa7a0841-b533-4478-9253-0fde890c576"
                          },
                          "transport": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "internal"
                            }
                          }
                        }
                      }
                    },
                    "authenticatorSelection": {
                      "type": "object",
                      "properties": {
                        "userVerification": {
                          "type": "string",
                          "example": "preferred"
                        },
                        "requireResidentKey": {
                          "type": "boolean",
                          "example": true
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Generate authentication options",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Generate the webauthn options for signin.",
    "operationId": "generateSigninOptions",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "relyingPartyId",
              "relyingPartyName",
              "origin",
              "timeout",
              "userVerification",
              "userPresence"
            ],
            "properties": {
              "relyingPartyId": {
                "type": "string",
                "example": "example.com"
              },
              "relyingPartyName": {
                "type": "string",
                "example": "Example"
              },
              "origin": {
                "type": "string",
                "example": "http://example.com"
              },
              "timeout": {
                "type": "number",
                "example": 10000
              },
              "userVerification": {
                "type": "string",
                "example": "preferred"
              },
              "userPresence": {
                "type": "boolean",
                "example": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "AuthRecipeUser for the token",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnGeneratedOptionsId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "relyingPartyId": {
                      "type": "string",
                      "example": "example.com"
                    },
                    "challenge": {
                      "type": "string",
                      "example": "TQvEVDV8B64w_2zIifzKaPzBPfthqpx2uJkq_2PIB0k"
                    },
                    "timeout": {
                      "type": "number",
                      "example": 10000
                    },
                    "userVerification": {
                      "type": "string",
                      "example": "required"
                    },
                    "userPresence": {
                      "type": "boolean",
                      "example": true
                    },
                    "createdAt": {
                      "type": "number",
                      "example": 1741793746
                    },
                    "expiresAt": {
                      "type": "number",
                      "example": 1741793746
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Sign in WebAuthn user",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Sign in the user using the WebAuthn credential.",
    "operationId": "signInWebAuthNUser",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "email"
            ],
            "properties": {
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              },
              "credential": {
                "type": "object",
                "description": "Credential returned by the browser"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The stored credential",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR",
                        "INVALID_AUTHENTICATOR_ERROR",
                        "INVALID_CREDENTIALS_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OPTIONS_NOT_FOUND_ERROR",
                        "CREDENTIAL_NOT_FOUND_ERROR",
                        "UNKNOWN_USER_ID_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Sign up WebAuthn user",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Sign up the user using the WebAuthn credential.",
    "operationId": "signUpWebAuthNUser",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "email"
            ],
            "properties": {
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              },
              "credential": {
                "type": "object",
                "description": "Credential returned by the browser"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The signup result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnCredentialId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "relyingPartyId": {
                      "type": "string",
                      "example": "example.com"
                    },
                    "relyingPartyName": {
                      "type": "string",
                      "example": "Example"
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "user": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                        },
                        "isPrimaryUser": {
                          "type": "boolean",
                          "example": true
                        },
                        "tenantIds": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "customer1"
                          }
                        },
                        "timeJoined": {
                          "type": "number",
                          "example": 1623918032231
                        },
                        "emails": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "johndoe@gmail.com"
                          }
                        },
                        "phoneNumbers": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "+14155552671"
                          }
                        },
                        "thirdParty": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "google"
                              },
                              "userId": {
                                "type": "string",
                                "example": 106347997792363870000
                              }
                            }
                          }
                        },
                        "loginMethods": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "tenantIds": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "example": "customer1"
                                }
                              },
                              "recipeUserId": {
                                "type": "string",
                                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
                              },
                              "verified": {
                                "type": "boolean",
                                "example": true
                              },
                              "timeJoined": {
                                "type": "number",
                                "example": 1623918032231
                              },
                              "recipeId": {
                                "type": "string",
                                "enum": [
                                  "emailpassword",
                                  "passwordless",
                                  "thirdparty"
                                ]
                              },
                              "email": {
                                "type": "string",
                                "example": "johndoe@gmail.com"
                              },
                              "phoneNumber": {
                                "type": "string",
                                "example": "+14155552671"
                              },
                              "thirdParty": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "example": "google"
                                  },
                                  "userId": {
                                    "type": "string",
                                    "example": 106347997792363870000
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR",
                        "INVALID_AUTHENTICATOR_ERROR",
                        "INVALID_CREDENTIALS_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OPTIONS_NOT_FOUND_ERROR",
                        "EMAIL_ALREADY_EXISTS_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Register WebAuthn credential",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Register a new credential for the user",
    "operationId": "registerWebAuthNCredential",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "email"
            ],
            "properties": {
              "recipeUserId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "webauthnGeneratedOptionsId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-9253-0fde890c576"
              },
              "credential": {
                "type": "object",
                "description": "Credential returned by the browser"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The stored credential",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "webauthnCredentialId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "relyingPartyId": {
                      "type": "string",
                      "example": "example.com"
                    },
                    "relyingPartyName": {
                      "type": "string",
                      "example": "Example"
                    },
                    "recipeUserId": {
                      "type": "string",
                      "example": "fa7a0841-b533-4478-9253-0fde890c576"
                    },
                    "email": {
                      "type": "string",
                      "example": "johndoe@gmail.com"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "INVALID_OPTIONS_ERROR",
                        "INVALID_AUTHENTICATOR_ERROR",
                        "INVALID_CREDENTIALS_ERROR"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OPTIONS_NOT_FOUND_ERROR",
                        "CREDENTIAL_ALREADY_EXISTS_ERROR",
                        "UNKNOWN_USER_ID_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Generate recovery token",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Generate a token to recover the user.",
    "operationId": "generateTokenForRecovery",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "example": "5.1",
        "schema": {
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "userId",
              "email"
            ],
            "properties": {
              "userId": {
                "type": "string",
                "example": "fa7a0841-b533-4478-95533-0fde890c3483"
              },
              "email": {
                "type": "string",
                "example": "johndoe@gmail.com"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "WebAuthn options result",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "OK"
                      ]
                    },
                    "token": {
                      "type": "string",
                      "example": "ZmE3YTA4NDEtYjUzMy00NDc4LTkyNTMtMGZkZTg5MGM1NzY"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "UNKNOWN_USER_ID_ERROR"
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "400": {
        "description": "error code 400",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "401": {
        "description": "error code 401",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Invalid API key"
              ]
            }
          }
        }
      },
      "404": {
        "description": "error code 404",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Not Found"
              ]
            }
          }
        }
      },
      "500": {
        "description": "error code 500",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "enum": [
                "Internal Error"
              ]
            }
          }
        }
      }
    }
  }
}

{
  "post": {
    "summary": "Consume recovery token",
    "tags": [
      "WebAuthn Recipe"
    ],
    "description": "Consume the token to recover the user.",
    "operationId": "consumeWebAuthNToken",
    "security": [
      {
        "ApiKey": []
      }
    ],
    "parameters": [
      {
        "name": "tenantId",
        "in": "path",
        "description": "The tenant against which the request is made. If left empty, the default tenant will be used.",
        "required": false,
        "schema": {
          "type": "string",
          "example": "public"
        }
      },
      {
        "$ref": "#/components/parameters/webauthnRid"
      },
      {
        "name": "cdi-version",
        "in": "header",
        "description": "X.Y of the X.Y.Z CDI version.",
        "e