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, or if not, will:

  • returns null on Convex queries, mutations, actions.
  • throw on HTTP Actions.

Defined in​

server/authentication.ts:167