openapi: 3.0.3
info:
  title: Cisco ISE API - pxGrid Direct
  version: 1.0.0
servers:
  - url: https://172.23.160.16:44330
    description: Inferred Url
tags:
  - name: pxgrid-direct-api-controller
    description: the pxgrid-direct API
paths:
  /api/v1/pxgrid-direct/connector-config:
    get:
      tags:
        - pxGrid Direct
      summary: get All connectorConfig information
      description: pxGrid Direct - Get ALL connectorConfig information
      operationId: getConnectorConfig
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: connectorConfig information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorConfigGetAllResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
    post:
      tags:
        - pxGrid Direct
      summary: Configure connectorconfig information
      description: pxGrid Direct - Configure connectorconfig information.
      operationId: createConnectorConfig
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorConfigInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '201':
          description: configure the Connector Config
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/connector-config/{connectorName}:
    get:
      tags:
        - pxGrid Direct
      summary: get connectorConfig information
      description: pxGrid Direct - Get connectorConfig information based on ConnectorName
      operationId: getConnectorConfigByConnectorName
      parameters:
        - name: connectorName
          in: path
          description: update or delete or retrieve the connector config.
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: connectorConfig information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorConfigGetResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
    put:
      tags:
        - pxGrid Direct
      summary: update connectoConfig information
      description: pxGrid Direct - update Configure connectorConfig information based on ConnectorName.
      operationId: updateConnectorConfigByConnectorName
      parameters:
        - name: connectorName
          in: path
          description: update or delete or retrieve the connector config.
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorConfigInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: update the Connector
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
    delete:
      tags:
        - pxGrid Direct
      summary: Delete connectorConfig information
      description: pxGrid Direct - Delete Configure connectorConfig information based on ConnectorName.
      operationId: deleteConnectorConfigByConnectorName
      parameters:
        - name: connectorName
          in: path
          description: update or delete or retrieve the connector config.
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: Delete the Connector
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '204':
          description: No Content
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/dictionary-references:
    get:
      tags:
        - pxGrid Direct
      summary: Get a map of references to pxgrid-direct dictionaries
      description: pxGrid Direct - Get a map of references to pxgrid-direct dictionaries
      operationId: getpxgridDirectDictionaryReferences
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: connectorConfig information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PxGridDirectDictionaryReferenceResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/push/{connectorName}:
    get:
      tags:
        - pxGrid Direct Push APIs
      summary: Get endpoint attribute data using the connector name
      description: pxGrid Direct API - Get endpoint attribute data using connector name, optional parameters for pagination
      operationId: getAllPushConnectorName
      parameters:
        - name: connectorName
          in: path
          description: Name of the connector.
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
        - name: size
          in: query
          description: Number of objects returned per page
          required: false
          style: form
          schema:
            type: integer
            format: int32
            exampleSetFlag: true
        - name: page
          in: query
          description: Page number
          required: false
          style: form
          schema:
            type: integer
            format: int32
            exampleSetFlag: true
      responses:
        '200':
          description: Retrieve all the Endpoint attribute data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushConnectorConfigGetAllResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/push/{connectorName}/bulk:
    post:
      tags:
        - pxGrid Direct Push APIs
      summary: Bulk operator based on create/update/delete for the provided connector name
      description: pxGrid Direct Push - Bulk operator based on create/update/delete for the provided connector name, endpoint attribute in json is an array
      operationId: bulkOperationPushConnectors
      parameters:
        - name: connectorName
          in: path
          description: Name of the connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushConnectorConfigPostBodyBulk'
              exampleSetFlag: false
      responses:
        '200':
          description: Bulk operator based on create/update/delete for the provided connector name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPushConnectorResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/push/{connectorName}/{uniqueId}:
    get:
      tags:
        - pxGrid Direct Push APIs
      summary: Get endpoint attribute data Based on UniqueID
      description: pxGrid Direct Push - Get endpoint attribute data Based on UniqueID
      operationId: getPushConnectorByUniqueId
      parameters:
        - name: connectorName
          in: path
          description: Name of the connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: uniqueId
          in: path
          description: Unique ID of the endpoint related to the Connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: endpoint attribute information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushConnectorConfigGetAllResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
    put:
      tags:
        - pxGrid Direct Push APIs
      summary: Update endpoint attribute data based on UniqueId for the given connector name.
      description: pxGrid Direct Push - Update endpoint attribute data based on UniqueId for the given connector name.
      operationId: updatePushConnectorByUniqueId
      parameters:
        - name: connectorName
          in: path
          description: Name of the connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: uniqueId
          in: path
          description: Unique ID of the endpoint related to the Connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushConnectorConfigInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Update endpoint attribute data based on UniqueId for the given connector name.
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
    delete:
      tags:
        - pxGrid Direct Push APIs
      summary: Delete endpoint attribute data based on UniqueId for the given connector name.
      description: pxGrid Direct Push - Delete endpoint attribute data based on UniqueId for the given connector name.
      operationId: deletePushConnectorByUniqueId
      parameters:
        - name: connectorName
          in: path
          description: Name of the connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: uniqueId
          in: path
          description: Unique ID of the endpoint related to the Connector
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: Delete endpoint attribute data based on UniqueId for the given connector name.
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '204':
          description: No Content
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/syncNowStatus/{connectorName}:
    get:
      tags:
        - pxGrid Direct
      summary: sync Now Status for  Connector information
      description: pxGrid Direct - Get connectorConfig information based on ConnectorName
      operationId: getConnectorConfigSyncNowStatus
      parameters:
        - name: connectorName
          in: path
          description: retrieve the connector syncnow status.
          required: true
          style: simple
          schema:
            type: string
            exampleSetFlag: true
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: connectorConfig information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncNowConfigGetResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/syncnow:
    post:
      tags:
        - pxGrid Direct
      summary: syncnow for the Connector
      description: pxGrid Direct - test the Connector.
      operationId: syncNowConnector
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncConnectorConfigInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: syncnow the Connector Config
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
  /api/v1/pxgrid-direct/test-connector:
    post:
      tags:
        - pxGrid Direct
      summary: test the Connector
      description: pxGrid Direct - test the Connector.
      operationId: testConnector
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return in the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestConnectorRequest'
              exampleSetFlag: false
      responses:
        '200':
          description: configure the Connector Config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectorResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
        - BasicAuth: []
components:
  schemas:
    ApiKeyProperties:
      title: ApiKeyProperties
      type: object
      properties:
        headerName:
          type: string
          description: header name
          example: X-ApiKeys
          exampleSetFlag: true
        key:
          type: string
          description: key
          example: test
          exampleSetFlag: true
        keyType:
          type: string
          description: key type
          example: header
          exampleSetFlag: true
          enum:
            - header
            - json
            - param
        paramName:
          type: string
          description: param name
          exampleSetFlag: true
        requestBody:
          type: string
          description: request body that will be templated
          example: key={{ KEY }}
          exampleSetFlag: true
      description: api key auth properties
      exampleSetFlag: false
    AttributeMapping:
      title: AttributeMapping
      type: object
      properties:
        coaSignificance:
          type: boolean
          example: false
          exampleSetFlag: true
        dictionaryAttribute:
          type: string
          example: securityTag
          exampleSetFlag: true
        includeInDictionary:
          type: boolean
          example: true
          exampleSetFlag: true
        jsonAttribute:
          type: string
          example: u_segmentation_group_tag
          exampleSetFlag: true
      exampleSetFlag: false
    BasicAuthProperties:
      title: BasicAuthProperties
      type: object
      properties:
        password:
          type: string
          description: password
          example: test
          exampleSetFlag: true
        requestBody:
          type: string
          description: request body that will be templated
          example: key={{ KEY }}
          exampleSetFlag: true
        userName:
          type: string
          description: userName
          example: test
          exampleSetFlag: true
      description: basic auth properties
      exampleSetFlag: false
    BulkPushConnectorResponse:
      title: BulkPushConnectorResponse
      type: object
      properties:
        connectorName:
          type: string
          description: connectorName
          example: PUSH_CONNECTOR
          exampleSetFlag: true
        data:
          type: string
          description: Response data
          example: JSON-object
          exampleSetFlag: true
        status:
          type: string
          description: status of the request
          example: Endpoint bulk request received, processing
          exampleSetFlag: true
      description: Response to Bulk Request
      exampleSetFlag: false
    ConnectorConfigGetAllResponse:
      title: ConnectorConfigGetAllResponse
      type: object
      properties:
        response:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/ConnectorConfigInfo'
            exampleSetFlag: false
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    ConnectorConfigGetResponse:
      title: ConnectorConfigGetResponse
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ConnectorConfigInfo'
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    ConnectorConfigInfo:
      title: ConnectorConfigInfo
      type: object
      properties:
        connector:
          $ref: '#/components/schemas/ConnectorConfigInfoConnector'
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    ConnectorConfigInfoConnector:
      title: ConnectorConfigInfoConnector
      type: object
      properties:
        additionalProperties:
          type: object
          additionalProperties:
            type: string
            exampleSetFlag: false
          exampleSetFlag: true
        attributes:
          $ref: '#/components/schemas/ConnectorConfigInfoConnectorAttributes'
          exampleSetFlag: true
        coaType:
          type: string
          description: enable coa for connector
          exampleSetFlag: true
          enum:
            - nocoa
            - portbounce
            - reauth
        connectorName:
          type: string
          description: connectorName
          example: SNOW_CMDB
          exampleSetFlag: true
        connectorType:
          type: string
          description: connector Type list
          exampleSetFlag: true
          enum:
            - urlfetcher
            - urlpusher
            - vmware
        deltasyncSchedule:
          $ref: '#/components/schemas/Schedule'
          exampleSetFlag: true
        description:
          type: string
          description: description
          example: description
          exampleSetFlag: true
        enabled:
          type: boolean
          example: true
          exampleSetFlag: true
        flexibleUrl:
          $ref: '#/components/schemas/ConnectorConfigInfoConnectorFlexibleUrl'
          exampleSetFlag: true
        fullsyncSchedule:
          $ref: '#/components/schemas/Schedule'
          exampleSetFlag: true
        groupArray:
          type: array
          description: <p>List of Group names</p>
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/Group'
            exampleSetFlag: false
        protocol:
          type: string
          description: protocol
          example: http
          exampleSetFlag: true
        skipCertificateValidations:
          type: boolean
          example: true
          exampleSetFlag: true
        url:
          $ref: '#/components/schemas/ConnectorConfigInfoConnectorUrl'
          exampleSetFlag: true
      description: connectorName
      exampleSetFlag: false
    ConnectorConfigInfoConnectorAttributes:
      title: ConnectorConfigInfoConnectorAttributes
      type: object
      properties:
        attributeMapping:
          type: array
          description: <p>List of feature names</p>
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/AttributeMapping'
            exampleSetFlag: false
        correlationIdentifier:
          type: string
          description: uniqueness to identify
          example: u_macaddress
          exampleSetFlag: true
        topLevelObject:
          type: string
          description: root level of json
          example: result
          exampleSetFlag: true
        uniqueIdentifier:
          type: string
          description: uniqueness to identify
          example: sys_id
          exampleSetFlag: true
        versionIdentifier:
          type: string
          description: version uniqueness to identify
          example: sys_updated_on
          exampleSetFlag: true
      description: connectorName
      exampleSetFlag: false
    ConnectorConfigInfoConnectorFlexibleUrl:
      title: ConnectorConfigInfoConnectorFlexibleUrl
      type: object
      properties:
        bulk:
          $ref: '#/components/schemas/FetchUrl'
          exampleSetFlag: true
        incremental:
          $ref: '#/components/schemas/FetchUrl'
          exampleSetFlag: true
      exampleSetFlag: false
    ConnectorConfigInfoConnectorUrl:
      title: ConnectorConfigInfoConnectorUrl
      type: object
      properties:
        authenticationType:
          type: string
          description: authentication Type list
          exampleSetFlag: true
          enum:
            - apikey
            - basic
        bulkUrl:
          type: string
          description: bulkUrl
          example: http://cmdb/cmdb-random/1
          exampleSetFlag: true
        incrementalUrl:
          type: string
          description: incrementalUrl
          example: http://cmdb/cmdb-random/1?afterDate=Feb15
          exampleSetFlag: true
        password:
          type: string
          description: password
          example: test
          exampleSetFlag: true
        userName:
          type: string
          description: userName
          example: test
          exampleSetFlag: true
      exampleSetFlag: false
    Error:
      title: Error
      required:
        - code
        - message
      type: object
      properties:
        code:
          type: string
          example: '400'
          exampleSetFlag: true
        message:
          type: string
          example: Bad Request
          exampleSetFlag: true
      exampleSetFlag: false
    FetchUrl:
      title: FetchUrl
      required:
        - authenticationType
      type: object
      properties:
        additionalHeaders:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/FetchUrlAdditionalHeaders'
            exampleSetFlag: false
        apiKeyProperties:
          $ref: '#/components/schemas/ApiKeyProperties'
          exampleSetFlag: true
        authenticationType:
          type: string
          description: authentication Type list
          example: apikey
          exampleSetFlag: true
          enum:
            - apikey
            - basic
            - oauth2
        basicAuthProperties:
          $ref: '#/components/schemas/BasicAuthProperties'
          exampleSetFlag: true
        method:
          type: string
          exampleSetFlag: true
          enum:
            - DELETE
            - GET
            - POST
            - PUT
        oauthProperties:
          $ref: '#/components/schemas/OAuthProperties'
          exampleSetFlag: true
        url:
          type: string
          description: the url to fetch
          example: http://cmdb/cmdb-random/1
          exampleSetFlag: true
      exampleSetFlag: false
    FetchUrlAdditionalHeaders:
      title: FetchUrlAdditionalHeaders
      type: object
      properties:
        name:
          type: string
          exampleSetFlag: true
        value:
          type: string
          exampleSetFlag: true
      exampleSetFlag: false
    Group:
      title: Group
      type: object
      properties:
        GroupName:
          type: string
          example: admingroupName
          exampleSetFlag: true
        GroupPermission:
          type: string
          exampleSetFlag: true
          enum:
            - read
            - write
      exampleSetFlag: false
    OAuthProperties:
      title: OAuthProperties
      type: object
      properties:
        clientId:
          type: string
          description: client id for oauth
          example: clientID
          exampleSetFlag: true
        clientSecret:
          type: string
          description: client secret for oauth
          example: clientclientsecretsecret
          exampleSetFlag: true
        flow:
          type: string
          description: oauth flow type
          example: password
          exampleSetFlag: true
          enum:
            - authorization_code
            - client_credentials
            - password
        password:
          type: string
          description: password for the password flow
          example: '1234'
          exampleSetFlag: true
        scope:
          type: string
          description: the scope of the oauth token
          example: all
          exampleSetFlag: true
        tokenIssuingUrl:
          type: string
          description: the url that will issue the bearer token
          example: http://oauth/token
          exampleSetFlag: true
        userName:
          type: string
          description: username for the password flow
          example: john
          exampleSetFlag: true
      description: OAuth properties
      exampleSetFlag: false
    PushConnectorConfigGetAllResponse:
      title: PushConnectorConfigGetAllResponse
      type: object
      properties:
        data:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/PushConnectorConfigInfo'
            exampleSetFlag: false
      description: ConnectorConfig information format
      exampleSetFlag: false
    PushConnectorConfigInfo:
      title: PushConnectorConfigInfo
      type: object
      properties:
        anyJsonArray:
          type: array
          description: any array
          example: '["Group1","Group2"]'
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        anyJsonBoolean:
          type: boolean
          description: any boolean value
          example: true
          exampleSetFlag: true
        anyJsonInteger:
          type: integer
          description: any integer
          format: int32
          example: 111
          exampleSetFlag: true
        anyJsonNumber:
          type: number
          description: any number
          format: bigdecimal
          example: 999
          exampleSetFlag: true
        anyJsonObject:
          type: object
          example: '{"value":{"id":"ObjectName","name":"ObjectValue"}}'
          exampleSetFlag: true
        anyJsonString:
          type: string
          description: any string
          example: anyJsonString
          exampleSetFlag: true
      exampleSetFlag: false
    PushConnectorConfigPostBodyBulk:
      title: PushConnectorConfigPostBodyBulk
      type: object
      properties:
        data:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/PushConnectorConfigInfo'
            exampleSetFlag: false
        operation:
          type: string
          example: create
          exampleSetFlag: true
      exampleSetFlag: false
    PxGridDirectDictionaryReference:
      title: PxGridDirectDictionaryReference
      type: object
      properties:
        PxGridDirectDictionaryReferenceType:
          type: string
          description: interval Units
          exampleSetFlag: true
          enum:
            - AUTHORIZATION_PROFILE
            - LIBRARY_CONDITION
            - POLICYSET_CONDITION
        attributeName:
          type: string
          exampleSetFlag: true
        dictionaryName:
          type: string
          exampleSetFlag: true
        referenceName:
          type: string
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    PxGridDirectDictionaryReferenceResponse:
      title: PxGridDirectDictionaryReferenceResponse
      type: object
      properties:
        response:
          type: object
          additionalProperties:
            type: array
            exampleSetFlag: false
            items:
              $ref: '#/components/schemas/PxGridDirectDictionaryReference'
              exampleSetFlag: false
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    Schedule:
      title: Schedule
      type: object
      properties:
        interval:
          type: integer
          description: run at interval (hours)
          format: int32
          example: 1
          exampleSetFlag: true
        intervalUnit:
          type: string
          description: interval Units
          exampleSetFlag: true
          enum:
            - days
            - hours
            - weeks
        startDate:
          type: string
          description: start date and Time
          example: '2025-02-10T09:00:00'
          exampleSetFlag: true
      exampleSetFlag: false
    SyncConnectorConfigInfo:
      title: SyncConnectorConfigInfo
      type: object
      properties:
        connector:
          $ref: '#/components/schemas/SyncConnectorConfigInfoConnector'
          exampleSetFlag: true
      description: SyncConnectorConfigInfo information format
      exampleSetFlag: false
    SyncConnectorConfigInfoConnector:
      title: SyncConnectorConfigInfoConnector
      type: object
      properties:
        SyncType:
          type: string
          description: connector Type list
          exampleSetFlag: true
          enum:
            - FULL
            - INCREMENTAL
        connectorName:
          type: string
          description: connectorName
          example: SNOW_CMDB
          exampleSetFlag: true
        description:
          type: string
          description: description
          example: description
          exampleSetFlag: true
      description: connectorName
      exampleSetFlag: false
    SyncConnectorConfigResInfo:
      title: SyncConnectorConfigResInfo
      type: object
      properties:
        connector:
          $ref: '#/components/schemas/SyncConnectorConfigResInfoConnector'
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    SyncConnectorConfigResInfoConnector:
      title: SyncConnectorConfigResInfoConnector
      type: object
      properties:
        connectorName:
          type: string
          description: connectorName
          example: SNOW_CMDB
          exampleSetFlag: true
        syncStatus:
          type: string
          description: description
          example: INPROGRESS or QUEUED or SYNC COMPLETED or ERRORED
          exampleSetFlag: true
      description: connectorName
      exampleSetFlag: false
    SyncNowConfigGetResponse:
      title: SyncNowConfigGetResponse
      type: object
      properties:
        response:
          $ref: '#/components/schemas/SyncConnectorConfigResInfo'
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      description: ConnectorConfig information format
      exampleSetFlag: false
    TestConnectorRequest:
      title: TestConnectorRequest
      type: object
      properties:
        authType:
          type: string
          description: authentication Type list
          exampleSetFlag: true
          enum:
            - apikey
            - basic
            - oauth2
        authValues:
          $ref: '#/components/schemas/TestConnectorRequestAuthValues'
          exampleSetFlag: true
        connectorName:
          type: string
          description: connectorName
          example: SNOW_CMDB
          exampleSetFlag: true
        flexibleUrl:
          $ref: '#/components/schemas/ConnectorConfigInfoConnectorFlexibleUrl'
          exampleSetFlag: true
        incrementalUrl:
          type: string
          description: incrementalUrl
          example: http://cmdb/cmdb-random/2
          exampleSetFlag: true
        responseParsing:
          type: string
          description: uniqueness to identify
          example: result
          exampleSetFlag: true
        skipCertificateValidations:
          type: boolean
          description: skipCertificateValidations
          example: false
          exampleSetFlag: true
        uniqueID:
          type: string
          description: uniqueness to identify
          example: u_macaddress
          exampleSetFlag: true
        url:
          type: string
          description: bulkUrl
          example: http://cmdb/cmdb-random/1
          exampleSetFlag: true
      description: Request  to test Connector
      exampleSetFlag: false
    TestConnectorRequestAuthValues:
      title: TestConnectorRequestAuthValues
      type: object
      properties:
        clientId:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        clientSecret:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        flow:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        headerName:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        key:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        keyType:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        paramName:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        password:
          type: string
          description: password
          example: test
          exampleSetFlag: true
        requestBody:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        scope:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        tokenIssuingUrl:
          type: string
          description: keyType
          example: test
          exampleSetFlag: true
        userName:
          type: string
          description: userName
          example: test
          exampleSetFlag: true
      description: Request  to test Connector
      exampleSetFlag: false
    TestConnectorResponse:
      title: TestConnectorResponse
      type: object
      properties:
        connectorName:
          type: string
          description: connectorName
          example: SNOW_CMDB
          exampleSetFlag: true
        data:
          type: string
          description: Response data
          example: JSON-object
          exampleSetFlag: true
        error:
          type: string
          description: error
          example: error
          exampleSetFlag: true
        skipCertificateValidations:
          type: boolean
          description: skipCertificateValidations
          example: false
          exampleSetFlag: true
        status:
          type: string
          description: status of the request
          example: success
          exampleSetFlag: true
        uniqueID:
          type: string
          description: uniqueness to identify
          example: u_macaddress
          exampleSetFlag: true
      description: Request  to test Connector
      exampleSetFlag: false
