Skip to main content

Interface: Auth

server.Auth

An interface to access information about the currently authenticated user within Convex query and mutation functions.

Methods

getUserIdentity

getUserIdentity(): Promise<null | UserIdentity>

Get details about the currently authenticated user.

Returns

Promise<null | UserIdentity>

A promise that resolves to a UserIdentity if the Convex client was configured with a valid ID token and null otherwise.