Saviynt Analytics API

openapi: 3.1.0
info:
  title: Saviynt Enterprise Identity Cloud (EIC) Analytics API
  version: '5.0'
servers:
- url: https://example.saviyntcloud.com/ECM/api/v5
tags:
- name: Analytics
paths:
  /fetchControlList:
    post:
      summary: Fetch List of Analytics
      operationId: fetchControlList
      tags:
      - Analytics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchControlListResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchControlListRequest'
      description: ''
  /fetchControlDetails:
    post:
      summary: Fetch Analytics Details
      operationId: fetchControlDetails
      tags:
      - Analytics
      responses:
        '200':
          description: OK
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FetchControlDetailsRequest'
      description: This web service API is used to fetch the details of analytics controls.
  /runAnalyticsControls:
    post:
      summary: Run Analytics Controls
      operationId: runAnalyticsControls
      tags:
      - Analytics
      responses:
        '200':
          description: OK
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RunAnalyticsControlsRequest'
  /fetchRuntimeControlsData:
    post:
      summary: Fetch Runtime Controls Data
      operationId: fetchRuntimeControlsData
      tags:
      - Analytics
      responses:
        '200':
          description: OK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRuntimeControlsDataRequest'
  /fetchRuntimeControlsDataV2:
    post:
      summary: Fetch Runtime Controls Data V2
      operationId: fetchRuntimeControlsDataV2
      tags:
      - Analytics
      responses:
        '200':
          description: OK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRuntimeControlsDataV2Request'
        description: ''
  /fetchControlAttributes:
    post:
      summary: Fetch Control Attributes
      operationId: fetchControlAttributes
      tags:
      - Analytics
      responses:
        '200':
          description: OK
      description: This API is used for fetching the details of dynamic attributes associated with an analytics control. This can be used for both Elasticsearch and Database analytics.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchControlAttributesRequest'
  /fetchControlListES:
    post:
      summary: Fetch List of Analytics ES
      tags:
      - Analytics
      responses: {}
      operationId: fetchControlListES
      description: 'This method fetches a list of Analytic Controls in Elastic.


        Note: Security is based on owner, delegate, `ROLE_ADMIN`, SAV_ROLE''s analytics ES category.'
  /fetchControlDetailsES:
    post:
      summary: Fetch Analytics Details ES
      tags:
      - Analytics
      responses: {}
      operationId: fetchControlDetailsES
      description: This web service API is used to fetch the details of analytics controls ES, includes the Offset value in the response.
components:
  schemas:
    FetchRuntimeControlsDataV2Request:
      title: FetchRuntimeControlsDataV2
      x-stoplight:
        id: y72ldde5mw2fm
      type: object
      properties:
        requestor:
          type: string
          x-stoplight:
            id: 8lwakmt6icwf0
        analyticsname:
          type: string
          x-stoplight:
            id: bcoap517ja2dr
        analyticsid:
          type: string
          x-stoplight:
            id: oamryaepvpj6y
        attributes:
          type: object
          x-stoplight:
            id: qh4y4bhhckmjs
        max:
          type: string
          x-stoplight:
            id: x1fpaihq38wtb
        offset:
          type: string
          x-stoplight:
            id: lcbkfr9j2lz5b
    FetchControlListControl:
      title: FetchControlListControl
      x-stoplight:
        id: wxutwinsvzwaf
      type: object
      properties:
        analyticsId:
          type: integer
          x-stoplight:
            id: 5rjbguo1klhuk
        application:
          type: string
          x-stoplight:
            id: rp5qq6id2qoo0
        analyticsName:
          type: string
          x-stoplight:
            id: lo70rd8867eu2
        controlid:
          type: string
          x-stoplight:
            id: 3ktb3qmfwcoa6
        category:
          type: string
          x-stoplight:
            id: t21cmpzznft8j
        description:
          type: string
          x-stoplight:
            id: zxc4f5ii3j9hx
        lastRun:
          type: string
          x-stoplight:
            id: k0f5pe0k11i3t
        Risk:
          type: string
          x-stoplight:
            id: jfu3ehuhksfgu
        recommendations:
          type: string
          x-stoplight:
            id: pa52dmzf12ahy
        conflictCount:
          type: integer
          x-stoplight:
            id: i1zgqqs00de3d
      examples:
      - analyticsId: 0
        application: string
        analyticsName: string
        controlid: string
        category: string
        description: string
        lastRun: string
        Risk: string
        recommendations: string
        conflictCount: 0
    FetchControlAttributesRequest:
      title: FetchControlAttributesRequest
      x-stoplight:
        id: iasaxhi5b6ra5
      type: object
      properties:
        analyticstype:
          type: string
          x-stoplight:
            id: c25fj8an0lke0
          enum:
          - ES
          - DB
        analyticsname:
          type: string
          x-stoplight:
            id: c25fj8an0lke0
        id:
          type: string
          x-stoplight:
            id: ccnguyxlr43nw
        offset:
          type: string
          x-stoplight:
            id: j1hx738kzy1wi
        max:
          type: string
          x-stoplight:
            id: t60xlmb2ol31w
      required:
      - analyticstype
    FetchRuntimeControlsDataRequest:
      title: FetchRuntimeControlsDataRequest
      x-stoplight:
        id: 5h540av4auguz
      type: object
      properties:
        analyticsid:
          type: string
          x-stoplight:
            id: 6ek1ln8a242yd
        analyticsname:
          type: string
          x-stoplight:
            id: mlzv7ri3mtb21
        attributes:
          type: object
          x-stoplight:
            id: 4h6byvz7roccx
        max:
          type: string
          x-stoplight:
            id: 2nyv0eifbq4vv
        offset:
          type: string
          x-stoplight:
            id: ivw7lngvlka5q
        loggedinuser:
          type: string
          x-stoplight:
            id: cz04q6509vxtx
    FetchControlDetailsRequest:
      title: FetchControlDetails
      x-stoplight:
        id: 6ns86hzu7sdd8
      type: object
      properties:
        controlId:
          type: string
          x-stoplight:
            id: 3v79rbtw8qy9d
        max:
          type: string
          x-stoplight:
            id: de4luh6fct1in
        offset:
          type: string
          x-stoplight:
            id: 64sybht5vrikh
      required:
      - controlId
    FetchControlListRequest:
      title: FetchControlListRequest
      x-stoplight:
        id: j1hfpwqxneu11
      type: object
      properties:
        application:
          type: string
          x-stoplight:
            id: x5lnjaqwxhaas
        category:
          type: string
          x-stoplight:
            id: bui0yfkd4lwoy
        max:
          type: string
          x-stoplight:
            id: 8s25cgick27fu
        offset:
          type: string
          x-stoplight:
            id: h433q0x239tr5
    FetchControlListResponse:
      title: FetchControlListResponse
      x-stoplight:
        id: af3dfar44m893
      type: object
      examples:
      - msg: Success
        controls:
        - analyticsId: 45
          application: System1
          analyticsName: Test 1
          controlid: null
          category: Certification
          description: ''
          lastRun: 05-01-2017 21:10:03
          risk: High
          recommendations: ''
          conflictCount: 14
        errorCode: '0'
      properties:
        msg:
          type: string
          x-stoplight:
            id: 54jexjooivov4
        controls:
          type: array
          x-stoplight:
            id: t7tnixg5vn1v3
          items:
            $ref: '#/components/schemas/FetchControlListControl'
            x-stoplight:
              id: i0b8qfwrmpdex
        displayCount:
          type: integer
          x-stoplight:
            id: p0e0watz2bk3i
        errorCode:
          type: string
          x-stoplight:
            id: ltcnqu8587hha
        totalCount:
          type: integer
          x-stoplight:
            id: m2v9vy8tcmofe
      description: ''
    RunAnalyticsControlsRequest:
      title: RunAnalyticsControlsRequest
      x-stoplight:
        id: 87y2dc3seajgq
      type: object
      properties:
        jobgroup:
          type: string
          x-stoplight:
            id: ggoezmz8mhpkd
        jobname:
          type: string
          x-stoplight:
            id: md536xji95s6k
        analyticsCategories:
          type: string
          x-stoplight:
            id: b642yifl4s6hx
        analyticsApplications:
          type: string
          x-stoplight:
            id: 240z30vkn6tn6
        analyticssubcategories:
          type: string
          x-stoplight:
            id: oh3210dy6zx9e
      required:
      - jobgroup
      - jobname
      - analyticsCategories
x-stoplight:
  id: uyxb46mfjt7dp