Files
api-specs/idn/beta/paths/workgroups/connections.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

50 lines
1.6 KiB
YAML

get:
operationId: listConnections
tags:
- Governance Groups
summary: List connections for Governance Group
description: This API returns list of connections associated with a Governance Group.
parameters:
- name: workgroupId
in: path
description: ID of the Governance Group.
required: true
schema:
type: string
example: 2c91808a7813090a017814121919ecca
- $ref: '../../../v3/parameters/offset.yaml'
- $ref: '../../../v3/parameters/limit50.yaml'
- $ref: '../../../v3/parameters/count.yaml'
- 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, created, modified**
example: name,-modified
required: false
responses:
'200':
description: List all connections associated with a Governance Group.
content:
application/json:
schema:
type: array
items:
$ref: "../../schemas/workgroups/WorkgroupConnectionDto.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:workgroup:read]