Skip to content

VexApiAuth

VexApiAuth = object

Defined in: packages/core/src/api/types.ts:749

The resolved caller identity RBAC guards check against. Returned by a user-supplied getAuth callback.

VexApiOptions for where getAuth is configured.

optional organization?: Record<string, unknown>

Defined in: packages/core/src/api/types.ts:761

Passed as hasPermission’s organization. Shape is caller-defined; omit when the access config has no orgCollectionSlug.


user: Record<string, unknown> | null

Defined in: packages/core/src/api/types.ts:756

Passed as hasPermission’s user — shape is caller-defined. Must include whatever field access.userRolesField names (a role string or string[]) for role resolution to succeed; a user object without it resolves to an empty role list and denies every check.