mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
107 lines
3.2 KiB
YAML
107 lines
3.2 KiB
YAML
get:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: List existing Service Desk Integrations
|
|
description: Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
operationId: getServiceDeskIntegrationList
|
|
parameters:
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/limit.yaml'
|
|
- name: sorters
|
|
in: query
|
|
required: false
|
|
style: form
|
|
explode: true
|
|
schema:
|
|
type: string
|
|
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**
|
|
example: name
|
|
- name: filters
|
|
in: query
|
|
required: false
|
|
style: form
|
|
explode: true
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
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*
|
|
|
|
|
|
**type**: *eq, in*
|
|
|
|
|
|
**cluster**: *eq, in*
|
|
example: id eq 2c91808b6ef1d43e016efba0ce470904
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
responses:
|
|
"200":
|
|
description: List of ServiceDeskIntegrationDto
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/ServiceDeskIntegrationDto.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:service-desk-admin:read,idn:service-desk-integration:read]
|
|
post:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Create new Service Desk integration
|
|
description: Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
operationId: createServiceDeskIntegration
|
|
requestBody:
|
|
description: The specifics of a new integration to create
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/ServiceDeskIntegrationDto.yaml'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: details of the created integration
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/ServiceDeskIntegrationDto.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:service-desk-admin:manage,idn:service-desk-integration:manage]
|