mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 12:27:48 +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
95 lines
2.6 KiB
YAML
95 lines
2.6 KiB
YAML
get:
|
|
operationId: getAccessProfileEntitlements
|
|
tags:
|
|
- Access Profiles
|
|
summary: List Access Profile's Entitlements
|
|
description: >-
|
|
This API lists the Entitlements associated with a given Access Profile
|
|
|
|
|
|
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In
|
|
addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given
|
|
Access Profile
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the containing Access Profile
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: 2c91808a7813090a017814121919ecca
|
|
- $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*
|
|
|
|
|
|
**name**: *eq, sw*
|
|
|
|
|
|
**attribute**: *eq, sw*
|
|
|
|
|
|
**value**: *eq, sw*
|
|
|
|
|
|
**created**: *gt, lt, ge, le*
|
|
|
|
|
|
**modified**: *gt, lt, ge, le*
|
|
|
|
|
|
**owner.id**: *eq, in*
|
|
|
|
|
|
**source.id**: *eq, in*
|
|
example: attribute eq "memberOf"
|
|
required: false
|
|
- 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, attribute, value, created, modified**
|
|
example: name,-modified
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of Entitlements
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/Entitlement.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'
|
|
security:
|
|
- UserContextAuth: [idn:access-profile:read, idn:access-profile:manage]
|
|
|
|
|
|
|