Jump to

• Request
• Response
• Examples

Get Pending Violation

get

/iam/governance/selfservice/api/v1/policyviolations/{pvid}

Returns the pending violation policy details specified by the policy violation ID.

Request

Supported Media Types

• application/json

Path Parameters

• pvid: string
  Policy violation ID.

Query Parameters

• fields(optional): string
  Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "action, comment, entityType, severity, status". Nested entities cannot be filtered for example the "targetRole, remediatorRole" etc cannot be the attributes which can be returned.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : PolicyViolationGET

Type: object

Show Source

• fields(optional): array fields
• links(optional): array links
• remediatorRole(optional): object IDARoleInfo
• remediatorUser(optional): object IDAUserInfo
• targetRole(optional): object IDARoleInfo
• targetUser(optional): object IDAUserInfo

{
    "properties":{
        "remediatorUser":{
            "$ref":"#/definitions/IDAUserInfo"
        },
        "targetUser":{
            "$ref":"#/definitions/IDAUserInfo"
        },
        "remediatorRole":{
            "$ref":"#/definitions/IDARoleInfo"
        },
        "targetRole":{
            "$ref":"#/definitions/IDARoleInfo"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

• [0]: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : IDARoleInfo

Type: object

Show Source

• displayName(optional): string
• links(optional): array links

{
    "properties":{
        "displayName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : IDAUserInfo

Type: object

Show Source

• displayName(optional): string
• links(optional): array links

{
    "properties":{
        "displayName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example retrieves the details for a policy violation. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/2F73586E83AE4C668CAA6A7E488223F3/37558610F9824B4B802E12F594EDE46A

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/2F73586E83AE4C668CAA6A7E488223F3/37558610F9824B4B802E12F594EDE46A"
    }
  ],
  "policyName": "3BEE7E35DCAC4091BE9BE3612B551EF1",
  "action": "CLOSE",
  "detectionCount": "5",
  "entityType": "PolicyViolation",
  "lastDetectedDate": "Mon Apr 04 15:57:00 IST 2016",
  "remediatorAssignDate": "Mon Mar 21 18:51:09 IST 2016",
  "severity": "MEDIUM",
  "status": "CLOSED",
  "remediatorUser": {
    "links": [
      {
        "rel": "self",
        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/NGHORPADE"
      }
    ],
    "displayName": "Neelesh Ghorpade",
    "targetUser": {
      "link": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/[e-mail]"
        }
      ],
      "displayName": "User2_FN User2_FN"
    }
  }
}

Back to Top