Skip to content

Class: metadata

Atomic security provides an additional layer of control by allowing you to configure security at the lifecycle state and/or assigned role level.

AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
objectType: Component
Required
The Object the security applies to. For example, Object.country__v
object_lifecycleType: Component
Required
The Objectlifecycle the security applies to. For example, Objectlifecycle.general_lifecycle__c
stateType: Component
Required
The Objectlifecyclestate of the Objectlifecycle the security applies to. For example, Objectlifecyclestate.active_state__c
AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
roleType: Component
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
typeType: Enum
Required
Allowed values:
  • hide__v
  • read__v
  • edit__v
The type of permission to apply.
fieldsType: Component
Required
Multi-value
The fields to apply this permission to.
AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
roleType: Component
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
typeType: Enum
Required
Allowed values:
  • hide__v
  • view__v
The type of permission to apply.
object_controlsType: Component
Required
Multi-value
The object control permissions to apply. Learn more about Object Control Permissions in Vault Help.
AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
roleType: Component
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
typeType: Enum
Required
Allowed values:
  • hide__v
  • view__v
  • execute__v
The type of permission to apply.
object_actionsType: Component
Multi-value
The Object level action(s) to apply this permission to.
lifecycle_actionsType: Component
Multi-value
The Lifecycle level action(s) to apply this permission to.
AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
roleType: Component
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
typeType: Enum
Required
Allowed values:
  • hide__v
  • execute__v
The type of permission to apply.
workflow_actionsType: Enum
Multi-value
Allowed values:
  • addparticipants
  • cancel
  • emailparticipants
  • removecontent
  • updateworkflowduedate
The workflow action to apply.
workflow_task_actionsType: Enum
Multi-value
Allowed values:
  • cancel
  • reassign
  • updateduedate
The workflow task action to apply.
AttributeMetadataDescription
labelType: String
Required
Max length: 60
UI-friendly string in the Vault’s base language.
activeType: BooleanIndicates whether the component is active.
roleType: Component
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
typeType: Enum
Required
Allowed values:
  • read__v
  • edit__v
The type of permission to apply.
document_fieldsType: Component
Multi-value
Lists the object fields corresponding to the object-to-document inbound relationship on the specified object.
object_fieldsType: Component
Multi-value
Lists the object fields corresponding to the object-to-object relationship on the specified object.
OperationSupport
Create
Recreate
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

  • Alter: MDL Operation may not be supported for some multi-value attributes.