Jump to

• Request
• Response

Get Pending Violations

get

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

Returns all the pending violations.

Request

Supported Media Types

• application/json

Query Parameters

• fields(optional): string
  Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "policyId,update,createById,updateById,id,policyId,targetUserId,name,action,policyDescription,status,severity,create,policyName,targetUserDisplayName,detectionCount". Nested entities cannot be filtered for example the "targetRole, remediatorRole" etc cannot be the attributes which can be returned.

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

Type: object

Show Source

• count(optional): integer
• hasMore(optional): boolean
• policyviolations(optional): array policyviolations
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "policyviolations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyViolationSingleGET"
            }
        }
    }
}

Nested Schema : policyviolations

Type: array

Show Source

• Array of: object PolicyViolationSingleGET

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

Nested Schema : PolicyViolationSingleGET

Type: object

Show Source

• fields(optional): array fields
• id(optional): string
• links(optional): array links
• remediatorUser(optional): object IDAUserInfo

{
    "properties":{
        "id":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "remediatorUser":{
            "$ref":"#/definitions/IDAUserInfo"
        },
        "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 : IDAUserInfo

Type: object

Show Source

• displayName(optional): string
• links(optional): array links

{
    "properties":{
        "displayName":{
            "type":"string"
        },
        "links":{
            "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"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top