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

Response body for retrieving a policy issue and its associated policy details.

Properties

• policyIssue PolicyIssue required
  The policy issue details
• ↳ 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.
• ↳ 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
• policy AppPolicy optional
  The policy definition that caused this issue. May be null if the policy has been deleted or is unavailable.
• ↳ 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.
• policyPack RegistryPolicyPack optional
  The registry policy pack metadata. May be null if the policy pack is unavailable.
• ↳ id string required
  ID is the unique identifier for this policy pack in the registry. This is a UUID that corresponds to the policy pack’s database ID.
• ↳ source string required
  Source indicates where this policy pack is hosted (e.g., “private”, “pulumi”). Currently, only “private” policy packs are supported.
• ↳ publisher string required
  Publisher is the organization or user that published this policy pack. This corresponds to the Pulumi organization name.
• ↳ name string required
  Name is the unique identifier for this policy pack within the publisher’s namespace. Policy pack names must be URL-safe and unique per publisher.
• ↳ version string required
  Version is the semantic version of this policy pack. This represents the latest or specific version being referenced.
• ↳ displayName string required
  DisplayName is a human-readable name for this policy pack. This is typically more descriptive than the technical name.
• ↳ accessLevel enum required
  AccessLevel is the client’s level of access to this policy pack.
  Values: full, view-only, deny
• ↳ enforcementLevels array[string] required
  EnforcementLevels are the client’s allowed enforcement levels for this policy pack.