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
128 lines
3.8 KiB
YAML
128 lines
3.8 KiB
YAML
get:
|
|
operationId: listIdentityAccessReviewItems
|
|
tags:
|
|
- Certifications
|
|
summary: List of Access Review Items
|
|
description: >-
|
|
This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or
|
|
CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API
|
|
does not support requests for certifications assigned to Governance Groups.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- $ref: '../parameters/limit.yaml'
|
|
- $ref: '../parameters/offset.yaml'
|
|
- $ref: '../parameters/count.yaml'
|
|
- in: query
|
|
required: false
|
|
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*
|
|
|
|
|
|
**type**: *eq*
|
|
|
|
|
|
**access.type**: *eq*
|
|
|
|
|
|
**completed**: *eq, ne*
|
|
|
|
|
|
**identitySummary.id**: *eq, in*
|
|
|
|
|
|
**identitySummary.name**: *eq, sw*
|
|
|
|
|
|
**access.id**: *eq, in*
|
|
|
|
|
|
**access.name**: *eq, sw*
|
|
|
|
|
|
**entitlement.sourceName**: *eq, sw*
|
|
|
|
|
|
**accessProfile.sourceName**: *eq, sw*
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: access.name,-accessProfile.sourceName
|
|
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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**
|
|
- in: query
|
|
name: entitlements
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: identityEntitlement
|
|
description:
|
|
Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs.
|
|
|
|
|
|
An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time.
|
|
- in: query
|
|
name: access-profiles
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: accessProfile1
|
|
description:
|
|
Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs.
|
|
|
|
|
|
An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time.
|
|
- in: query
|
|
name: roles
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: userRole
|
|
description:
|
|
Filter results to view access review items that pertain to any of the specified comma-separated role IDs.
|
|
|
|
|
|
An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time.
|
|
responses:
|
|
'200':
|
|
description: A list of access review items
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/AccessReviewItem.yaml'
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'404':
|
|
$ref: '../responses/404.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|