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

• Array of: object Fields

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

Nested Schema : links

Type: array

Show Source

• Array of: 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/D15E3910F42A4626AA8CBA219A
58A478/causes/7DBE8AB5D3D1493CB6022351E37A8492

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:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes/7DBE8AB5D3D1493CB6022351E37A8492"
        }
    ],
    "id": "7DBE8AB5D3D1493CB6022351E37A8492",
    "status": "ACTIVE",
    "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": "ruleId",
            "value": "AB4F6F3D8A7D428EA054B11D96EC726D"
        },
        {
            "name": "status",
            "value": "ACTIVE"
        }
    ]
}

Back to Top