Files
developer.sailpoint.com/static/api-specs/idn/beta/paths/certifications-access-summaries.yaml
2022-09-28 19:55:44 +00:00

82 lines
2.3 KiB
YAML

get:
operationId: getAccessSummaries
tags:
- Certification Summaries
summary: Access Summaries
description: >-
This API returns a list of access summaries for the specified certification and type. A token with ORG_ADMIN or
CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
parameters:
- in: path
name: id
schema:
type: string
required: true
description: The certification ID
example: ef38f94347e94562b5bb8424a56397d8
- in: path
name: type
schema:
$ref: '../../beta/schemas/CertificationItemType.yaml'
required: true
description: The type of review item to retrieve summaries for
example: ACCESS_PROFILE
- $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:
**completed**: *eq, ne*
**entity.id**: *eq, in*
**entity.name**: *eq, sw*
**entitlement.sourceName**: *eq, sw*
**accessProfile.sourceName**: *eq, sw*
- 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: **entity.name**
responses:
'200':
description: List of access summaries
content:
application/json:
schema:
type: array
items:
$ref: '../../beta/schemas/ReviewData.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'