Sanity Library Reference Docs
    Preparing search index...

    Interface BlueprintRoleConfigBeta

    Configuration for a custom role. This feature is subject to breaking changes.

    interface BlueprintRoleConfig {
        appliesToRobots: boolean;
        appliesToUsers: boolean;
        description?: string;
        name: string;
        permissions: RolePermission[];
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    appliesToRobots: boolean
    appliesToUsers: boolean
    description?: string
    name: string
    permissions: RolePermission[]

    Type declaration

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

    • Betaaction: string

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

    • Betaname: string

      Predefined permission name (e.g., 'sanity-all-documents')

    • Optional Betaparams?: Record<string, unknown>

      Additional parameters for the permission

    title: string