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

A policy exception.

Properties

• id string required
  The exception ID, unique within the organization, for example EXC-42.
• policyPack string required
  The name of the policy pack the exception applies to.
• match array[PolicyExceptionMatch] required
  The exception’s entries.
• ↳ policies array[string] required
  The names of policies within the policy pack: between 1 and 100 non-blank names.
• ↳ targets array[string] required
  The URNs of the resources the violations are reported against: between 1 and 100 URNs of at most 2048 characters each.
• reason string required
  The justification for the exception.
• status enum required
  The exception’s lifecycle status.
  Values: active, removed
• expiresAt string optional
  When the exception expires, after which it’s removed. Null if it never expires.
• changeRequestId string optional
  The change request that approved the exception, if creating it required approval.
• createdBy UserInfo optional
  The user who created the exception, if the user still exists.
• ↳ 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
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• createdAt string required
  When the exception was created.
• removedBy UserInfo optional
  The user who removed the exception, if the user still exists.
• ↳ 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
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• removedAt string optional
  When the exception was removed. Null while it is active.