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

CreatePolicyPackRequest defines the request body for creating a new Policy Pack for an organization. The request contains the metadata related to the Policy Pack.

Properties

• name string required
  Name is a unique URL-safe identifier (at the org level) for the package. If the name has already been used by the organization, then the request will create a new version of the Policy Pack (incremented by one). This is supplied by the CLI.
• displayName string required
  A pretty name for the Policy Pack that is supplied by the package.
• versionTag string optional
  VersionTag is the semantic version of the Policy Pack. One a version is published, it cannot never be republished. Older clients will not have a version tag.
• policies array[AppPolicy] required
  The Policies outline the specific Policies in the package, and are derived from the package by the CLI.
• ↳ 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.
• ↳ severity enum optional
  The severity of the policy.
  Values: , low, medium, high, critical
• ↳ framework AppPolicyComplianceFramework optional
  The compliance framework that this policy belongs to.
• ↳ 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.
• description string optional
  A brief description of the policy pack.
• readme string optional
  README text about the policy pack.
• provider string optional
  The cloud provider/platform this policy pack is associated with, e.g. AWS, Azure, etc.
• tags array[string] optional
  Tags for this policy pack.
• repository string optional
  A URL to the repository where the policy pack is defined.
• metadata map[string]string optional
  Metadata contains optional data about the environment performing the publish operation, e.g. the current source code control commit information.