Skip to main content

Returns a PolicyViolation resource based on id.

GET 

/PolicyViolations/:policyViolationId

The PolicyViolation resource with matching id is returned.

Request

Path Parameters

    policyViolationId stringrequired

    The id of the PolicyViolation.

Query Parameters

    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 a PolicyViolation resource based on the id.

Schema

    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...