unauthorized.js
API reference for the unauthorized.js special file.
The unauthorized file renders UI when the unauthorized function is invoked.
Before streaming starts, Next.js returns a 401 status code. After streaming starts, the status code remains 200 and the unauthorized UI renders in the response. Next.js injects a <meta name="robots" content="noindex" /> tag in both cases. See Status codes for details.
Reference
Props
unauthorized.js components do not accept any props.
Good to know: Next.js sends each unauthorized.js file with every route under its segment, even when unauthorized() is never called, and loads the Client Components it imports on those pages. Prefer Server Components and <Link> there over interactive UI.
Examples
Displaying login UI to unauthenticated users
You can use unauthorized function to render the unauthorized.js file with a login UI.
Version History
| Version | Changes |
|---|---|
v15.1.0 | unauthorized.js introduced. |