---
url: "https://vueda.dev/v3/reference/api/js/router/guards/functions/requireUnauth.md"
title: "requireUnauth"
---

# requireUnauth

## Overview

Require the user to be unauthenticated, like for a login page.

## Signature

`requireUnauth(redirectTo, router, pinia)`

### Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| <span id="param-redirectTo">redirectTo</span> | `string \| RouteLocationAsRelativeGeneric \| RouteLocationAsPathGeneric` | yes | Where to redirect if authenticated. |
| <span id="param-router">router</span> | `Router` | yes | The router instance. |
| <span id="param-pinia">pinia</span> | `Pinia` | yes | The Pinia instance. |

### Returns

`Promise`

The redirect route if needed.
 Rejects with the request error when the current-user request fails, which rejects the navigation.

## Examples

```js
import { requireUnauth } from "@vueda/router/guards";
import { createRouter, createWebHistory } from "vue-router";

const router = createRouter({
  history: createWebHistory(import.meta.env.BASE_URL),
  routes: [
    {
      path: '/unauth-required/',
      name: 'unauth-required',
      component: () => import('@/views/ViewUnauthRequired.vue'),
      beforeEnter: (to, from) => requireUnauth({ name: "welcome" }, router),
    },
    // other routes
  ],
});

export default router;
```

## Source

`client/lib/router/guards.js:207`