Skip to main content

Returns all PolicyViolation resources.​

This endpoint returns all PolicyViolation resources.

Query Parameters
  • filter string

    Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

  • sortBy string

    Allows sorting the results by a resource's attributes.

  • sortOrder string

    Default value: ascending

    Determines what order to sort results in.

  • startIndex integer

    Default value: 1

    Determines the starting index of the result set.

  • count integer

    Default value: 1000

    Specifies the number of results per page.

  • attributes string

    A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

  • excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses

Returns all PolicyViolation resources.

Schema
  • totalResults integer

    Number of PolicyViolation resources returned

  • startIndex integer

    The starting index of the resource set list. Can be specified with startIndex query parameter.

  • schemas string[]

    SCIM Schema used for response.

  • Resources undefined[]
  • id string

    IdentityIQ id of the PolicyViolation.

  • policyName string

    Name of the Policy this PolicyViolation is associated with.

  • constraintName string

    Name of the Constraint this PolicyViolation is associated with.

  • identity object

    The Identity (User) that caused the PolicyViolation.

  • displayName string

    Display name of the Identity that caused the PolicyViolation.

  • value string

    The id of the Identity which caused the PolicyViolation.

  • $ref string

    URI reference to the Identity (User).

  • owner object

    The User that owns the Policy.

  • displayName string

    Display name of the Policy owner.

  • value string

    The id of the Policy owner.

  • $ref string

    URI reference to the Policy owner.

  • description string

    Description of the PolicyViolation.

  • status string

    Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.

  • meta

    Metadata of the resource.

  • created date-time

    Datetime this Resource was created.

  • location string

    The location of the resource.

  • lastModified date-time

    Datetime the resource was last modified.

  • version string

    The version of the resource.

  • resourceType string

    The SCIM resource type.

  • schemas string[]

    The schemas involved in the SCIM resource.

Loading...