mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Automated commit by github action: 5392178207
This commit is contained in:
73
static/api-specs/idn/beta/paths/workgroups/Workgroups.yaml
Normal file
73
static/api-specs/idn/beta/paths/workgroups/Workgroups.yaml
Normal file
@@ -0,0 +1,73 @@
|
||||
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: 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 of Governance Groups
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "../../schemas/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:
|
||||
- oauth2: [ idn:workgroup:read, idn:workgroup:write ]
|
||||
post:
|
||||
operationId: createWorkgroup
|
||||
security:
|
||||
- oauth2: [ idn:workgroup:read, 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/WorkgroupDto.yaml"
|
||||
responses:
|
||||
'200':
|
||||
description: Governance Group object created.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "../../schemas/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'
|
||||
21
static/api-specs/idn/beta/schemas/Owner.yaml
Normal file
21
static/api-specs/idn/beta/schemas/Owner.yaml
Normal file
@@ -0,0 +1,21 @@
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
$ref: '../../v3/schemas/DtoType.yaml'
|
||||
description: DTO type
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
name:
|
||||
type: string
|
||||
description: Human-readable name of the owner
|
||||
example: William Wilson
|
||||
displayName:
|
||||
type: string
|
||||
description: Human-readable display name of the owner
|
||||
example: William
|
||||
emailAddress:
|
||||
type: string
|
||||
description: Email ID of the owner
|
||||
example: william@sailpoint.com
|
||||
23
static/api-specs/idn/beta/schemas/WorkgroupDto.yaml
Normal file
23
static/api-specs/idn/beta/schemas/WorkgroupDto.yaml
Normal file
@@ -0,0 +1,23 @@
|
||||
type: object
|
||||
properties:
|
||||
owner:
|
||||
$ref: './Owner.yaml'
|
||||
description: Owner of the Governance Group
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
description:
|
||||
type: string
|
||||
description: Description of the Governance Group
|
||||
example: Description of the Governance Group
|
||||
memberCount:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 1641498673000
|
||||
description: Number of members in the Governance Group.
|
||||
connectionCount:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 1641498673000
|
||||
description: Number of connections in the Governance Group.
|
||||
@@ -799,7 +799,13 @@ tags:
|
||||
description: |
|
||||
Workflows allow administrators to create custom automation scripts directly within IdentityNow. These automation scripts respond to [event triggers](https://developer.sailpoint.com/idn/docs/event-triggers#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the IdentityNow UI. Workflows can be configured via a graphical user interface within IdentityNow, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST.
|
||||
|
||||
Refer to [Creating and Managing Workflows](https://documentation.sailpoint.com/saas/help/workflows/workflow-basics.html) for more information about how to build workflows in the visual builder in the IdentityNow UI.
|
||||
- name: Governance Groups
|
||||
description: |
|
||||
Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout IdentityNow.
|
||||
|
||||
A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user.
|
||||
|
||||
Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the IdentityNow UI.
|
||||
- name: Event Trigger Models
|
||||
x-displayName: Trigger Models
|
||||
description: |
|
||||
@@ -1630,3 +1636,5 @@ paths:
|
||||
$ref: './beta/paths/workflow-external-execute.yaml'
|
||||
/workflows/execute/external/{id}/test:
|
||||
$ref: './beta/paths/workflow-external-execute-test.yaml'
|
||||
/workgroups:
|
||||
$ref: './beta/paths/workgroups/Workgroups.yaml'
|
||||
|
||||
Reference in New Issue
Block a user