> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interface: Auth

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

[server](/api/modules/server).Auth

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

## Methods

### getUserIdentity

▸ **getUserIdentity**(): `Promise`\<`null` | [`UserIdentity`](/api/interfaces/server.UserIdentity)>

Get details about the currently authenticated user.

#### Returns

`Promise`\<`null` | [`UserIdentity`](/api/interfaces/server.UserIdentity)>

A promise that resolves to a [UserIdentity](/api/interfaces/server.UserIdentity) if the Bijection
client was configured with a valid ID token, or if not, will:

* returns `null` on Bijection queries, mutations, actions.
* `throw` on HTTP Actions.