medusa-store/www/apps/resources/app/commerce-modules/auth/examples/page.mdx

import { CodeTabs, CodeTab } from "docs-ui"

export const metadata = {
  title: `Examples of the Auth Module`,
}

# {metadata.title}

In this guide, you’ll find common examples of how you can use the Auth Module in your application.

## Authenticate User

<Note>

This example uses the [jsonwebtoken NPM package](https://www.npmjs.com/package/jsonwebtoken) to create the authentication token.

</Note>

<CodeTabs groupId="app-type">
  <CodeTab label="Medusa API Router" value="medusa">

  ```ts
  import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
  import {
    IAuthModuleService,
    AuthenticationInput,
  } from "@medusajs/types"
  import { ModuleRegistrationName } from "@medusajs/modules-sdk"
  import { MedusaError } from "@medusajs/utils"
  import jwt from "jsonwebtoken"

  export async function POST(
    req: MedusaRequest,
    res: MedusaResponse
  ): Promise<void> {
    const authModuleService: IAuthModuleService =
      req.scope.resolve(ModuleRegistrationName.AUTH)

    const { success, authUser, location, error } =
      await authModuleService.authenticate("emailpass", {
        url: req.url,
        headers: req.headers,
        query: req.query,
        body: req.body,
        authScope: "admin",
        protocol: req.protocol,
      } as AuthenticationInput)

    if (!success) {
      throw new MedusaError(MedusaError.Types.UNAUTHORIZED, error)
    }

    if (location) {
      res.redirect(location)
      return
    }

    const { jwtSecret } =
      req.scope.resolve("configModule").projectConfig.http
    const token = jwt.sign(authUser, jwtSecret)

    res.status(200).json({ token })
  }
  ```

  </CodeTab>
  <CodeTab label="Next.js App Router" value="nextjs">

  ```ts
  import { NextResponse } from "next/server"

  import {
    initialize as initializeAuthModule,
  } from "@medusajs/auth"

  export async function POST(request: Request) {
    const authModuleService = await initializeAuthModule()
    const url = new URL(request.url)

    const { success, authUser, location, error } =
      await authModuleService.authenticate("emailpass", {
        url: request.url,
        headers: Object.fromEntries(request.headers),
        query: Object.fromEntries(url.searchParams),
        body: await request.json(),
        authScope: "admin",
        protocol: url.protocol,
      } as AuthenticationInput)

    if (!success) {
      throw new Error(error)
    }

    if (location) {
      return NextResponse.redirect(location)
      return
    }

    const token = jwt.sign(authUser, "supersecret")

    return NextResponse.json({
      token,
    }, {
      status: 200,
    })
  }
  ```

  </CodeTab>
</CodeTabs>

---

## Validate Callback

<Note>

This example uses the [jsonwebtoken NPM package](https://www.npmjs.com/package/jsonwebtoken) to create the authentication token.

</Note>

<CodeTabs groupId="app-type">
  <CodeTab label="Medusa API Router" value="medusa">

  ```ts
  import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
  import {
    IAuthModuleService,
    AuthenticationInput,
  } from "@medusajs/types"
  import { ModuleRegistrationName } from "@medusajs/modules-sdk"
  import { MedusaError } from "@medusajs/utils"
  import jwt from "jsonwebtoken"

  export async function POST(
    req: MedusaRequest,
    res: MedusaResponse
  ): Promise<void> {
    const authModuleService: IAuthModuleService =
      req.scope.resolve(ModuleRegistrationName.AUTH)

    const { success, authUser, error, successRedirectUrl } =
      await authModuleService.validateCallback("google", {
        url: req.url,
        headers: req.headers,
        query: req.query,
        body: req.body,
        authScope: "admin",
        protocol: req.protocol,
      } as AuthenticationInput)

    if (!success) {
      throw new MedusaError(MedusaError.Types.UNAUTHORIZED, error)
    }

    const { jwtSecret } =
      req.scope.resolve("configModule").projectConfig.http
    const token = jwt.sign(authUser, jwtSecret)

    if (successRedirectUrl) {
      const url = new URL(successRedirectUrl!)
      url.searchParams.append("auth_token", token)

      return res.redirect(url.toString())
    }

    res.status(200).json({ token })
  }
  ```

  </CodeTab>
  <CodeTab label="Next.js App Router" value="nextjs">

  ```ts
  import { NextResponse } from "next/server"

  import {
    initialize as initializeAuthModule,
  } from "@medusajs/auth"

  export async function POST(request: Request) {
    const authModuleService = await initializeAuthModule()
    const url = new URL(request.url)

    const { success, authUser, location, error } =
      await authModuleService.authenticate("google", {
        url: request.url,
        headers: Object.fromEntries(request.headers),
        query: Object.fromEntries(url.searchParams),
        body: await request.json(),
        authScope: "admin",
        protocol: url.protocol,
      } as AuthenticationInput)

    if (!success) {
      throw new Error(error)
    }

    const token = jwt.sign(authUser, "supersecret")

    if (successRedirectUrl) {
      const url = new URL(successRedirectUrl!)
      url.searchParams.append("auth_token", token)

      return NextResponse.redirect(url.toString())
    }

    return NextResponse.json({
      token,
    }, {
      status: 200,
    })
  }
  ```

  </CodeTab>
</CodeTabs>

---

## Create Auth User

<CodeTabs groupId="app-type">
  <CodeTab label="Medusa API Router" value="medusa">

  ```ts
  import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
  import { IAuthModuleService } from "@medusajs/types"
  import { ModuleRegistrationName } from "@medusajs/modules-sdk"

  export async function POST(
    req: MedusaRequest,
    res: MedusaResponse
  ): Promise<void> {
    const authModuleService: IAuthModuleService =
      req.scope.resolve(ModuleRegistrationName.AUTH)

    const authUser = await authModuleService.create({
      provider: "emailpass",
      entity_id: "user@example.com",
      scope: "admin",
    })

    res.json({ auth_user: authUser })
  }
  ```

  </CodeTab>
  <CodeTab label="Next.js App Router" value="nextjs">

  ```ts
  import { NextResponse } from "next/server"

  import {
    initialize as initializeAuthModule,
  } from "@medusajs/auth"

  export async function POST(request: Request) {
    const authModuleService = await initializeAuthModule()

    const authUser = await authModuleService.create({
      provider: "emailpass",
      entity_id: "user@example.com",
      scope: "admin",
    })

    return NextResponse.json({
      auth_user: authUser,
    })
  }
  ```

  </CodeTab>
</CodeTabs>

---

## List Auth Users

<CodeTabs groupId="app-type">
  <CodeTab label="Medusa API Router" value="medusa">

  ```ts
  import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
  import { IAuthModuleService } from "@medusajs/types"
  import { ModuleRegistrationName } from "@medusajs/modules-sdk"

  export async function GET(
    req: MedusaRequest,
    res: MedusaResponse
  ): Promise<void> {
    const authModuleService: IAuthModuleService =
      req.scope.resolve(ModuleRegistrationName.AUTH)

    res.json({
      auth_users: await authModuleService.list(),
    })
  }
  ```

  </CodeTab>
  <CodeTab label="Next.js App Router" value="nextjs">

  ```ts
  import { NextResponse } from "next/server"

  import {
    initialize as initializeAuthModule,
  } from "@medusajs/auth"

  export async function GET(request: Request) {
    const authModuleService = await initializeAuthModule()

    return NextResponse.json({
      auth_users: await authModuleService.list(),
    })
  }
  ```

  </CodeTab>
</CodeTabs>

---

## Update an Auth User

<CodeTabs groupId="app-type">
  <CodeTab label="Medusa API Router" value="medusa">

  ```ts
  import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
  import { IAuthModuleService } from "@medusajs/types"
  import { ModuleRegistrationName } from "@medusajs/modules-sdk"

  export async function POST(
    req: MedusaRequest,
    res: MedusaResponse
  ): Promise<void> {
    const authModuleService: IAuthModuleService =
      req.scope.resolve(ModuleRegistrationName.AUTH)

    const authUser = await authModuleService.update({
      id: "authusr_123",
      provider_metadata: {
        test: true,
      },
    })

    res.json({
      auth_user: authUser,
    })
  }
  ```

  </CodeTab>
  <CodeTab label="Next.js App Router" value="nextjs">

  ```ts
  import { NextResponse } from "next/server"

  import {
    initialize as initializeAuthModule,
  } from "@medusajs/auth"

  type ContextType = {
    params: {
      id: string
    }
  }

  export async function POST(
    request: Request,
    { params }: ContextType
  ) {
    const authModuleService = await initializeAuthModule()

    const authUser = await authModuleService.update({
      id: "authusr_123",
      provider_metadata: {
        test: true,
      },
    })

    return NextResponse.json({
      auth_users: await authModuleService.list(),
    })
  }
  ```

  </CodeTab>
</CodeTabs>

---

## Delete an Auth User

<CodeTabs groupId="app-type">
  <CodeTab label="Medusa API Router" value="medusa">

  ```ts
  import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
  import { IAuthModuleService } from "@medusajs/types"
  import { ModuleRegistrationName } from "@medusajs/modules-sdk"

  export async function DELETE(
    req: MedusaRequest,
    res: MedusaResponse
  ): Promise<void> {
    const authModuleService: IAuthModuleService =
      req.scope.resolve(ModuleRegistrationName.AUTH)

    await authModuleService.delete(["authusr_123"])

    res.status(200)
  }
  ```

  </CodeTab>
  <CodeTab label="Next.js App Router" value="nextjs">

  ```ts
  import { NextResponse } from "next/server"

  import {
    initialize as initializeAuthModule,
  } from "@medusajs/auth"

  type ContextType = {
    params: {
      id: string
    }
  }

  export async function DELETE(
    request: Request,
    { params }: ContextType
  ) {
    const authModuleService = await initializeAuthModule()

    await authModuleService.delete(["authusr_123"])
  }
  ```

  </CodeTab>
</CodeTabs>

---

## More Examples

The [module interface reference](/references/auth) provides a reference to all the methods available for use with examples for each.