zero-auth

Appearance

zero-auth API Documentation v1.6.0

zero-auth API Documentation / AuthUser

Interface: AuthUser ​

Defined in: packages/zero-auth/src/types/auth.ts:292

The decoded user object attached to req.user after middleware runs.

Extends ​

Indexable ​

[key: string]: unknown

Any additional custom claims.

Properties ​

email? ​

optional email?: string

Defined in: packages/zero-auth/src/types/auth.ts:268

User email (optional).

Inherited from ​

JwtPayload.email

exp? ​

optional exp?: number

Defined in: packages/zero-auth/src/types/auth.ts:296

Token expiration timestamp (seconds since epoch).

iat? ​

optional iat?: number

Defined in: packages/zero-auth/src/types/auth.ts:294

Token issued-at timestamp (seconds since epoch).

id ​

id: string

Defined in: packages/zero-auth/src/types/auth.ts:266

Unique user identifier (required).

Inherited from ​

JwtPayload.id

jti? ​

optional jti?: string

Defined in: packages/zero-auth/src/types/auth.ts:298

Token ID (jti) if present

permissions? ​

optional permissions?: string[]

Defined in: packages/zero-auth/src/types/auth.ts:272

Fine-grained permission strings.

Inherited from ​

JwtPayload.permissions

role? ​

optional role?: string

Defined in: packages/zero-auth/src/types/auth.ts:270

Primary user role for RBAC.

Inherited from ​

JwtPayload.role