Key Policies

Overview

Key policies allow for specific scoping policies to be applied to Metadata keys. Scoping metadata allows for the availability of metadata to be customized. The same value for a specific key can be made available to all users and applications, or they can each have their own values for a certain key.

Scoping

Several scoping policies can be applied to metadata keys:

  • global: (default) the value of a metadata key is the same across all users and applications
  • user: the value of a metadata key is unique for each user
  • application: the value of a metadata key is unique for a specific application
  • app user: the value of a metadata key is unique for a particular user operating a specific application

Details

The value of a key is tied to the key's scope. If the scoping policy for a key is changed, the value of that key will be cleared for the new scope. If the policy is reverted back to the original, however, the old value of the key will be reinstated.

Keys that are prefixed with $ are system keys that are controlled by system key policies. New system keys cannot be created; new keys cannot be prefixed with $.

The "meta" field exists in the ecosystem, environment, zone, device, and user records.