Ping Identity DaVinci Admin Flows API

openapi: 3.2.0
info:
  title: PingOne Platform DaVinci Admin Flows API
  version: 2026.01.07-beta
  description: PingOne is a cloud-based framework for secure identity access management. The PingOne API gives developers the tools to integrate enterprise and third-party applications with the PingOne platform.
  contact:
    name: Ping Identity Developer Experiences
    url: https://developer.pingidentity.com
    email: devex@pingidentity.com
  license:
    identifier: Apache-2.0
    name: Apache 2.0
servers:
- url: https://api.pingone.{tld}/{basePath}
  variables:
    basePath:
      default: v1
    tld:
      enum:
      - eu
      - com
      - asia
      - com.au
      - ca
      - sg
      default: com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: DaVinci Admin Flows
  description: Operations for managing DaVinci flows
paths:
  /environments/{environmentID}/flows:
    get:
      operationId: getFlows
      parameters:
      - name: attributes
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      responses:
        '200':
          description: Successful Operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowsResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:read:dvFlows
      tags:
      - DaVinci Admin Flows
    post:
      operationId: createFlow
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.data.CreateFlow'
        required: true
      responses:
        '201':
          description: Successfully created the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:create:dvFlows
      tags:
      - DaVinci Admin Flows
  /environments/{environmentID}/flows/{flowID}:
    get:
      operationId: getFlowById
      parameters:
      - name: attributes
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      responses:
        '200':
          description: Successful Operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:read:dvFlows
      tags:
      - DaVinci Admin Flows
    put:
      operationId: replaceFlowById
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.data.UpdateFlow'
        required: true
      responses:
        '200':
          description: Successful Operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:update:dvFlows
      tags:
      - DaVinci Admin Flows
    delete:
      operationId: deleteFlowById
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      responses:
        '204':
          description: Successfully removed. No content.
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:delete:dvFlows
      tags:
      - DaVinci Admin Flows
  /environments/{environmentID}/flows/{flowID}#clone+json:
    post:
      operationId: cloneFlowByIdAsCloneJson
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      requestBody:
        content:
          application/vnd.pingidentity.flow.clone+json:
            schema:
              $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.data.CloneFlow'
        required: true
      responses:
        '201':
          description: Successfully created the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:create:dvFlows
      x-pingidentity-operation-action: clone
      tags:
      - DaVinci Admin Flows
  /environments/{environmentID}/flows/{flowID}#deploy+json:
    post:
      operationId: deployFlowByIdAsDeployJson
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      requestBody:
        content:
          application/vnd.pingidentity.flow.deploy+json:
            schema:
              $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.data.DeployFlow'
        required: true
      responses:
        '201':
          description: Successfully created the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:create:dvFlows
      x-pingidentity-operation-action: deploy
      tags:
      - DaVinci Admin Flows
  /environments/{environmentID}/flows/{flowID}#validate+json:
    post:
      operationId: validateFlowByIdAsValidateJson
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      requestBody:
        content:
          application/vnd.pingidentity.flow.validate+json:
            schema:
              $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.data.ValidateFlow'
        required: true
      responses:
        '200':
          description: Successful Operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
        '404':
          $ref: '#/components/responses/http.404.NotFound.DOCS8830'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:create:dvFlows
      x-pingidentity-operation-action: validate
      tags:
      - DaVinci Admin Flows
  /environments/{environmentID}/flows/{flowID}/enabled:
    put:
      operationId: updateEnabledByFlowId
      parameters:
      - $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
      - $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
      - $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.data.EnableFlow'
        required: true
      responses:
        '200':
          description: Successful Operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.FlowEnabledResponse'
        '400':
          $ref: '#/components/responses/http.400.BadRequest'
        '401':
          $ref: '#/components/responses/http.401.Unauthorized'
        '403':
          $ref: '#/components/responses/http.403.Forbidden.P14C63085'
        '404':
          $ref: '#/components/responses/http.404.NotFound'
        '415':
          $ref: '#/components/responses/http.415.UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/http.429.TooManyRequests'
        '500':
          $ref: '#/components/responses/http.500.InternalServerError'
        '502':
          $ref: '#/components/responses/http.502.BadGateway'
        '503':
          $ref: '#/components/responses/http.503.ServiceUnavailable'
      x-permission: davinci:update:dvFlows
      x-pingidentity-operation-action: update
      tags:
      - DaVinci Admin Flows
components:
  schemas:
    com.pingidentity.pingone.davinci.flows.data.fragment.GraphData:
      type: object
      additionalProperties: true
      properties:
        boxSelectionEnabled:
          type: boolean
          title: DaVinci Flow Graph Data Request Box Selection Enabled
        data:
          type: object
          title: DaVinci Flow Graph Data Request Data
        elements:
          type: object
          properties:
            edges:
              type: array
              items:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        title: DaVinci Flow Graph Data Request Elements Edge Data Id
                      source:
                        type: string
                        minLength: 1
                        title: DaVinci Flow Graph Data Request Elements Edge Data Source
                      target:
                        type: string
                        minLength: 1
                        title: DaVinci Flow Graph Data Request Elements Edge Data Target
                    required:
                    - id
                    - source
                    - target
                    title: DaVinci Flow Graph Data Request Elements Edge Data
                  classes:
                    type: string
                    title: DaVinci Flow Graph Data Request Elements Edge Classes
                  grabbable:
                    type: boolean
                    title: DaVinci Flow Graph Data Request Elements Edge Grabbable
                  group:
                    type: string
                    title: DaVinci Flow Graph Data Request Elements Edge Group
                  locked:
                    type: boolean
                    title: DaVinci Flow Graph Data Request Elements Edge Locked
                  pannable:
                    type: boolean
                    title: DaVinci Flow Graph Data Request Elements Edge Pannable
                  position:
                    type: object
                    properties:
                      x:
                        type: number
                        format: bigFloatUnquoted
                        title: DaVinci Flow Graph Data Request Elements Edge Position X
                      y:
                        type: number
                        format: bigFloatUnquoted
                        title: DaVinci Flow Graph Data Request Elements Edge Position Y
                    required:
                    - x
                    - y
                    title: DaVinci Flow Graph Data Request Elements Edge Position
                  removed:
                    type: boolean
                    title: DaVinci Flow Graph Data Request Elements Edge Removed
                  selectable:
                    type: boolean
                    title: DaVinci Flow Graph Data Request Elements Edge Selectable
                  selected:
                    type: boolean
                    title: DaVinci Flow Graph Data Request Elements Edge Selected
                additionalProperties: true
                required:
                - data
                title: DaVinci Flow Graph Data Request Elements Edge
              title: DaVinci Flow Graph Data Request Elements Edges
            nodes:
              type: array
              items:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        title: DaVinci Flow Graph Data Request Elements Node Data Id
                      nodeType:
                        type: string
                        minLength: 1
                        title: DaVinci Flow Graph Data Request Elements Node Data Node Type
                      capabilityName:
                        type: string
                        title: DaVinci Flow Graph Data Request Elements Node Data Capability Name
                      connectionId:
                        type: string
                        title: DaVinci Flow Graph Data Request Elements Node Data Connection Id
                      connectorId:
                        type: string
                        title: DaVinci Flow Graph Data Request Elements Node Data Connector Id
                      idUnique:
                        type: string
                        title: DaVinci Flow Graph Data Request Elements Node Data Id Unique
                      label:
                        type: string
                        title: DaVinci Flow Graph Data Request Elements Node Data Label
                      name:
                        type: string
                        title: DaVinci Flow Graph Data Request Elements Node Data Name
                      properties:
                        type: object
                        additionalProperties: true
                        properties:
                          backgroundColor:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Background Color Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Background Color
                          code:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Code Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Code
                          customCSS:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Custom CSS Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Custom CSS
                          customHTML:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Custom HTML Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Custom HTML
                          customScript:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Custom Script Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Custom Script
                          formFieldsList:
                            type: object
                            properties:
                              value:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    preferredDataType:
                                      type:
                                      - array
                                      - boolean
                                      - integer
                                      - number
                                      - object
                                      - string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List Value Item Preferred Data Type
                                    propertyName:
                                      type: string
                                      minLength: 1
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List Value Item Property Name
                                    preferredControlType:
                                      type: string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List Value Item Preferred Control Type
                                    value:
                                      type: string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List Value Item Value
                                  required:
                                  - preferredDataType
                                  - propertyName
                                  title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List Value Item
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Form Fields List
                          inputSchema:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Input Schema Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Input Schema
                          message:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Message Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Message
                          nodeTitle:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Node Title Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Node Title
                          outputSchema:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Output Schema Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Output Schema
                          saveVariables:
                            type: object
                            properties:
                              value:
                                type: array
                                items:
                                  type: object
                                  additionalProperties: true
                                  properties:
                                    name:
                                      type: string
                                      minLength: 1
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item Name
                                    key:
                                      type: number
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item Key
                                    label:
                                      type: string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item Label
                                    nameDefault:
                                      type: string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item Name Default
                                    type:
                                      type: string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item Type
                                    value:
                                      type: string
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item Value
                                  required:
                                  - name
                                  title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value Item
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Save Variables
                          showContinueButton:
                            type: object
                            properties:
                              value:
                                type: boolean
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Show Continue Button Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Show Continue Button
                          type:
                            type: object
                            properties:
                              value:
                                type: string
                                minLength: 1
                                title: DaVinci Flow Graph Data Request Elements Node Data Properties Type Value
                            required:
                            - value
                            title: DaVinci Flow Graph Data Request Elements Node Data Properties Type
                          variableInputList:
                            type: object
                            properties:
                              value:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      minLength: 1
                                      title: DaVinci Flow Graph Data Request Elements Node Data Properties Variable Input List Value Item Name
                                    preferredDataType:
                                      type:
                                      - array
                                      - boolean
                                      - integer
                                      - number
                                      - object
                                   

# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ping-identity/refs/heads/main/openapi/ping-identity-davinci-admin-flows-api-openapi.yml