Get Policy Violations Tasks
get
/iam/governance/selfservice/api/v1/policyviolations/{pvid}/causes
Returns the causes associated with the specified policy violation ID. The attributes that are to be returned can be specified as part of the query parameter named "fields". For example: The URI to get the rule name, rule description, rule condition and status attributes for a particular policy violation is /policyviolations/{pvid}/causes?fields=ruleName,ruleDescription,ruleCondition,status. The attributes are to be spcified in a Comma-separated list. The causes can be filtered based on status, rule name, rule description etc. For example to get all causes for a policy violation which are related to rule named "Invalid Email" the URI is /policyviolations/{pvid}/causes?q=ruleName eq Invalid::Email. Note the status returned as part of the payload have strings like "ACTIVE,RESOLVED, MANUALLY FIXED etc", however if there is a filter to be addedd for filter then the string to be used is "policyviolationcause.status.active, policyviolationcause.status.resolved, policyviolationcause.status.manuallyfixed etc" for ACTIVE
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"
-
policyDescription(optional): string
The policy violation tasks will be filtered based on the policy description. All the tasks which map to the policy with the given description will be returned.
-
policyName(optional): string
The policy violation tasks will be filtered based on the policy name. All the tasks which map to the policy with the given policy name will be returned.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Resource not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves the causes for a given policy violations. 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/D15E3910F42A4626AA8CBA219A 58A478/causes
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes?offset=1&limit=10"
},
{
"rel": "first",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes?offset=1&limit=10"
}
],
"count": 2,
"hasMore": false,
"totalResult": -1,
"policyViolationCauseList": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes/7DBE8AB5D3D1493CB6022351E37A8492"
}
],
"id": "7DBE8AB5D3D1493CB6022351E37A8492",
"policyViolationId": "D15E3910F42A4626AA8CBA219A58A478",
"fields": [
{
"name": "ruleCondition",
"value": {
"substituteArg2": false,
"secondArgument": "Fraud Supervisor",
"searchBase": null,
"searchDepth": null,
"firstArgument": "role",
"operator": "EQUAL"
}
},
{
"name": "update",
"value": "2019-04-10T21:12:16Z"
},
{
"name": "policyViolationId",
"value": "D15E3910F42A4626AA8CBA219A58A478"
},
{
"name": "updateById",
"value": "4"
},
{
"name": "name",
"value": "0F9889703C404D3F909192391A9B1C38"
},
{
"name": "remediationEntityId",
"value": "9"
},
{
"name": "create",
"value": "2019-04-10T21:12:16Z"
},
{
"name": "action",
"value": "ACTIVATE"
},
{
"name": "ruleName",
"value": "rule1 fraud supervisor"
},
{
"name": "createById",
"value": "4"
},
{
"name": "remediationEntityType",
"value": "Role"
},
{
"name": "id",
"value": "7DBE8AB5D3D1493CB6022351E37A8492"
},
{
"name": "ruleId",
"value": "AB4F6F3D8A7D428EA054B11D96EC726D"
},
{
"name": "status",
"value": "ACTIVE"
}
]
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes/E07FC16C459147A49A7BDADF1810EE92"
}
],
"id": "E07FC16C459147A49A7BDADF1810EE92",
"policyViolationId": "D15E3910F42A4626AA8CBA219A58A478",
"fields": [
{
"name": "ruleCondition",
"value": {
"substituteArg2": false,
"secondArgument": "Fraud Supervisor",
"searchBase": null,
"searchDepth": null,
"firstArgument": "role",
"operator": "EQUAL"
}
},
{
"name": "update",
"value": "2019-04-10T21:12:16Z"
},
{
"name": "policyViolationId",
"value": "D15E3910F42A4626AA8CBA219A58A478"
},
{
"name": "updateById",
"value": "4"
},
{
"name": "name",
"value": "760680CEE791466E9E85175E433143CF"
},
{
"name": "create",
"value": "2019-04-10T21:12:16Z"
},
{
"name": "action",
"value": "ACTIVATE"
},
{
"name": "ruleName",
"value": "rule1 fraud supervisor"
},
{
"name": "createById",
"value": "4"
},
{
"name": "id",
"value": "E07FC16C459147A49A7BDADF1810EE92"
},
{
"name": "ruleId",
"value": "AB4F6F3D8A7D428EA054B11D96EC726D"
},
{
"name": "status",
"value": "ACTIVE"
}
]
}
]
}