AccessCallOptions
Defined in: packages/core/src/api/types.ts:45
Per-call access options. Server-side only — NEVER accept these from a registered
Convex function’s args: an action no role declares falls through to
defaultPermissionMode (default allow), so a client-chosen action reads anything.
Type Parameters
Section titled “Type Parameters”A extends string = string
Action union accepted for this call shape.
Properties
Section titled “Properties”action?
Section titled “action?”
optionalaction?:A
Defined in: packages/core/src/api/types.ts:52
Permission action to check instead of the function’s natural verb. Use for custom
actions (listFeatured) and for draft reads (readDrafts).
Default Value
Section titled “Default Value”the function’s natural verb (read, create, update, delete)
bypass?
Section titled “bypass?”
optionalbypass?:boolean
Defined in: packages/core/src/api/types.ts:59
Skip RBAC for this call entirely. Also skips getAuth, so a public read costs no
session lookup.
Default Value
Section titled “Default Value”false