mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
72 lines
2.0 KiB
YAML
72 lines
2.0 KiB
YAML
get:
|
|
operationId: listCertifications
|
|
tags:
|
|
- Certifications
|
|
summary: Certifications by IDs
|
|
description: >-
|
|
This API returns a list of 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.
|
|
parameters:
|
|
- in: query
|
|
name: reviewer-identitiy
|
|
schema:
|
|
type: string
|
|
description: The ID of reviewer identity. *me* indicates the current user.
|
|
required: false
|
|
- $ref: '../../v3/parameters/limit.yaml'
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
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*
|
|
|
|
|
|
**phase**: *eq*
|
|
|
|
|
|
**completed**: *eq, ne*
|
|
|
|
|
|
**campaignRef.campaignType**: *eq, in*
|
|
|
|
|
|
**campaignRef.id**: *eq, in*
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
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 certifications
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../../beta/schemas/CertificationDto.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|