mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
1013fe10a3
* Fixed sorter/filter descriptions for several endpoints. Moved beta collection tags into alphabetic order. * Fixed the remaining sorter/filter linter errors * Removed default value from sorter params as they are not valid.' by github action: 6708027043
78 lines
2.2 KiB
YAML
78 lines
2.2 KiB
YAML
get:
|
|
operationId: listIdentityCertifications
|
|
tags:
|
|
- Certifications
|
|
summary: Identity Campaign Certifications by IDs
|
|
description: >-
|
|
This API returns a list of identity campaign certifications that satisfy the given 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.
|
|
parameters:
|
|
- in: query
|
|
name: reviewer-identity
|
|
schema:
|
|
type: string
|
|
example: me
|
|
description: >-
|
|
The ID of reviewer identity. *me* indicates the current user.
|
|
required: false
|
|
- $ref: '../parameters/limit.yaml'
|
|
- $ref: '../parameters/offset.yaml'
|
|
- $ref: '../parameters/count.yaml'
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: >-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
|
|
**id**: *eq, in*
|
|
|
|
|
|
**campaign.id**: *eq, in*
|
|
|
|
|
|
**phase**: *eq*
|
|
|
|
|
|
**completed**: *eq, ne*
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: name,due
|
|
description: >-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
|
|
Sorting is supported for the following fields: **name, due, signed**
|
|
responses:
|
|
'200':
|
|
description: List of identity campaign certifications
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/IdentityCertificationDto.yaml'
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|
|
|
|
|