One-click install
npx skills add https://github.com/CrystallizeAPI/ai --skill permissions-crystallizeapi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: permissions
Source: https://github.com/CrystallizeAPI/ai/tree/main/use-crystallize/skills/permissions
Command: npx skills add https://github.com/CrystallizeAPI/ai --skill permissions-crystallizeapi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Crystallize permissions and access control can be difficult to design correctly, especially when you need to restrict sensitive fields while keeping integrations working.

Core Features & Use Cases

  • UI vs API permissions clarity: Explain that UI read-only/hidden settings do not block API writes, so you must configure CRUD permissions for real enforcement.
  • Role-based access design: Create and manage built-in and custom roles with the one-role-per-user constraint in mind.
  • Field-level and resource-level control: Apply shape field permissions (read-only or hidden) and combine them with CRUD permissions for shapes, items, price variants, catalogue folders, topics, orders, and users.
  • Access token strategy: Choose user tokens for role-scoped access or tenant-level API tokens for service-to-service integrations.

Quick Start

Use the permissions skill to design a role and token plan that enforces CRUD restrictions on sensitive fields while using UI locks only for editor experience.

Frequently Asked Questions about permissions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce field-level security in Crystallize so API writes are actually blocked?

Field-level security in Crystallize requires configuring CRUD permissions on shapes and fields, because UI read-only or hidden settings only affect the editor experience and do not block API writes. You must apply API-enforced restrictions to prevent unauthorized modifications.

What is the best way to design role-based permissions for multi-team workflows in Crystallize?

Designing role-based permissions for multi-team workflows involves mapping custom and built-in roles to specific catalogue folders, price variants, and shapes. You must account for the one-role-per-user constraint when structuring access control across your teams.

Can I restrict access to specific catalogue folders and price variants in Crystallize?

Yes, you can restrict access to specific catalogue folders and price variants by applying CRUD permissions at the resource level. This allows you to control exactly who can view or modify specific content within your multi-role workflows.

Why does setting a shape field to read-only in the UI still allow API updates?

Setting a shape field to read-only in the UI only controls the editor experience and does not enforce security. To actually block API updates, you must configure the corresponding CRUD permissions to restrict write access at the API level.

How do I map user roles and access tokens to the GraphQL Core API permission model?

Mapping user roles and access tokens to the GraphQL Core API permission model requires distinguishing UI-only locks from API-enforced restrictions. You assign role-scoped user tokens for individual access and tenant-level API tokens for integrations.