Files
developer.sailpoint.com/static/api-specs/idn/v3/paths/identity-certifications-access-summaries.yaml
2022-10-13 20:19:10 +00:00

111 lines
3.3 KiB
YAML

get:
operationId: getIdentityAccessSummaries
tags:
- Certification Summaries
summary: Access Summaries
description: >-
This API returns a list of access summaries for the specified identity campaign 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 identity campaign certification ID
example: ef38f94347e94562b5bb8424a56397d8
- in: path
name: type
schema:
type: string
enum:
- ROLE
- ACCESS_PROFILE
- ENTITLEMENT
required: true
description: The type of access review item to retrieve summaries for
example: ACCESS_PROFILE
- $ref: '../parameters/limit.yaml'
- $ref: '../parameters/offset.yaml'
- $ref: '../parameters/count.yaml'
- in: query
name: filters
required: false
schema:
type: string
example: access.id eq "ef38f94347e94562b5bb8424a56397d8"
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)
Filtering is supported for the following fields and operators:
**completed**: *eq, ne*
**access.id**: *eq, in*
**access.name**: *eq, sw*
**entitlement.sourceName**: *eq, sw*
**accessProfile.sourceName**: *eq, sw*
- in: query
name: sorters
required: false
schema:
type: string
format: comma-separated
example: access.name
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: **access.name**
responses:
'200':
description: List of access summaries
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/AccessSummary.yaml'
example:
- access:
type: ENTITLEMENT
id: 2c9180857182305e01719937429e2bad
name: 'CN=Engineering'
entitlement:
id: 2c9180857182305e01719937429e2bad
name: 'CN=Engineering'
description: Access to the engineering database
privileged: false
owner:
email: brandon.gray@acme-solar.com
type: IDENTITY
id: 2c9180867160846801719932c5153fb7
name: Brandon Gray
attributeName: memberOf
attributeValue: 'CN=Engineering'
sourceName: ODS-AD-Source
hasPermissions: true
revocable: true
'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'