Jump to

• Request
• Response
• Examples

Updates policy violation task.

put

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

Updates the policy violation task by either assigning to another user or taking an action on the task.

Request

Supported Media Types

• application/json

Path Parameters

• pvid: string
  Policy violation ID

Body ()

.

Root Schema : PolicyViolationTasksPUT

Type: object

Show Source

• policyviolationcause(optional): array policyviolationcause

{
    "properties":{
        "policyviolationcause":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyViolationTaskPUT"
            }
        }
    }
}

Nested Schema : policyviolationcause

Type: array

Show Source

• [0]: object PolicyViolationTaskPUT

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

Nested Schema : PolicyViolationTaskPUT

Type: object

Show Source

• action(optional): string
• causeId(optional): string
• comment(optional): string
• requestId(optional): string
• riskAcceptedExpirationDate (optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "causeId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "riskAcceptedExpirationDate ":{
            "type":"string"
        },
        "comment":{
            "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 : PolicyViolationTasksPUTResponse

Type: object

Show Source

• policyviolationcause(optional): array policyviolationcause

{
    "properties":{
        "policyviolationcause":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyViolationTaskSinglePUTResponse"
            }
        }
    }
}

Nested Schema : policyviolationcause

Type: array

Show Source

• [0]: object PolicyViolationTaskSinglePUTResponse

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

Nested Schema : PolicyViolationTaskSinglePUTResponse

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Show Source

• [0]: 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

403 Response

Forbidden

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 policy violations causes for a given policy violation task in a single request. This particularly shows a failure response if the policy is completed or not available. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/6F5592D7A5CE42CDB8A38996180A7D18/causes

Example of PUT Request Body

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

{
  "policyviolationcause": [
    {
      "requestId": "gyjgh",
      "causeId": "287874BB86344E3DA243FC84029D76AF",
      "action": "ACCEPT_RISK",
      "comment": "CommentABC",
      "riskAcceptedExpirationDate": "11-May-16"
    }
  ]
}

Example of PUT Response Body

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

{
  "policyviolationsresponse": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/5D4D3C107D7745A8BC21F6DB9888959D/causes"
        }
      ],
      "requestId": "gyjgh",
      "status": " FAIL",
      "reason": "IAM-8110005 : The specified risk-accepted expiration date 5/11/16 is invalid. The date must be in the future and no later than 6/30/16."
    }
  ]
}

Back to Top