mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
91 lines
2.6 KiB
YAML
91 lines
2.6 KiB
YAML
get:
|
|
operationId: listWorkgroups
|
|
tags:
|
|
- Governance Groups
|
|
summary: List Governance Groups
|
|
description: This API returns list of Governance Groups
|
|
parameters:
|
|
- $ref: '../../../v3/parameters/offset.yaml'
|
|
- $ref: '../../../v3/parameters/limit50.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, sw*
|
|
|
|
|
|
**name**: *eq, sw, in*
|
|
example: name sw "Test"
|
|
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, created, modified, id, description**
|
|
example: name,-modified
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of Governance Groups
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "../../schemas/workgroups/WorkgroupDto.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]
|
|
post:
|
|
operationId: createWorkgroup
|
|
security:
|
|
- UserContextAuth: [ idn:workgroup:write ]
|
|
tags:
|
|
- Governance Groups
|
|
summary: Create a new Governance Group.
|
|
description: This API creates a new Governance Group.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../../schemas/workgroups/WorkgroupDto.yaml"
|
|
responses:
|
|
'200':
|
|
description: Governance Group object created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../../schemas/workgroups/WorkgroupDto.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' |