useAuth()
The useAuth() hook provides access to the current user's authentication state and methods to manage the active session.
By default, Next.js opts all routes into static rendering. If you need to opt a route or routes into dynamic rendering because you need to access the authentication data at request time, you can create a boundary by passing the dynamic prop to <ClerkProvider>. See the guide on rendering modes for more information, including code examples.
Example
The following example demonstrates how to use the useAuth() hook to access the current auth state, like whether the user is signed in or not. It also includes a basic example for using the getToken() method to retrieve a session token for fetching data from an external resource.
'use client'
import { useAuth } from '@clerk/nextjs'
export default function ExternalDataPage() {
const { userId, sessionId, getToken, isLoaded, isSignedIn } = useAuth()
const fetchExternalData = async () => {
const token = await getToken()
// Fetch data from an external API
const response = await fetch('https://api.example.com/data', {
headers: {
Authorization: `Bearer ${token}`,
},
})
return response.json()
}
if (!isLoaded) {
return <div>Loading...</div>
}
if (!isSignedIn) {
return <div>Sign in to view this page</div>
}
return (
<div>
<p>
Hello, {userId}! Your current active session is {sessionId}.
</p>
<button onClick={fetchExternalData}>Fetch Data</button>
</div>
)
}- Name
actor- Type
undefined- Description
The JWT actor for the session. Holds identifier for the user that is impersonating the current user. Read more about impersonation.
- Name
getToken- Type
GetToken- Description
A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the .
- Name
has- Type
{ }- Description
A function that checks if the user has specific permissions or roles. See the .
- Name
isLoaded- Type
false- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
isSignedIn- Type
undefined- Description
A boolean that indicates whether a user is currently signed in.
- Name
orgId- Type
undefined- Description
The ID of the user's active organization.
- Name
orgRole- Type
undefined- Description
The current user's role in their active organization.
- Name
orgSlug- Type
undefined- Description
The URL-friendly identifier of the user's active organization.
- Name
sessionClaims- Type
undefined- Description
The current user's session claims.
- Name
sessionId- Type
undefined- Description
The ID for the current session.
- Name
signOut- Type
SignOut- Description
A function that signs out the current user. Returns a promise that resolves when complete. See the .
- Name
userId- Type
undefined- Description
The ID of the current user.
Feedback
Last updated on