mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 04:19:31 +00:00
89 lines
2.6 KiB
YAML
89 lines
2.6 KiB
YAML
get:
|
|
operationId: getAccessRequestRecommendations
|
|
tags:
|
|
- IAI Access Request Recommendations
|
|
summary: Identity Access Request Recommendations
|
|
description: >-
|
|
This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
|
|
parameters:
|
|
- in: query
|
|
name: identity-id
|
|
description: >-
|
|
Get access request recommendations for an identityId. *me* indicates the current user.
|
|
schema:
|
|
type: string
|
|
default: me
|
|
required: false
|
|
example: 2c91808570313110017040b06f344ec9
|
|
- in: query
|
|
name: limit
|
|
description: >-
|
|
Max number of results to return.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
minimum: 0
|
|
maximum: 15
|
|
default: 15
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
- in: query
|
|
name: include-translation-messages
|
|
description: >-
|
|
If *true* it will populate a list of translation messages in the response.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
required: false
|
|
example: false
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: >-
|
|
Filter recommendations 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:
|
|
|
|
|
|
**access.name**: *co*
|
|
|
|
|
|
**access.type**: *eq, in*
|
|
|
|
|
|
**access.description**: *co*
|
|
- 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: **access.name, access.type**
|
|
|
|
|
|
By default the recommendations are sorted by highest confidence first.
|
|
responses:
|
|
'200':
|
|
description: List of access request recommendations for the identityId
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../../beta/schemas/AccessRequestRecommendationItemDetail.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'
|