List Identity Campaign Certifications
GET {{baseUrl}}/certifications
Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
reviewer-identity | string | Reviewer's identity. me indicates the current user. | |
limit | number | Max number of results to return. | |
See V3 API Standard Collection Parameters for more information. | |||
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. | |
See V3 API Standard Collection Parameters for more information. | |||
count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. |
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| filters
| string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, in
campaign.id: eq, in
phase: eq
completed: eq, ne |
| sorters
| string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name, due, signed |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"2c9180835d2e5168015d32f890ca1581","name":"Source Owner Access Review for Employees [source]","campaign":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Campaign Name","type":"CAMPAIGN","campaignType":"MANAGER","description":"A description of the campaign","correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"},"completed":true,"identitiesCompleted":5,"identitiesTotal":10,"created":"2018-06-25T20:22:28.104Z","modified":"2018-06-25T20:22:28.104Z","decisionsMade":20,"decisionsTotal":40,"due":"2018-10-19T13:49:37.385Z","signed":"2018-10-19T13:49:37.385Z","reviewer":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Reviewer Name","email":"reviewer@test.com","type":"IDENTITY","created":"2018-06-25T20:22:28.104Z","modified":"2018-06-25T20:22:28.104Z"},"reassignment":{"from":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Certification Name","type":"CERTIFICATION","reviewer":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Reviewer Name","email":"reviewer@test.com","type":"IDENTITY","created":"2018-06-25T20:22:28.104Z","modified":"2018-06-25T20:22:28.104Z"}},"comment":"Reassigned for a reason"},"hasErrors":false,"errorMessage":"The certification has an error","phase":"ACTIVE"},{"id":"2c9180835d2e5168015d32f890ca1581","name":"Source Owner Access Review for Employees [source]","campaign":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Campaign Name","type":"CAMPAIGN","campaignType":"MANAGER","description":"A description of the campaign","correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"},"completed":true,"identitiesCompleted":5,"identitiesTotal":10,"created":"2018-06-25T20:22:28.104Z","modified":"2018-06-25T20:22:28.104Z","decisionsMade":20,"decisionsTotal":40,"due":"2018-10-19T13:49:37.385Z","signed":"2018-10-19T13:49:37.385Z","reviewer":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Reviewer Name","email":"reviewer@test.com","type":"IDENTITY","created":"2018-06-25T20:22:28.104Z","modified":"2018-06-25T20:22:28.104Z"},"reassignment":{"from":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Certification Name","type":"CERTIFICATION","reviewer":{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Reviewer Name","email":"reviewer@test.com","type":"IDENTITY","created":"2018-06-25T20:22:28.104Z","modified":"2018-06-25T20:22:28.104Z"}},"comment":"Reassigned for a reason"},"hasErrors":false,"errorMessage":"The certification has an error","phase":"ACTIVE"}]