AuthContext

Defined in: src/auth.ts:7

Authentication context available to RPC handlers.

Constructors

Constructor

new AuthContext(
   domain,
   authenticated,
   principal,
   claims?): AuthContext;

Defined in: src/auth.ts:18

Parameters

Parameter	Type
domain	string
authenticated	boolean
principal	string | null
claims	Record<string, any>

Returns

AuthContext

Properties

authenticated

readonly authenticated: boolean;

Defined in: src/auth.ts:12

True when the request carried valid credentials.

---

claims

readonly claims: Record<string, any>;

Defined in: src/auth.ts:16

Arbitrary verified claims about the principal (e.g. decoded JWT claims).

---

domain

readonly domain: string;

Defined in: src/auth.ts:10

Authentication domain/realm that vouched for the principal; empty string when anonymous.

---

principal

readonly principal: string | null;

Defined in: src/auth.ts:14

Authenticated principal identifier, or null when anonymous.

Methods

requireAuthenticated()

requireAuthenticated(): void;

Defined in: src/auth.ts:31

Throw an RpcError if this context is not authenticated.

Returns

void

---

anonymous()

static anonymous(): AuthContext;

Defined in: src/auth.ts:26

Create an unauthenticated (anonymous) context.

Returns

AuthContext