Jump to

• Request
• Response
• Examples

Get Policy Violations task details

get

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

Returns the specified cause details. 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.

Request

Supported Media Types

• application/json

Path Parameters

• causeid: string
  Policy violation's cause ID
• 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"

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 : PolicyViolationTaskDetailsGet

Type: object

Show Source

• count(optional): integer
• fields(optional): array fields
• hasMore(optional): boolean
• id(optional): string
• links(optional): array links
• status(optional): string
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "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 : 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"
        }
    }
}

401 Response

Unauthorized

404 Response

Entity Not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example provides the details of a given cause for a given 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/6C9E394C863A4F459B27EC8DDA1AFEB0/causes/5B86B278C32B45EBBD911EF93B24E399

Example of GET Response Body

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

{
  "link": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/6C9E394C863A4F459B27EC8DDA1AFEB0/causes/5B86B278C32B45EBBD911EF93B24E399"
    }
  ],
  "id": "5B86B278C32B45EBBD911EF93B24E399",
  "status": "ACTIVE",
  "fields": [
    {
      "name": "update",
      "value": 1460356450695
    },
    {
      "name": "status",
      "value": "ACTIVE"
    },
    {
      "name": "ruleCondition",
      "value": {
        "secondArgument": "yahoo.com",
        "substituteArg2": false,
        "searchDepth": null,
        "searchBase": null,
        "firstArgument": "user.Email",
        "operator": "CONTAINS"
      }
    },
    {
      "name": "createById",
      "value": "4"
    },
    {
      "name": "create",
      "value": 1459252606115
    },
    {
      "name": "updateById",
      "value": "4"
    },
    {
      "name": "ruleName",
      "value": "YahooRestrictionPolicy"
    },
    {
      "name": "ruleId",
      "value": "E8AEF16F84F049169EA62E805430E4B1"
    },
    {
      "name": "name",
      "value": "864B5DB44BFE4437B3DC39F71ABF6CDF"
    },
    {
      "name": "action",
      "value": "ACTIVATE"
    },
    {
      "name": "policyViolationId",
      "value": "6C9E394C863A4F459B27EC8DDA1AFEB0"
    }
  ]
}

Back to Top