Interface RolePermission`Beta`

A permission definition for a role. This feature is subject to breaking changes.

interface RolePermission {
    action: string;
    name: string;
    params?: Record<string, unknown>;
}

Properties

action: string

Permission action (e.g., 'read', 'mode')

name: string

Predefined permission name (e.g., 'sanity-all-documents'), or a reference to a permission in the blueprint (e.g., '$.resources.articles-only')

params?: Record<string, unknown>

Additional parameters for the permission