Files
api-specs/idn/beta/paths/iai-configurations.yaml
GitHub Action Bot 1013fe10a3 Automated commit 'DEVREL-1270 (#1473)
* 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
2023-10-31 14:33:08 +00:00

78 lines
2.3 KiB
YAML

get:
operationId: listConfigurations
tags:
- IAI Configuration
summary: Lists all IAI Configurations for a customer
parameters:
- $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:
**attributes**: *co, sw*
description: >-
This gets the list of IAI configurations for a customer in context.
Requires authorization scope of iai:configuration:read
responses:
'200':
description: An list of IAI configurations for a customers.
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/IaiConfigurationDto.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
# security:
# - oauth2: [iai:configuration:read]
post:
operationId: createConfiguration
summary: Creates an IAI configuration for a customer
tags:
- IAI Configuration
description: >-
This submits a create IAI configuration request to the IdentityAI, where it will be saved for the customer in context. This
return a result with the configuration '../schemas/IaiConfigurationDto.yaml'
Requires authorization scope of 'iai:configuration:create'
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/IaiConfigurationDto.yaml'
responses:
'201':
description: Created. The IAI configuration for the customer
content:
application/json:
schema:
$ref: '../schemas/IaiConfigurationDto.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:
# - oauth2: [iai:configuration:create]