useAuth()
The useAuth() hook provides access to the current user's authentication state and methods to manage the active session.
Returns
- Name
isLoaded- Type
boolean- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
isSignedIn- Type
boolean- Description
A boolean that indicates whether a user is currently signed in.
- Name
userId- Type
string- Description
The ID of the current user.
- Name
sessionId- Type
string- Description
The ID for the current session.
- Name
orgId- Type
string- Description
The ID of the user's active organization.
- Name
orgRole- Type
string- Description
The current user's role in their active organization.
- Name
orgSlug- Type
string- Description
The URL-friendly identifier of the user's active organization.
- Name
signOut()- Type
(options?: SignOutOptions) => Promise<void>- Description
A function that signs out the current user. Returns a promise that resolves when complete. See the reference doc.
- Name
getToken()- Type
(options?: GetTokenOptions) => Promise<string | null>- 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 reference doc.
- Name
has()- Type
(isAuthorizedParams: CheckAuthorizationParamsWithCustomPermissions) => boolean- Description
A function that checks if the user has specific permissions or roles. See the reference doc.
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.
import { useAuth } from '@clerk/clerk-react'
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>
)
}Feedback
Last updated on