1. Docs
2. Reference
3. REST API Docs
4. Schema
5. AppPolicy

Policy defines the metadata for an individual Policy within a Policy Pack.

Properties

• name string required
  Unique URL-safe name for the policy. This is unique to a specific version of a Policy Pack.
• displayName string required
  The display name
• description string required
  Description is used to provide more context about the purpose of the policy.
• enforcementLevel enum required
  The enforcement level
  Values: advisory, mandatory, remediate, disabled
• message string required
  Message is the message that will be displayed to end users when they violate this policy.
• configSchema AppPolicyConfigSchema optional
  The JSON schema for the Policy’s configuration.
• ↳ properties map[string]object optional
  Config property name to JSON Schema map.
• ↳ required array[string] optional
  Required config properties.
• ↳ type enum required
  Type defines the data type allowed for the schema.
  Values: object
• severity enum optional
  The severity of the policy.
  Values: , low, medium, high, critical
• framework AppPolicyComplianceFramework optional
  The compliance framework that this policy belongs to.
• ↳ name string optional
  The compliance framework name.
• ↳ version string optional
  The compliance framework version.
• ↳ reference string optional
  The compliance framework reference.
• ↳ specification string optional
  The compliance framework specification.
• tags array[string] optional
  Tags associated with the policy.
• remediationSteps string optional
  A description of the steps to take to remediate a policy violation.
• url string optional
  A URL to more information about the policy.