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

PolicyIssue represents a policy violation or issue detected during policy evaluation.

Properties

• id string required
  The unique identifier of the policy issue.
• entityType enum required
  The type of entity this issue applies to.
  Values: stack, insights-account
• entityProject string required
  The project name (for stack entities) or parent Insights account name (for resource entities).
• entityId string required
  The identifier of the entity this issue applies to.
• stackVersion integer optional
  The stack version where the issue was detected.
• resourceVersion integer optional
  The resource version where the issue was detected.
• policyPack string required
  The name of the policy pack that produced this issue.
• policyPackTag string required
  The tag of the policy pack version that produced this issue.
• policyName string required
  The name of the policy that was violated.
• resourceURN string required
  The URN of the resource that violated the policy.
• resourceProvider string required
  The provider of the resource that violated the policy.
• resourceType string required
  The type of the resource that violated the policy.
• resourceName string required
  The name of the resource that violated the policy.
• message string optional
  A human-readable message describing the policy violation.
• observedAt string required
  The timestamp when the issue was first observed.
• lastModified string optional
  The timestamp when the issue was last modified.
• level string required
  The enforcement level of the policy (e.g. advisory, mandatory, disabled).
• severity enum required
  The severity of the policy violation.
  Values: , low, medium, high, critical
• status enum required
  The current status of the policy issue.
  Values: open, in_progress, by_design, fixed, ignored
• kind enum required
  The kind of policy issue (audit or preventative).
  Values: audit, preventative
• priority enum required
  The priority level of the policy issue.
  Values: p0, p1, p2, p3, p4
• assignedTo UserInfo optional
  The user the policy issue is assigned to.
• ↳ name string required
  The user’s display name.
• ↳ githubLogin string required
  The user’s login name.
• ↳ avatarUrl string required
  The URL of the user’s avatar image.
• ↳ email string optional
  IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information.
• policyGroupName string optional
  The name of the policy group this issue belongs to.
• policyGroupType enum optional
  The type of the policy group this issue belongs to.
  Values: audit, preventative