> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hexclave.com/llms.txt
> Use this file to discover all available pages before exploring further.
# User
> Reference for CurrentUser, ServerUser, and CurrentServerUser types.
This is a detailed reference for the `User` object. If you're looking for a more high-level overview, please refer to our guide on users [here](https://docs.hexclave.com/guides/getting-started/user-fundamentals.md).On this page:- [CurrentUser](#currentuser)
- [ServerUser](#serveruser)
- [CurrentServerUser](#currentserveruser)# `CurrentUser`Use `useUser()` to get `CurrentUser` (client). Use `hexclaveServerApp.getUser()` to get `CurrentServerUser` (server).## Table of ContentsCurrentUser Table of Contents## Properties
\
\`currentUser.id`
currentUser
The user ID. This is the unique identifier of the user.
Type Definition
\`typescript declare const id: string; `
\
\
\`currentUser.displayName`
currentUser
The display name of the user, or `null` if not set. The user can modify
this value.
Type Definition
\`typescript declare const displayName: string | null; `
\
\
\`currentUser.primaryEmail`
currentUser
The primary email of the user. Note that this is not necessarily unique.
Type Definition
\`typescript declare const primaryEmail: string | null; `
\
\
\`currentUser.primaryEmailVerified`
currentUser
Whether the primary email of the user is verified.
Type Definition
\`typescript declare const primaryEmailVerified: boolean; `
\
\
\`currentUser.profileImageUrl`
currentUser
The profile image URL of the user, or `null` if no profile image is set.
Type Definition
\`typescript declare const profileImageUrl: string | null; `
\
\
\`currentUser.signedUpAt`
currentUser
The date and time when the user signed up.
Type Definition
\`typescript declare const signedUpAt: Date; `
\
\
\`currentUser.hasPassword`
currentUser
Whether the user has a password set.
Type Definition
\`typescript declare const hasPassword: boolean; `
\
\
\`currentUser.clientMetadata`
currentUser
Client-visible custom metadata. This should not contain sensitive or
server-only information.
Type Definition
\`typescript declare const clientMetadata: Json; `
\
\
\`currentUser.clientReadOnlyMetadata`
currentUser
Read-only metadata visible on the client side. It can only be modified on
the server side.
Type Definition
\`typescript declare const clientReadOnlyMetadata: Json; `
\
\
\`currentUser.selectedTeam`
currentUser
The currently selected team for the user, or `null` if no team is
selected.
Type Definition
\`typescript declare const selectedTeam: Team | null; `
\
\
\`currentUser.currentSession`
currentUser
The current session object, which provides access to authentication tokens.
Type Definition
\```typescript theme={null}
declare const currentSession: {
getTokens(): Promise<{ accessToken: string | null; refreshToken: string | null }>;
useTokens(): { accessToken: string | null; refreshToken: string | null };
};
\```
\
\
\`currentUser.otpAuthEnabled`
currentUser
Whether OTP (one-time password) authentication is enabled for this user.
Type Definition
\`typescript declare const otpAuthEnabled: boolean; `
\
\
\`currentUser.passkeyAuthEnabled`
currentUser
Whether passkey authentication is enabled for this user.
Type Definition
\`typescript declare const passkeyAuthEnabled: boolean; `
\
\
\`currentUser.isMultiFactorRequired`
currentUser
Whether multi-factor authentication is required for this user.
Type Definition
\`typescript declare const isMultiFactorRequired: boolean; `
\
\
\`currentUser.isAnonymous`
currentUser
Whether this is an anonymous user (signed in without credentials).
Type Definition
\`typescript declare const isAnonymous: boolean; `
\
\
\`currentUser.isRestricted`
currentUser
Whether the user is restricted from performing certain actions.
Type Definition
\`typescript declare const isRestricted: boolean; `
\
\
\`currentUser.restrictedReason`
currentUser
The reason why the user is restricted, or `null` if the user is not restricted.
Type Definition
\```typescript theme={null}
declare const restrictedReason: {
type: "anonymous" | "email_not_verified" | "restricted_by_administrator";
} | null;
\```
\
## Profile Management
\
\`currentUser.update(data)`
currentUser
Updates multiple fields of the user at once.
Parameters
\**data** `object` *required*
The fields to update on the user.
\**displayName** `string | null`
The new display name for the user.
\**clientMetadata** `ReadonlyJson`
Custom metadata visible to the client.
\**selectedTeamId** `string | null`
The ID of the team to set as selected, or `null` to clear selection.
\**profileImageUrl** `string | null`
The URL of the user's new profile image, or `null` to remove it.
\**totpMultiFactorSecret** `Uint8Array | null`
The TOTP multi-factor authentication secret, or `null` to disable.
\**otpAuthEnabled** `boolean`
Whether to enable OTP authentication.
\**passkeyAuthEnabled** `boolean`
Whether to enable passkey authentication.
\**primaryEmail** `string | null`
The new primary email address.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function update(data: {
displayName?: string | null;
clientMetadata?: ReadonlyJson;
selectedTeamId?: string | null;
profileImageUrl?: string | null;
totpMultiFactorSecret?: Uint8Array | null;
otpAuthEnabled?: boolean;
passkeyAuthEnabled?: boolean;
primaryEmail?: string | null;
}): Promise;
\```
Examples
\```typescript theme={null}
await user.update({
displayName: "New Display Name",
clientMetadata: {
address: "123 Main St",
},
});
\```
\
\
\`currentUser.setDisplayName(displayName)`
currentUser
Sets the display name of the user.
Parameters
\**displayName** `string | null` *required*
The new display name, or `null` to clear it.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setDisplayName(displayName: string | null): Promise;
\```
Examples
\```typescript theme={null}
await user.setDisplayName("John Doe");
\```
\
\
\`currentUser.setClientMetadata(metadata)`
currentUser
Sets the client metadata for the user.
Parameters
\**metadata** `Json` *required*
The new client metadata value.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setClientMetadata(metadata: any): Promise;
\```
Examples
\```typescript theme={null}
await user.setClientMetadata({ theme: "dark", locale: "en" });
\```
\
\
\`currentUser.updatePassword(data)`
currentUser
Changes password with old and new password validation.
Parameters
\**data** `object` *required*
Password change inputs.
\**oldPassword** `string` *required*
The user's current password.
\**newPassword** `string` *required*
The new password to set.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function updatePassword(data: {
oldPassword: string;
newPassword: string;
}): Promise;
\```
Examples
\```typescript theme={null}
await user.updatePassword({
oldPassword: "old-password",
newPassword: "new-password",
});
\```
\
\
\`currentUser.setPassword(options)`
currentUser
Sets a password for the user without requiring the current password.
Parameters
\**options.password** `string` *required*
The new password to set.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setPassword(options: {
password: string;
}): Promise;
\```
Examples
\```typescript theme={null}
await user.setPassword({ password: "new-secure-password" });
\```
\
\
\`currentUser.toClientJson`
currentUser
Converts the user object to the format expected by the Hexclave API. Useful for serializing user data in API responses or caching.
Returns
\`CurrentUserCrud["Client"]["Read"]`
Signature
\```typescript theme={null}
declare function toClientJson(): CurrentUserCrud["Client"]["Read"];
\```
Examples
\```typescript theme={null}
const user = useUser();
const json = user.toClientJson();
localStorage.setItem("cachedUser", JSON.stringify(json));
\```
\
## Authentication
\
\`currentUser.getAuthorizationHeader`
currentUser
Returns the HTTP `Authorization` header value in `Bearer stackauth_...` format for authenticated requests.
Returns `null` if the user is not signed in.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getAuthorizationHeader(): Promise;
\```
\
\
\`currentUser.useAuthorizationHeader`
currentUser
React hook that returns the HTTP `Authorization` header value in `Bearer stackauth_...` format.
Returns `null` if the user is not signed in.
Returns
\`string | null`
Signature
\```typescript theme={null}
declare function useAuthorizationHeader(): string | null;
\```
\
\
\`currentUser.getAuthHeaders`
currentUser
\**Deprecated:** Use `getAuthorizationHeader()` instead.
Returns legacy `x-stack-auth` headers for cross-origin authenticated requests.
Returns
\`Promise>`
Signature
\```typescript theme={null}
declare function getAuthHeaders(): Promise>;
\```
\
\
\`currentUser.useAuthHeaders`
currentUser
\**Deprecated:** Use `useAuthorizationHeader()` instead.
React hook that returns legacy `x-stack-auth` headers for cross-origin requests.
Returns
\`Record`
Signature
\```typescript theme={null}
declare function useAuthHeaders(): Record;
\```
\
\
\`currentUser.getAccessToken`
currentUser
Returns the current access token, or `null` if the user is not signed in. The access token is a short-lived JWT that is automatically refreshed when it expires.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getAccessToken(): Promise;
\```
\
\
\`currentUser.useAccessToken`
currentUser
React hook that returns the current access token, or `null` if not signed in.
Returns
\`string | null`
Signature
\```typescript theme={null}
declare function useAccessToken(): string | null;
\```
\
\
\`currentUser.getRefreshToken`
currentUser
Returns the current refresh token, or `null` if the user is not signed in. The refresh token is a long-lived token used to obtain new access tokens.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getRefreshToken(): Promise;
\```
\
\
\`currentUser.useRefreshToken`
currentUser
React hook that returns the current refresh token, or `null` if not signed in.
Returns
\`string | null`
Signature
\```typescript theme={null}
declare function useRefreshToken(): string | null;
\```
\
\
\`currentUser.signOut([options])`
currentUser
Signs out the user with an optional redirect URL.
Parameters
\**options.redirectUrl** `string`
URL to redirect to after sign-out.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function signOut(options?: {
redirectUrl?: string;
}): Promise;
\```
\
\
\`currentUser.delete`
currentUser
Permanently deletes the user account. Requires client-side deletion to be enabled in the project settings.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function delete(): Promise;
\```
\
## Team Management
\
\`currentUser.getTeam(id)`
currentUser
Gets the team with the specified ID.
Parameters
\**id** `string` *required*
The ID of the team to get.
Returns
\`Promise`
The team object, or `null` if the team is not found or the user is not a member.
Signature
\```typescript theme={null}
declare function getTeam(id: string): Promise;
\```
Examples
\```typescript theme={null}
const team = await user.getTeam("teamId");
\```
\
\
\`currentUser.useTeam(id)`
currentUser
React hook version of `getTeam`.
Parameters
\**id** `string` *required*
The ID of the team to get.
Returns
\`Team | null`
Signature
\```typescript theme={null}
declare function useTeam(id: string): Team | null;
\```
\
\
\`currentUser.listTeams`
currentUser
Lists the teams the user is a member of.
If there are more teams than the requested `limit`, `nextCursor` on the result is set; pass it as `cursor` (together with `limit`) to fetch the next page. Otherwise, `nextCursor` is `null`.
Parameters
\**options.limit** `number`
The maximum number of teams to return (at most 200). If omitted, all teams are returned, but the request fails if the user is in more than 500 teams, so prefer setting `limit`.
\**options.cursor** `string`
The `nextCursor` of the previous page. Requires `limit` to also be set.
\**options.query** `string`
Free-text search. Matches the team ID exactly, or part of the display name.
\**options.orderBy** `"createdAt"`
The field to sort results by.
\**options.desc** `boolean`
Whether to sort in descending order. Defaults to `false`.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listTeams(options?: {
limit?: number;
cursor?: string;
query?: string;
orderBy?: "createdAt";
desc?: boolean;
}): Promise;
\```
Examples
\```typescript theme={null}
// Page through all teams
const allTeams = [];
let cursor: string | undefined = undefined;
do {
const page = await user.listTeams({ limit: 100, cursor });
allTeams.push(...page);
cursor = page.nextCursor ?? undefined;
} while (cursor != null);
\```
\
\
\`currentUser.useTeams`
currentUser
React hook version of `listTeams`. Accepts the same options.
Returns
\`Team[] & { nextCursor: string | null }`
Signature
\```typescript theme={null}
declare function useTeams(options?: {
limit?: number;
cursor?: string;
query?: string;
orderBy?: "createdAt";
desc?: boolean;
}): Team[] & { nextCursor: string | null };
\```
\
\
\`currentUser.setSelectedTeam(team)`
currentUser
Sets the currently selected team for the user.
Parameters
\**team** `Team | null` *required*
The team to set as selected, or `null` to clear selection.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setSelectedTeam(team: Team | null): Promise;
\```
Examples
\```typescript theme={null}
const team = await user.getTeam("team_id_123");
await user.setSelectedTeam(team);
\```
\
\
\`currentUser.createTeam(data)`
currentUser
Creates a new team for the user. The user will be added to the team and given creator permissions.
Parameters
\**data** `object` *required*
Team creation options.
\**displayName** `string`
The display name for the team.
\**profileImageUrl** `string | null`
The URL of the team's profile image.
Returns
\`Promise`
\> \\[!NOTE]
\>
\> If client-side team creation is disabled in the Stack dashboard, this will throw an error.
Signature
\```typescript theme={null}
declare function createTeam(data: {
displayName?: string;
profileImageUrl?: string | null;
}): Promise;
\```
\
\
\`currentUser.leaveTeam(team)`
currentUser
Removes the user from the specified team.
Parameters
\**team** `Team` *required*
The team to leave.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function leaveTeam(team: Team): Promise;
\```
\
\
\`currentUser.getTeamProfile(team)`
currentUser
Retrieves the user's profile within a specific team.
Parameters
\**team** `Team` *required*
The team to get the profile for.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getTeamProfile(team: Team): Promise;
\```
\
\
\`currentUser.useTeamProfile(team)`
currentUser
React hook version of `getTeamProfile`.
Parameters
\**team** `Team` *required*
The team to get the profile for.
Returns
\`EditableTeamMemberProfile`
Signature
\```typescript theme={null}
declare function useTeamProfile(team: Team): EditableTeamMemberProfile;
\```
\
\
\`currentUser.listTeamInvitations`
currentUser
Lists all pending team invitations sent to any of the current user's verified email addresses.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listTeamInvitations(): Promise;
\```
\
\
\`currentUser.useTeamInvitations`
currentUser
React hook version of `listTeamInvitations`. Automatically re-renders when invitations change.
Returns
\`ReceivedTeamInvitation[]`
Signature
\```typescript theme={null}
declare function useTeamInvitations(): ReceivedTeamInvitation[];
\```
\
## Permissions
\
\`currentUser.hasPermission(scope, permissionId)`
currentUser
Checks if the user has a specific permission within a team.
Parameters
\**scope** `Team` *required*
The team scope.
\**permissionId** `string` *required*
The permission identifier.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function hasPermission(scope: Team, permissionId: string): Promise;
\```
\
\
\`currentUser.getPermission(scope, permissionId, [options])`
currentUser
Retrieves a specific permission with optional recursive lookup.
Parameters
\**scope** `Team` *required*
The team scope.
\**permissionId** `string` *required*
The permission identifier.
\**options.recursive** `boolean`
Whether to look up permissions recursively.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getPermission(
scope: Team,
permissionId: string,
options?: { recursive?: boolean },
): Promise;
\```
\
\
\`currentUser.usePermission(scope, permissionId, [options])`
currentUser
React hook version of `getPermission`.
Parameters
\**scope** `Team` *required*
The team scope.
\**permissionId** `string` *required*
The permission identifier.
\**options.recursive** `boolean`
Whether to look up permissions recursively.
Returns
\`TeamPermission | null`
Signature
\```typescript theme={null}
declare function usePermission(
scope: Team,
permissionId: string,
options?: { recursive?: boolean },
): TeamPermission | null;
\```
\
\
\`currentUser.listPermissions(scope, [options])`
currentUser
Lists all permissions for a team.
Parameters
\**scope** `Team` *required*
The team scope.
\**options.recursive** `boolean`
Whether to list permissions recursively.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listPermissions(
scope: Team,
options?: { recursive?: boolean },
): Promise;
\```
\
\
\`currentUser.usePermissions(scope, [options])`
currentUser
React hook version of `listPermissions`.
Parameters
\**scope** `Team` *required*
The team scope.
\**options.recursive** `boolean`
Whether to list permissions recursively.
Returns
\`TeamPermission[]`
Signature
\```typescript theme={null}
declare function usePermissions(
scope: Team,
options?: { recursive?: boolean },
): TeamPermission[];
\```
\
## Contact Channels
\
\`currentUser.listContactChannels`
currentUser
Lists the user's contact channels.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listContactChannels(): Promise;
\```
\
\
\`currentUser.useContactChannels`
currentUser
React hook version of `listContactChannels`.
Returns
\`ContactChannel[]`
Signature
\```typescript theme={null}
declare function useContactChannels(): ContactChannel[];
\```
\
\
\`currentUser.createContactChannel(data)`
currentUser
Creates a new contact channel for the user.
Parameters
\**data** `object` *required*
Contact channel creation options.
\**value** `string` *required*
The value of the contact channel (e.g., email address).
\**type** `"email"` *required*
The type of contact channel. Currently always `"email"`.
\**usedForAuth** `boolean` *required*
Whether this contact channel can be used for authentication.
\**isPrimary** `boolean`
Whether this should be set as the user's primary contact channel.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function createContactChannel(data: {
value: string;
type: "email";
usedForAuth: boolean;
isPrimary?: boolean;
}): Promise;
\```
Examples
\```typescript theme={null}
const channel = await user.createContactChannel({
type: "email",
value: "backup@example.com",
usedForAuth: true,
});
\```
\
\
\`currentUser.listNotificationCategories`
currentUser
Lists all notification categories.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listNotificationCategories(): Promise;
\```
\
\
\`currentUser.useNotificationCategories`
currentUser
React hook to get all notification categories.
Returns
\`NotificationCategory[]`
Signature
\```typescript theme={null}
declare function useNotificationCategories(): NotificationCategory[];
\```
\
## OAuth Connections
\
\`currentUser.listConnectedAccounts`
currentUser
Lists all connected accounts.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listConnectedAccounts(): Promise;
\```
\
\
\`currentUser.useConnectedAccounts`
currentUser
React hook version of `listConnectedAccounts`.
Returns
\`OAuthConnection[]`
Signature
\```typescript theme={null}
declare function useConnectedAccounts(): OAuthConnection[];
\```
\
\
\`currentUser.linkConnectedAccount(provider, [options])`
currentUser
Initiates an OAuth flow to link a new account.
Parameters
\**provider** `string` *required*
The OAuth provider.
\**options.scopes** `string[]`
Requested scopes.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function linkConnectedAccount(
provider: string,
options?: { scopes?: string[] },
): Promise;
\```
Examples
\```typescript theme={null}
await user.linkConnectedAccount("google", {
scopes: ["email", "profile"],
});
\```
\
\
\`currentUser.getOrLinkConnectedAccount(provider, [options])`
currentUser
Gets an existing connected account or redirects to link if it is missing or has insufficient scopes.
Parameters
\**provider** `string` *required*
The OAuth provider.
\**options.scopes** `string[]`
Requested scopes.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getOrLinkConnectedAccount(
provider: string,
options?: { scopes?: string[] },
): Promise;
\```
Examples
\```typescript theme={null}
const googleConnection = await user.getOrLinkConnectedAccount("google", {
scopes: ["email", "profile"],
});
\```
\
\
\`currentUser.useOrLinkConnectedAccount(provider, [options])`
currentUser
React hook version of `getOrLinkConnectedAccount`.
Parameters
\**provider** `string` *required*
The OAuth provider.
\**options.scopes** `string[]`
Requested scopes.
Returns
\`OAuthConnection`
Signature
\```typescript theme={null}
declare function useOrLinkConnectedAccount(
provider: string,
options?: { scopes?: string[] },
): OAuthConnection;
\```
\
\
\`currentUser.getOAuthProvider(id)`
currentUser
Gets a specific OAuth provider by ID.
Parameters
\**id** `string` *required*
The OAuth provider ID.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getOAuthProvider(id: string): Promise;
\```
\
\
\`currentUser.useOAuthProvider(id)`
currentUser
React hook to get a specific OAuth provider by ID.
Parameters
\**id** `string` *required*
The OAuth provider ID.
Returns
\`OAuthProvider | null`
Signature
\```typescript theme={null}
declare function useOAuthProvider(id: string): OAuthProvider | null;
\```
\
\
\`currentUser.listOAuthProviders`
currentUser
Lists all OAuth providers connected to the user.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listOAuthProviders(): Promise;
\```
\
\
\`currentUser.useOAuthProviders`
currentUser
React hook to get all OAuth providers connected to the user.
Returns
\`OAuthProvider[]`
Signature
\```typescript theme={null}
declare function useOAuthProviders(): OAuthProvider[];
\```
\
## Passkeys & Sessions
\
\`currentUser.registerPasskey([options])`
currentUser
Registers a passkey for the user for passwordless authentication.
Parameters
\**options.hostname** `string`
The hostname to associate with the passkey.
Returns
\`Promise>`
Signature
\```typescript theme={null}
declare function registerPasskey(options?: {
hostname?: string;
}): Promise>;
\```
\
\
\`currentUser.getActiveSessions`
currentUser
Gets all active sessions for the user.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getActiveSessions(): Promise;
\```
\
\
\`currentUser.revokeSession(sessionId)`
currentUser
Revokes a specific session for the user.
Parameters
\**sessionId** `string` *required*
The ID of the session to revoke.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function revokeSession(sessionId: string): Promise;
\```
\
## API Keys
\
\`currentUser.createApiKey(options)`
currentUser
Creates a new API key.
Parameters
\**options** `object` *required*
API key creation options.
\**description** `string` *required*
Purpose explanation for the key.
\**expiresAt** `Date | null` *required*
Expiration date, or `null` for no expiration.
\**isPublic** `boolean`
Defaults to `false`. Secret keys are scanned for exposure.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function createApiKey(options: {
description: string;
expiresAt: Date | null;
isPublic?: boolean;
}): Promise;
\```
Examples
\```typescript theme={null}
const apiKey = await user.createApiKey({
description: "CI token",
expiresAt: null,
});
console.log(apiKey);
\```
\
\
\`currentUser.listApiKeys`
currentUser
Lists the user's API keys.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listApiKeys(): Promise;
\```
\
\
\`currentUser.useApiKeys`
currentUser
React hook version of `listApiKeys`.
Returns
\`UserApiKey[]`
Signature
\```typescript theme={null}
declare function useApiKeys(): UserApiKey[];
\```
\
## Billing & Payments
\
\`currentUser.createCheckoutUrl(options)`
currentUser
Generates a Stripe checkout URL for purchasing a product.
Parameters
\**options.productId** `string`
The ID of the product to purchase.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function createCheckoutUrl(options: {
productId: string;
}): Promise;
\```
Examples
\```typescript theme={null}
const checkoutUrl = await user.createCheckoutUrl({
productId: "prod_premium_monthly",
});
window.location.href = checkoutUrl;
\```
\
\
\`currentUser.getItem(itemId)`
currentUser
Retrieves item details such as credits or subscriptions.
Parameters
\**itemId** `string`
The ID of the item to retrieve.
Returns
\`Promise- `
Signature
\```typescript theme={null}
declare function getItem(itemId: string): Promise
- ;
\```
\
\
\`currentUser.useItem(itemId)`
currentUser
React hook version of `getItem`.
Parameters
\**itemId** `string`
The ID of the item to retrieve.
Returns
\`Item`
Signature
\```typescript theme={null}
declare function useItem(itemId: string): Item;
\```
\
\
\`currentUser.createPaymentMethodSetupIntent`
currentUser
Creates a Stripe setup intent for adding a payment method.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function createPaymentMethodSetupIntent(): Promise;
\```
\
\
\`currentUser.setDefaultPaymentMethodFromSetupIntent(setupIntentId)`
currentUser
Sets the default payment method from a completed setup intent.
Parameters
\**setupIntentId** `string` *required*
The ID of the completed setup intent.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setDefaultPaymentMethodFromSetupIntent(
setupIntentId: string,
): Promise;
\```
\
\
\`currentUser.switchSubscription(options)`
currentUser
Switches a subscription from one product to another.
Parameters
\**options** `object` *required*
Subscription switch options.
\**fromProductId** `string` *required*
The product ID to switch from.
\**toProductId** `string` *required*
The product ID to switch to.
\**priceId** `string`
A specific price ID to use.
\**quantity** `number`
The quantity for the new subscription.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function switchSubscription(options: {
fromProductId: string;
toProductId: string;
priceId?: string;
quantity?: number;
}): Promise;
\```
\
\
\`currentUser.getBilling`
currentUser
Returns the billing information for the user.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getBilling(): Promise;
\```
\
\
\`currentUser.useBilling`
currentUser
React hook that returns the billing information.
Returns
\`CustomerBilling`
Signature
\```typescript theme={null}
declare function useBilling(): CustomerBilling;
\```
\
\
\`currentUser.listProducts([options])`
currentUser
Returns all products available to the user.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listProducts(options?: CustomerProductsListOptions): Promise;
\```
\
\
\`currentUser.useProducts([options])`
currentUser
React hook that returns all products.
Returns
\`CustomerProductsList`
Signature
\```typescript theme={null}
declare function useProducts(options?: CustomerProductsListOptions): CustomerProductsList;
\```
\
\
\`currentUser.listInvoices([options])`
currentUser
Returns all invoices for the user.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listInvoices(options?: CustomerInvoicesListOptions): Promise;
\```
\
\
\`currentUser.useInvoices([options])`
currentUser
React hook that returns all invoices.
Returns
\`CustomerInvoicesList`
Signature
\```typescript theme={null}
declare function useInvoices(options?: CustomerInvoicesListOptions): CustomerInvoicesList;
\```
\
## Deprecated
\
\`currentUser.emailAuthEnabled`
deprecated
currentUser
Whether email-based authentication is enabled for this user.
\> \\[!WARNING]
\>
\> **Deprecated:** Use contact channel's `usedForAuth` instead.
Type Definition
\`typescript declare const emailAuthEnabled: boolean; `
\
\
\`currentUser.oauthProviders`
deprecated
currentUser
The OAuth providers connected to this user account.
\> \\[!WARNING]
\>
\> **Deprecated:** Use `getConnectedAccount()` instead.
Type Definition
\`typescript declare const oauthProviders: readonly { id: string }[]; `
\
\
\`currentUser.sendVerificationEmail`
deprecated
currentUser
Sends a verification email to the user's primary email address.
\> \\[!WARNING]
\>
\> **Deprecated:** Use contact channel's `sendVerificationEmail` instead.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function sendVerificationEmail(): Promise;
\```
\
\
\`currentUser.getAuthJson`
deprecated
currentUser
Returns a JSON object with `accessToken` for non-HTTP protocols.
\> \\[!WARNING]
\>
\> **Deprecated:** Use `getAccessToken()` and `getRefreshToken()` instead.
Returns
\`Promise<{ accessToken: string | null }>`
Signature
\```typescript theme={null}
declare function getAuthJson(): Promise<{ accessToken: string | null }>;
\```
\
\
\`currentUser.useAuthJson`
deprecated
currentUser
React hook that returns the auth JSON.
\> \\[!WARNING]
\>
\> **Deprecated:** Use `useAccessToken()` and `useRefreshToken()` instead.
Returns
\`{ accessToken: string | null, refreshToken: string | null }`
Signature
\```typescript theme={null}
declare function useAuthJson(): { accessToken: string | null; refreshToken: string | null };
\```
\
\
\`currentUser.getConnectedAccount(account)`
deprecated
currentUser
Retrieves a specific connected account.
\> \\[!WARNING]
\>
\> **Deprecated:** Use `getOrLinkConnectedAccount` for redirect behavior, or `getConnectedAccount(\\{ provider, providerAccountId \\})` for existence check.
Parameters
\**account** `object` *required*
Connected account identifier.
\**provider** `string` *required*
The provider identifier.
\**providerAccountId** `string` *required*
The provider account identifier.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function getConnectedAccount(account: {
provider: string;
providerAccountId: string;
}): Promise;
\```
\
\
\`currentUser.useConnectedAccount(account)`
deprecated
currentUser
React hook version of `getConnectedAccount`.
\> \\[!WARNING]
\>
\> **Deprecated:** Use `useOrLinkConnectedAccount` for redirect behavior, or `useConnectedAccount(\\{ provider, providerAccountId \\})` for existence check.
Parameters
\**account** `object` *required*
Connected account identifier.
\**provider** `string` *required*
The provider identifier.
\**providerAccountId** `string` *required*
The provider account identifier.
Returns
\`OAuthConnection | null`
Signature
\```typescript theme={null}
declare function useConnectedAccount(account: {
provider: string;
providerAccountId: string;
}): OAuthConnection | null;
\```
\
***# `ServerUser`Accessible via `hexclaveServerApp.getUser()` on the server. `ServerUser` inherits most `CurrentUser` functionality minus session-dependent methods like `getAuthJson()` and `signOut()`.## Table of ContentsServerUser Table of Contents## Additional Properties
\
\`serverUser.lastActiveAt`
serverUser
Last user activity timestamp.
Type Definition
\`typescript declare const lastActiveAt: Date; `
\
\
\`serverUser.selectedTeam`
serverUser
The currently selected team as a `ServerTeam`, or `null` if no team is selected. Server-only functionality,
such as `addUser()` or the full member details returned by `listUsers()`, is available on it directly,
without fetching the team again with `hexclaveServerApp.getTeam()`.
Type Definition
\`typescript declare const selectedTeam: ServerTeam | null; `
\
\
\`serverUser.serverMetadata`
serverUser
Server-only accessible metadata.
Type Definition
\`typescript declare const serverMetadata: Json; `
\
\
\`serverUser.restrictedByAdmin`
serverUser
Whether the user has been restricted by an administrator.
Type Definition
\`typescript declare const restrictedByAdmin: boolean; `
\
\
\`serverUser.restrictedByAdminReason`
serverUser
The public reason why the user was restricted by an admin, or `null` if not restricted.
Type Definition
\`typescript declare const restrictedByAdminReason: string | null; `
\
\
\`serverUser.restrictedByAdminPrivateDetails`
serverUser
Private details about the admin restriction (only visible server-side), or `null` if not restricted.
Type Definition
\`typescript declare const restrictedByAdminPrivateDetails: string | null; `
\
\
\`serverUser.countryCode`
serverUser
The country code of the user based on their IP address, or `null` if unknown.
Type Definition
\`typescript declare const countryCode: string | null; `
\
\
\`serverUser.riskScores`
serverUser
Risk scores computed during sign-up, useful for fraud detection.
Type Definition
\```typescript theme={null}
declare const riskScores: {
readonly signUp: {
readonly bot: number;
readonly freeTrialAbuse: number;
};
};
\```
\
## Additional Methods
\
\`serverUser.update(data)`
serverUser
Extended update supporting server-only fields.
Parameters
\**data** `ServerUserUpdateOptions` *required*
The fields to update on the user.
\**displayName** `string | null`
Display name.
\**primaryEmail** `string | null`
Set the primary email.
\**primaryEmailVerified** `boolean`
Set email verification status.
\**primaryEmailAuthEnabled** `boolean`
Enable or disable email auth.
\**password** `string`
Set a new password.
\**clientMetadata** `Json`
Client metadata.
\**clientReadOnlyMetadata** `Json`
Client read-only metadata.
\**serverMetadata** `Json`
Server-only metadata.
\**selectedTeamId** `string | null`
Selected team ID.
\**profileImageUrl** `string | null`
Profile image URL.
\**totpMultiFactorSecret** `Uint8Array | null`
TOTP multi-factor authentication secret.
\**otpAuthEnabled** `boolean`
Whether OTP authentication is enabled.
\**passkeyAuthEnabled** `boolean`
Whether passkey authentication is enabled.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function update(data: ServerUserUpdateOptions): Promise;
\```
Examples
\```typescript theme={null}
await serverUser.update({
primaryEmail: "new@example.com",
primaryEmailVerified: true,
});
\```
\
\
\`serverUser.setPrimaryEmail(email, [options])`
serverUser
Sets the primary email for the user (server-side only).
Parameters
\**email** `string | null` *required*
The new primary email, or `null` to clear it.
\**options.verified** `boolean`
Whether to mark the email as verified.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setPrimaryEmail(
email: string | null,
options?: { verified?: boolean },
): Promise;
\```
Examples
\```typescript theme={null}
await serverUser.setPrimaryEmail("new@example.com", { verified: true });
\```
\
\
\`serverUser.setServerMetadata(metadata)`
serverUser
Sets the server metadata for the user.
Parameters
\**metadata** `Json` *required*
The new server metadata value.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setServerMetadata(metadata: any): Promise;
\```
Examples
\```typescript theme={null}
await serverUser.setServerMetadata({ plan: "premium", internalId: "abc123" });
\```
\
\
\`serverUser.setClientReadOnlyMetadata(metadata)`
serverUser
Sets the client read-only metadata that clients can read but not write.
Parameters
\**metadata** `Json` *required*
The new client read-only metadata value.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function setClientReadOnlyMetadata(metadata: any): Promise;
\```
Examples
\```typescript theme={null}
await serverUser.setClientReadOnlyMetadata({ role: "editor", tier: "pro" });
\```
\
\
\`serverUser.grantPermission(scope, permissionId)`
serverUser
Server-side permission assignment.
Parameters
\**scope** `Team` *required*
The team scope.
\**permissionId** `string` *required*
The permission to grant.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function grantPermission(scope: Team, permissionId: string): Promise;
\```
Examples
\```typescript theme={null}
const team = await serverUser.getTeam("team_id_123");
if (team) {
await serverUser.grantPermission(team, "my_permission_id");
}
\```
\
\
\`serverUser.revokePermission(scope, permissionId)`
serverUser
Server-side permission removal.
Parameters
\**scope** `Team` *required*
The team scope.
\**permissionId** `string` *required*
The permission to revoke.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function revokePermission(scope: Team, permissionId: string): Promise;
\```
Examples
\```typescript theme={null}
const team = await serverUser.getTeam("team_id_123");
if (team) {
await serverUser.revokePermission(team, "my_permission_id");
}
\```
\
\
\`serverUser.listContactChannels`
serverUser
Returns server-specific contact channel details as `ServerContactChannel[]`.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listContactChannels(): Promise;
\```
\
\
\`serverUser.listTeams([options])`
serverUser
Lists the teams the user belongs to, as `ServerTeam` objects. Accepts the same options as [`CurrentUser.listTeams`](#currentuserlistteams): if `limit` is omitted, all teams are returned (and the request fails if the user is in more than 500 teams), and `nextCursor` is set when there are more teams than the requested `limit`.
Parameters
\**options.cursor** `string`
The `nextCursor` of the previous page. Requires `limit` to also be set.
\**options.limit** `number`
Maximum number of items to return per page, up to 200. Defaults to 200.
\**options.orderBy** `"createdAt"`
The field to sort results by.
\**options.desc** `boolean`
Whether to sort in descending order. Defaults to `false`.
\**options.query** `string`
Free-text search on the team's display name (and team ID if the query is a UUID).
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function listTeams(options?: {
cursor?: string;
limit?: number;
orderBy?: "createdAt";
desc?: boolean;
query?: string;
}): Promise;
\```
Examples
\```typescript theme={null}
const teams = await serverUser.listTeams({ limit: 20 });
if (teams.nextCursor) {
const next = await serverUser.listTeams({
cursor: teams.nextCursor,
limit: 20,
});
}
\```
\
\
\`serverUser.useTeams([options])`
serverUser
React hook version of `listTeams`.
\> \\[!NOTE]
\>
\> This should be used on the server-side only.
Signature
\```typescript theme={null}
declare function useTeams(options?: {
cursor?: string;
limit?: number;
orderBy?: "createdAt";
desc?: boolean;
query?: string;
}): ServerTeam[] & { nextCursor: string | null };
\```
\
\
\`serverUser.createSession([options])`
serverUser
Creates a new session for the user. Can be used for impersonation.
Parameters
\**options.expiresInMillis** `number`
How long the session should last, in milliseconds.
\**options.isImpersonation** `boolean`
Whether this is an impersonation session.
Returns
\`Promise<{ getTokens(): Promise<{ accessToken: string | null; refreshToken: string | null }> }>`
Signature
\```typescript theme={null}
declare function createSession(options?: {
expiresInMillis?: number;
isImpersonation?: boolean;
}): Promise<{
getTokens(): Promise<{
accessToken: string | null;
refreshToken: string | null;
}>;
}>;
\```
Examples
\```typescript theme={null}
const session = await serverUser.createSession({
expiresInMillis: 60 * 60 * 1000,
});
const tokens = await session.getTokens();
\```
\
\
\`serverUser.grantProduct(product)`
serverUser
Grants a product to the user.
Parameters
\**product** `object` *required*
The product to grant. Either a `productId` or an inline product definition.
\**productId** `string`
The ID of an existing product to grant.
\**quantity** `number`
The quantity to grant.
Returns
\`Promise`
Signature
\```typescript theme={null}
declare function grantProduct(
product: { productId: string; quantity?: number } | { product: InlineProduct; quantity?: number },
): Promise;
\```
Examples
\```typescript theme={null}
await serverUser.grantProduct({
productId: "prod_premium",
quantity: 1,
});
\```
\
***# `CurrentServerUser`Combines all properties and methods from both `CurrentUser` and `ServerUser`, providing complete user access on the server side.## Table of ContentsCurrentServerUser Table of Contents> [!NOTE]
>
> React hook variants prefixed with `use` are available in React-like platforms
> and return unwrapped data rather than promises.