Skip to content

Class: metadata

Internal Vault developers use Application Security Rules to control access to records. External developers cannot create custom Application Security Rules, but they can create two types of subcomponents, Appsecurityfield and Appsecutityassignment, that map Appsecrityrules to Objects. This allows assignments to be moved between Vaults using migration packages (VPKs).

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
allow_custom_objectsType: Boolean
Required
If true, the rule can be applied to custom objects.
descriptionType: String
Max length: 255
A general description of the rule.
help_contentType: String
Max length: 255
UI-friendly help string.

Internal Vault developers use Application Security Rules to control access to records. External developers cannot create custom Application Security Rules, but they can create two types of subcomponents, Appsecurityfield and Appsecutityassignment, that map Appsecrityrules to Objects. This allows assignments to be moved between Vaults using migration packages (VPKs).

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
multi_valueType: BooleanIf true, allows multiple values.
objectType: ComponentReference to Object component.
picklistType: ComponentReference to the Picklist component.
typeType: Enum
Required
Allowed values:
  • OBJECT
  • PICKLIST
  • BOOLEAN
The type of the field.

Internal Vault developers use Application Security Rules to control access to records. External developers cannot create custom Application Security Rules, but they can create two types of subcomponents, Appsecurityfield and Appsecutityassignment, that map Appsecrityrules to Objects. This allows assignments to be moved between Vaults using migration packages (VPKs).

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
appsecurityfieldType: ComponentReferenceLegacy reference to Appsecurityfield subcomponent. As of 24R1.2, this attribute has been deprecated and replaced by securityfield.
fieldType: Subcomponent
Required
Reference to an object field subcomponent in the format Field.{field_name}. For example, Field.study_migration__v.
objectType: Component
Required
Reference to Object component.
securityfieldType: SubcomponentReferenceReference to Appsecurityfield subcomponent.
securityruleType: ComponentReference(Read-only) Reference to the parent Appsecurityrule component.
OperationSupport
Create
Recreate*
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

  • Recreate, Alter: MDL Operation is supported only to create or alter custom subcomponents.