Jump to

• Request
• Response
• Examples

Update Pending Violation

put

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

Updates the pending violation policy attributes for the specified policy violation.

Request

Supported Media Types

• application/json

Path Parameters

• pvid: string
  Policy violation ID.

Body ()

.

Root Schema : PolicyViolationPUT

Type: object

Show Source

• action(optional): string
• assignees(optional): object Assignee
• comment(optional): string
• detectionCount(optional): string
• remediator(optional): string
• requestId(optional): string
• severity(optional): string
• status(optional): string
• targetRoleId(optional): string
• targetUserId(optional): string
• taskId(optional): string
• type(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "detectionCount":{
            "type":"string"
        },
        "targetRoleId":{
            "type":"string"
        },
        "targetUserId":{
            "type":"string"
        },
        "severity":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "remediator":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "assignees":{
            "$ref":"#/definitions/Assignee"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Assignee

Type: object

Show Source

• name(optional): string
• type(optional): string

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

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

Type: object

Show Source

• links(optional): array links
• requestId(optional): string
• status(optional): string
• taskId(optional): string

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

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

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example demonstrates the ability to update 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"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u 
username:password  -d @put.json 
https://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/1CBEF68E0BCC413D81ADA2EE1F
6CFC75

Example of PUT Request Body

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

{
    "requestId": "Req123",
    "taskId": "f394bc9a-9eab-4da4-88c3-86fcfbbf0e5d",
    "action": "Suspend",
    "comment" : "suspend for now"
}

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/1CBEF68E
0BCC413D81ADA2EE1F6CFC75"
        }
    ],
    "requestId": "Req123",
    "taskId": "f394bc9a-9eab-4da4-88c3-86fcfbbf0e5d",
    "status": "SUCCESS"
}

Back to Top