Jump to

• Request
• Response
• Examples

Updates policy violations.

put

/iam/governance/selfservice/api/v1/policyviolations

Updates the pending violations attributes for one or more policy violations.

Request

Supported Media Types

• application/json

Body ()

.

Root Schema : PolicyViolationsPUT

Type: object

Show Source

• policyviolations(optional): array policyviolations

{
    "properties":{
        "policyviolations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyViolationPUTRequest"
            }
        }
    }
}

Nested Schema : policyviolations

Type: array

Show Source

• Array of: object PolicyViolationPUTRequest

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

Nested Schema : PolicyViolationPUTRequest

Type: object

Show Source

• action(optional): string
• assignees(optional): array assignees
• comment(optional): string
• id(optional): string
• remediator(optional): string
• requestId(optional): string
• taskId(optional): string
• type(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Assignee"
            }
        },
        "comment":{
            "type":"string"
        },
        "remediator":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : assignees

Type: array

Show Source

• Array of: object Assignee

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

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

Type: object

Show Source

• violations(optional): array violations

{
    "properties":{
        "violations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyViolationPUTSingleResponse"
            }
        }
    }
}

Nested Schema : violations

Type: array

Show Source

• Array of: object PolicyViolationPUTSingleResponse

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

Nested Schema : PolicyViolationPUTSingleResponse

Type: object

Show Source

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

{
    "properties":{
        "requestId":{
            "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

The following example demonstrates the ability to update policy violations. The information shown here is against a pseudo system and serves as a prototype..

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

Example of PUT Request Body

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

{
    "policyviolations": [
         {
          "requestId": "Req1231",
          "id": "1E5EE9C898EE47FB890669DAB38758A2",
          "taskId": "d6d86b88-a2ce-42f6-ae18-6810ed6033cc",
          "action": "Suspend",
          "comment" : "temporary suspend"
       }
     ]
}

Example of PUT 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/"
        }
    ],
    "violations": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/1E5EE9C8
98EE47FB890669DAB38758A2"
                }
            ],
            "requestId": "Req1231",
            "taskId": "d6d86b88-a2ce-42f6-ae18-6810ed6033cc",
            "status": "SUCCESS"
        }
    ]
}

Back to Top