REST API for Oracle Identity Governance Self Service

  1. REST API for Oracle Identity Governance Self Service
  2. Tasks
  3. Identity Audit

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
Query Parameters
  • Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "action, comment, entityType, severity, status"
  • 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.
  • 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.
Back to Top

Response

Supported Media Types
  • application/json

200 Response

Successful
Headers
Body (
  1. PolicyViolationTasksGET
)
Root Schema : PolicyViolationTasksGET
Type: object
Show Source
  • count(optional): integer
  • hasMore(optional): boolean
  • links(optional): array links
  • policyViolationCauseList(optional): array policyViolationCauseList
  • totalResult(optional): integer
Nested Schema : policyViolationCauseList
Type: array
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source
  • href(optional): string
  • rel(optional): string
Nested Schema : PolicyViolationTaskGet
Type: object
Show Source
  • fields(optional): array fields
  • id(optional): string
  • links(optional): array links
  • policyViolationId(optional): string
Nested Schema : fields
Type: array
Show Source
Nested Schema : Fields
Type: object
Show Source
  • name(optional): string
  • value(optional): string

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error
Back to Top

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/5D4D3C107D7745A8BC21F6DB9888959D/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/iam/governance/selfservice/api/v1/policyviolations/5D4D3C107D7745A8BC21F6DB9888959D/causes"
    }
  ],
  "totalResult": 1,
  "policyViolationCauseList": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/5D4D3C107D7745A8BC21F6DB9888959D/causes/287874BB86344E3DA243FC84029D76AF"
        }
      ],
      "policyViolationCauseId": "287874BB86344E3DA243FC84029D76AF",
      "policyViolationId": "5D4D3C107D7745A8BC21F6DB9888959D",
      "status": "ACTIVE"
    }
  ]
}
Back to Top