Skip to main content

Interface: ListAccessibleObjectsArgs<Schema>

Defined in: packages/polizy/src/types.ts:277

Arguments for the listAccessibleObjects method

Type Parameters​

Schema​

Schema extends AuthSchema<any, any, any, any, any>

Properties​

canThey?​

optional canThey?: keyof Schema["actionToRelations"]

Defined in: packages/polizy/src/types.ts:283


context?​

optional context?: Record<string, any>

Defined in: packages/polizy/src/types.ts:285


maxDepth?​

optional maxDepth?: number

Defined in: packages/polizy/src/types.ts:295

Bounds only the group-membership expansion of the subject closure (how many nested-group hops from who are explored). It does NOT bound hierarchy hops. Total check/path depth (group + hierarchy hops) is always governed and capped by the engine's defaultCheckDepth.

Defaults to defaultCheckDepth. This is an advanced, rarely-needed knob.


ofType​

ofType: SchemaObjectTypes<Schema>

Defined in: packages/polizy/src/types.ts:281


who​

who: TypedSubject<Schema>

Defined in: packages/polizy/src/types.ts:280