Automated commit by github action: 9586587953

static/api-specs/idn/beta/paths/correlation-config.yaml

@@ -0,0 +1,85 @@
+get:
+  operationId: getCorrelationConfig
+  tags:
+    - Sources
+  summary: Get Source Correlation Configuration
+  security:
+    - UserContextAuth: [idn:sources:read]
+  description: >-
+    This API returns the existing correlation configuration for a source specified by the
+    given ID.
+
+    A token with ORG_ADMIN authority is required to call this API.
+  parameters:
+    - in: path
+      name: id
+      required: true
+      schema:
+        type: string
+      description: The source id
+      example: 2c9180835d191a86015d28455b4a2329
+  responses:
+    '200':
+      description: Correlation configuration for a source
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/CorrelationConfig.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'
+
+put:
+  operationId: putCorrelationConfig
+  tags:
+    - Sources
+  summary: Update Source Correlation Configuration
+  security:
+    - UserContextAuth: [idn:sources:update]
+  description: >-
+    Replaces the correlation configuration for the source specified by the given ID with the
+    configuration provided in the request body.
+        
+    A token with ORG_ADMIN authority is required to call this API.
+  parameters:
+    - in: path
+      name: id
+      required: true
+      schema:
+        type: string
+      description: The source id
+      example: 2c9180835d191a86015d28455b4a2329
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../schemas/CorrelationConfig.yaml'
+  responses:
+    '200':
+      description: Updated correlation configuration for a source
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/CorrelationConfig.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'

static/api-specs/idn/beta/schemas/CorrelationConfig.yaml

@@ -0,0 +1,54 @@
+type: object
+description: Source configuration information that is used by correlation process.
+properties:
+  id:
+    type: string
+    description: The ID of the correlation configuration.
+    example: 2c9180835d191a86015d28455b4a2329
+  name:
+    type: string
+    description: The name of the correlation configuration.
+    example: Source [source] Account Correlation
+  attributeAssignments:
+    type: array
+    description: The list of attribute assignments of the correlation configuration.
+    items:
+      type: object
+      description: The attribute assignment of the correlation configuration.
+      properties:
+        property:
+          type: string
+          description: The property of the attribute assignment.
+          example: first_name
+        value:
+          type: string
+          description: The value of the attribute assignment.
+          example: firstName
+        operation:
+          type: string
+          description: The operation of the attribute assignment.
+          enum:
+            - EQ
+          example: EQ
+        complex:
+          type: boolean
+          description: Whether or not the it's a complex attribute assignment.
+          default: false
+          example: false
+        ignoreCase:
+          type: boolean
+          description: Whether or not the attribute assignment should ignore case.
+          default: false
+          example: false
+        matchMode:
+          type: string
+          description: The match mode of the attribute assignment.
+          enum:
+            - ANYWHERE
+            - START
+            - END
+          example: ANYWHERE
+        filterString:
+          type: string
+          description: The filter string of the attribute assignment.
+          example: first_name == "John"

static/api-specs/idn/sailpoint-api.beta.yaml

@@ -1657,6 +1657,8 @@ paths:
     $ref: './beta/paths/load-accounts.yaml'
   /sources/{id}/load-uncorrelated-accounts:
     $ref: './beta/paths/load-uncorrelated-accounts.yaml'
+  /sources/{id}/correlation-config:
+    $ref: './beta/paths/correlation-config.yaml'
   /task-status/{id}:
     $ref: "./beta/paths/task-status.yaml"
   /task-status: