useAuth() | Vue
The useAuth() composable provides access to the current user's authentication state and methods to manage the session in your Vue application.
Returns
- Name
isLoaded- Type
Ref<boolean>- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
isSignedIn- Type
Ref<boolean>- Description
A boolean that indicates whether a user is currently signed in.
- Name
userId- Type
Ref<string>- Description
The ID of the current user.
- Name
sessionId- Type
Ref<string>- Description
The ID of the current session.
- Name
orgId- Type
Ref<string>- Description
The ID of the user's .
- Name
orgRole- Type
Ref<string>- Description
The current user's Role in their .
- Name
orgSlug- Type
Ref<string>- Description
The URL-friendly identifier of the user's .
- Name
signOut()- Type
Ref<(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
Ref<(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
Ref<(isAuthorizedParams: CheckAuthorizationParamsWithCustomPermissions) => boolean>- Description
A function that checks if the user has specific Permissions or Roles. See the reference doc.
How to use the useAuth() composable
The following example demonstrates how to use the useAuth() composable 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.
<script setup>
const { getToken, isLoaded, isSignedIn, sessionId, userId } = useAuth()
const fetchProtectedData = async () => {
// Use `getToken()` to get the current user's session token
const token = await getToken.value()
// Use the token to fetch data from an external API
const response = await fetch('https://api.example.com/data', {
headers: {
Authorization: `Bearer ${token}`,
},
})
return response.json()
}
</script>
<template>
<!-- Use `isLoaded` to check if Clerk is loaded -->
<div v-if="!isLoaded">Loading...</div>
<!-- Use `isSignedIn` to check if the user is signed in -->
<div v-else-if="!isSignedIn">Sign in to view this page</div>
<!-- Use `userId` to access the current user's ID and `sessionId` to access the current session ID -->
<div v-else>Hello, {{ userId }}! Your current active session is {{ sessionId }}.</div>
</template>Feedback
Last updated on