On this page
No Headings
objectcoderequiredstring^[a-zA-Z0-9_-]+$Unique identifier for this specific privilege within the feature. Used as a key when setting privilege values.
namestringUser-friendly display name for this privilege shown in interfaces. More descriptive than the code and helps users understand what this specific setting controls.
value_typerequiredstring"STRING", "BOOLEAN", "INTEGER", "SELECT""STRING"Defines the data type that this privilege accepts when being assigned values in entitlements. 'INTEGER' for numeric limits, 'BOOLEAN' for on/off toggles, 'STRING' for text values, 'SELECT' for predefined options.
configobjectAdditional configuration for privileges that require constraints or options. Currently used for 'select' type privileges to define allowed values.
select_optionsarrayDefines the allowed values when value_type is 'select'. When creating entitlements, only these predefined options can be assigned. Useful for features like SSO providers, regions, or service tiers.
itemsstringvalueThe specific value assigned to this privilege in the plan. The type of value must match the value_type field. For integer types, this represents numeric limits (e.g., 100 users); for boolean types, true/false settings (e.g., enable/disable features); for string or select types, specific configuration options (e.g., 'premium', 'basic').