Automated commit 'Merge pull request #1651 from sailpoint/PLTFORMS-3151

PLTFORMS-3151 Add Launcher' by github action: 11298384933
sailpoint-oss · Oct 11, 2024 · e8bc30a · e8bc30a
1 parent cb86201
commit e8bc30a
Show file tree

Hide file tree

Showing 6 changed files with 414 additions and 8 deletions.
diff --git a/idn/beta/paths/launcher-launch.yaml b/idn/beta/paths/launcher-launch.yaml
@@ -0,0 +1,45 @@
+post:
+  tags:
+    - Launchers
+  summary: Launch a Launcher
+  description: Launch the given Launcher ID
+  operationId: startLauncher
+  parameters:
+    - name: launcherID
+      in: path
+      description: ID of the Launcher to be launched
+      required: true
+      schema:
+        type: string
+        format: uuid
+      example: e3012408-8b61-4564-ad41-c5ec131c325b
+  responses:
+    '200':
+      description: Launcher launched successfully
+      content:
+        application/json:
+          schema:
+            type: object
+            required:
+              - interactiveProcessId
+            properties:
+              interactiveProcessId:
+                type: string
+                description: ID of the Interactive Process that was launched
+                example: 5da68cfe-2d60-4b09-858f-0d03acd2f47a
+    '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:
+    - userAuth: [ sp:launcher-user:launch ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
diff --git a/idn/beta/paths/launcher.yaml b/idn/beta/paths/launcher.yaml
@@ -0,0 +1,113 @@
+get:
+  tags:
+    - Launchers
+  summary: Get Launcher by ID
+  description: Get details for the given Launcher ID
+  operationId: getLauncher
+  parameters:
+    - name: launcherID
+      in: path
+      description: ID of the Launcher to be retrieved
+      required: true
+      schema:
+        type: string
+        format: uuid
+      example: "e3012408-8b61-4564-ad41-c5ec131c325b"
+  responses:
+    '200':
+      description: Launcher retrieved successfully
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/Launcher.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:
+    - userAuth: [ sp:launcher-admin:read, sp:launcher-user:read ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+put:
+  summary: Replace Launcher
+  description: Replace the given Launcher ID with given payload
+  operationId: putLauncher
+  parameters:
+    - name: launcherID
+      in: path
+      description: ID of the Launcher to be replaced
+      required: true
+      schema:
+        type: string
+        format: uuid
+      example: "e3012408-8b61-4564-ad41-c5ec131c325b"
+  requestBody:
+    description: Payload to replace Launcher
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../schemas/LauncherRequest.yaml'
+  responses:
+    '200':
+      description: Launcher replaced successfully
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/Launcher.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:
+    - userAuth: [ sp:launcher-admin:write ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+delete:
+  summary: Delete Launcher
+  description: Delete the given Launcher ID
+  operationId: deleteLauncher
+  parameters:
+    - name: launcherID
+      in: path
+      description: ID of the Launcher to be deleted
+      required: true
+      schema:
+        type: string
+        format: uuid
+      example: "e3012408-8b61-4564-ad41-c5ec131c325b"
+  responses:
+    '204':
+      description: Launcher deleted successfully
+    '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:
+    - userAuth: [ sp:launcher-admin:delete ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
diff --git a/idn/beta/paths/launchers.yaml b/idn/beta/paths/launchers.yaml
@@ -0,0 +1,110 @@
+get:
+  tags:
+    - Launchers
+  summary: List all Launchers for tenant
+  description: Return a list of Launchers for the authenticated tenant
+  operationId: getLaunchers
+  parameters:
+    - name: filters
+      in: query
+      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:
+
+
+        **description**: *sw*
+
+
+        **disabled**: *eq*
+
+
+        **name**: *sw*
+      example: disabled eq "true"
+      required: false
+      schema:
+        type: string
+    - name: next
+      in: query
+      description: Pagination marker
+      required: false
+      schema:
+        type: string
+      example: eyJuZXh0IjoxMjN9Cg==
+    - name: limit
+      in: query
+      description: Number of Launchers to return
+      required: false
+      schema:
+        type: integer
+        format: int32
+        minimum: 1
+        maximum: 100
+        default: 10
+      example: 42
+  responses:
+    '200':
+      description: List of Launchers
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              next:
+                type: string
+                description: Pagination marker
+              items:
+                type: array
+                items:
+                  $ref: "../schemas/Launcher.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:
+    - userAuth: [ sp:launcher-admin:read, sp:launcher-user:read ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+post:
+  summary: Create launcher
+  description: Create a Launcher with given information
+  operationId: createLauncher
+  requestBody:
+    description: Payload to create a Launcher
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "../schemas/LauncherRequest.yaml"
+  responses:
+    '201':
+      description: Launcher created successfully
+      content:
+        application/json:
+          schema:
+            $ref: "../schemas/Launcher.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:
+    - userAuth: [ sp:launcher-admin:write ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
diff --git a/idn/beta/schemas/Launcher.yaml b/idn/beta/schemas/Launcher.yaml
@@ -0,0 +1,79 @@
+type: object
+required:
+  - id
+  - created
+  - modified
+  - owner
+  - name
+  - description
+  - disabled
+  - type
+  - config
+properties:
+  id:
+    type: string
+    description: ID of the Launcher
+    example: 1b630bed-0941-4792-a712-57a5868ca34d
+    format: uuid
+  created:
+    type: string
+    description: Date the Launcher was created
+    example: 2024-04-16T20:07:30.601016489Z
+    format: date-time
+  modified:
+    type: string
+    description: Date the Launcher was last modified
+    example: 2024-04-17T18:02:07.320143194Z
+    format: date-time
+  owner:
+    type: object
+    description: Owner of the Launcher
+    required:
+      - type
+      - id
+    properties:
+      type:
+        type: string
+        description: Owner type
+        example: IDENTITY
+      id:
+        type: string
+        description: Owner ID
+        example: 123180847373330f0173c7e1756b6890
+  name:
+    type: string
+    description: Name of the Launcher, limited to 255 characters
+    example: Group Create
+  description:
+    type: string
+    description: Description of the Launcher, limited to 2000 characters
+    example: Create a new Active Directory Group
+  type:
+    type: string
+    description: Launcher type
+    example: INTERACTIVE_PROCESS
+    enum:
+      - INTERACTIVE_PROCESS
+  disabled:
+    type: boolean
+    description: State of the Launcher
+    example: false
+  reference:
+    type: object
+    properties:
+      type:
+        type: string
+        description: Type of Launcher reference
+        example: WORKFLOW
+        enum:
+          - WORKFLOW
+      id:
+        type: string
+        description: ID of Launcher reference
+        example: 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
+  config:
+    type: string
+    description: |
+      JSON configuration associated with this Launcher, restricted to a max size of 4KB
+    example: '{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}'
+    pattern: '^\{\}$'
diff --git a/idn/beta/schemas/LauncherRequest.yaml b/idn/beta/schemas/LauncherRequest.yaml
@@ -0,0 +1,48 @@
+type: object
+required:
+  - name
+  - description
+  - type
+  - disabled
+  - config
+properties:
+  name:
+    type: string
+    description: Name of the Launcher, limited to 255 characters
+    example: Group Create
+  description:
+    type: string
+    description: Description of the Launcher, limited to 2000 characters
+    example: Create a new Active Directory Group
+  type:
+    type: string
+    description: Launcher type
+    example: INTERACTIVE_PROCESS
+    enum:
+      - INTERACTIVE_PROCESS
+  disabled:
+    type: boolean
+    description: State of the Launcher
+    example: false
+  reference:
+    type: object
+    required:
+      - id
+      - type
+    properties:
+      type:
+        type: string
+        description: Type of Launcher reference
+        example: WORKFLOW
+        enum:
+          - WORKFLOW
+      id:
+        type: string
+        description: ID of Launcher reference
+        example: 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
+  config:
+    type: string
+    description: |
+      JSON configuration associated with this Launcher, restricted to a max size of 4KB
+    example: '{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}'
+    pattern: '^\{\}$'