Ping Identity DaVinci Admin Flow Versions API
Operations for managing DaVinci flow versions
Operations for managing DaVinci flow versions
openapi: 3.1.1
info:
title: PingOne Platform Configuration Management DaVinci Admin Flow Versions 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 Flow Versions
description: Operations for managing DaVinci flow versions
paths:
/environments/{environmentID}/flows/{flowID}/versions:
get:
operationId: getVersionsByFlowId
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:
'200':
description: Successful Operation.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flowversions.response.FlowVersionsResponse'
'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:read:flowVersions
tags:
- DaVinci Admin Flow Versions
/environments/{environmentID}/flows/{flowID}/versions/{versionID}:
get:
operationId: getVersionByIdUsingFlowId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.flows.versions.versionID'
- $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.flowversions.response.FlowVersionResponse'
'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:read:flowVersions
tags:
- DaVinci Admin Flow Versions
delete:
operationId: deleteVersionByIdUsingFlowId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.flows.versions.versionID'
- $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'
'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:delete:flowVersions
tags:
- DaVinci Admin Flow Versions
/environments/{environmentID}/flows/{flowID}/versions/{versionID}/alias:
put:
operationId: replaceAliasByFlowIdAndVersionId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.flows.flowID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.flows.versions.versionID'
- $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.flowversions.data.FlowVersionAlias'
required: true
responses:
'200':
description: Successful Operation.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flowversions.response.FlowVersionAliasResponse'
'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:flowVersions
tags:
- DaVinci Admin Flow Versions
/environments/{environmentID}/flows/{flowID}/versions/{versionID}/details:
get:
operationId: getDetailsByFlowIdAndVersionId
parameters:
- name: expand
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.path.environments.flows.versions.versionID'
- $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.flowversions.response.FlowVersionDetailResponse'
'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:read:flowVersions
tags:
- DaVinci Admin Flow Versions
components:
schemas:
com.pingidentity.pingone.davinci.flowversions.response.FlowVersionsResponse:
type: object
properties:
_embedded:
type: object
properties:
versions:
type: array
items:
type: object
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flowversions.response.FlowVersionResponse'
title: DaVinci Flow Version Collection Response _embedded Versions
required:
- versions
title: DaVinci Flow Version Collection Response _embedded
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Flow Version Collection Response _links
required:
- _embedded
- _links
title: DaVinci Flow Version Collection Response
com.pingidentity.pingone.davinci.flowversions.response.FlowVersionAliasResponse:
type: object
properties:
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
flowVersion:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
- flowVersion
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Flow Version Alias Response _links
alias:
type: string
minLength: 1
title: DaVinci Flow Version Alias Response Alias
required:
- _links
- alias
title: DaVinci Flow Version Alias Response
com.pingidentity.ApiErrorResponse:
type: object
properties:
code:
type: string
title: General Error Code
details:
type: array
items:
$ref: '#/components/schemas/com.pingidentity.ErrorDetail'
title: General Error Details
id:
type: string
title: General Error Id
message:
type: string
title: General Error Message
title: General Error
com.pingidentity.ApiErrorResponse.400:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Bad Request Error Id
code:
type: string
enum:
- INVALID_DATA
- INVALID_REQUEST
- REQUEST_FAILED
minLength: 1
title: Bad Request Error Code
message:
type: string
minLength: 1
title: Bad Request Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- ACCOUNT_NOT_USABLE
- CONSTRAINT_VIOLATION
- EMPTY_VALUE
- INVALID_FILTER
- INVALID_OTP
- INVALID_PARAMETER
- INVALID_VALUE
- MFA_AUTH_METHODS_CONFLICT
- NO_PASSWORD
- OUT_OF_RANGE
- REQUIRED_VALUE
- SIZE_LIMIT_EXCEEDED
- UNIQUENESS_VIOLATION
minLength: 1
title: Bad Request Error Detail Code
message:
type: string
minLength: 1
title: Bad Request Error Detail Message
innerError:
type: object
properties:
allowedPattern:
type: string
title: Bad Request Error Detail Inner Error Allowed Pattern
allowedValues:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Allowed Value
title: Bad Request Error Detail Inner Error Allowed Values
claim:
type: string
title: Bad Request Error Detail Inner Error Claim
existingId:
type: string
format: uuid
title: Bad Request Error Detail Inner Error Existing Id
maximumValue:
type: number
title: Bad Request Error Detail Inner Error Maximum Value
quotaLimit:
type: number
title: Bad Request Error Detail Inner Error Quota Limit
quotaResetTime:
type: string
format: date-time
title: Bad Request Error Detail Inner Error Quota Reset Time
rangeMaximumValue:
type: number
title: Bad Request Error Detail Inner Error Range Maximum Value
rangeMinimumValue:
type: number
title: Bad Request Error Detail Inner Error Range Minimum Value
supportedAttributes:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Supported Attribute
title: Bad Request Error Detail Inner Error Supported Attributes
supportedOperators:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Supported Operator
title: Bad Request Error Detail Inner Error Supported Operators
additionalProperties: true
title: Bad Request Error Detail Inner Error
target:
type: string
title: Bad Request Error Detail Target
required:
- code
- message
title: Bad Request Error Detail
title: Bad Request Error Details
required:
- id
- code
- message
title: Bad Request Error
com.pingidentity.ErrorDetail:
type: object
properties:
code:
type: string
title: General Error Detail Code
innerError:
type: object
additionalProperties:
type: object
title: General Error Detail Inner Error Additional Properties
title: General Error Detail Inner Error
message:
type: string
title: General Error Detail Message
target:
type: string
title: General Error Detail Target
title: General Error Detail
com.pingidentity.ApiErrorResponse.403:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
code:
type: string
enum:
- ACCESS_FAILED
minLength: 1
title: Forbidden Error Code
message:
type: string
minLength: 1
title: Forbidden Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- INSUFFICIENT_PERMISSIONS
- LICENSE_EXCEEDED
minLength: 1
title: Forbidden Error Detail Code
message:
type: string
minLength: 1
title: Forbidden Error Detail Message
innerError:
type: object
properties:
quotaLimit:
type: number
title: Forbidden Error Detail Inner Error Quota Limit
additionalProperties: true
title: Forbidden Error Detail Inner Error
target:
type: string
title: Forbidden Error Detail Target
required:
- code
- message
title: Forbidden Error Detail
title: Forbidden Error Details
id:
type: string
format: uuid
title: Forbidden Error Id
required:
- code
- message
title: Forbidden Error
com.pingidentity.ApiErrorResponse.404:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Not Found Error Id
code:
type: string
enum:
- NOT_FOUND
minLength: 1
title: Not Found Error Code
message:
type: string
minLength: 1
title: Not Found Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
minLength: 1
title: Not Found Error Detail Code
message:
type: string
minLength: 1
title: Not Found Error Detail Message
innerError:
type: object
additionalProperties: true
title: Not Found Error Detail Inner Error
target:
type: string
title: Not Found Error Detail Target
required:
- code
- message
title: Not Found Error Detail
title: Not Found Error Details
required:
- id
- code
- message
title: Not Found Error
com.pingidentity.pingone.davinci.flowversions.response.FlowVersionResponse:
type: object
properties:
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
details:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
flow.export:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
flow.revert:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
- details
- flow.export
- flow.revert
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Flow Version Response _links
environment:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Version Response Environment Id
required:
- id
title: DaVinci Flow Version Response Environment
flow:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Version Response Flow Id
name:
type: string
minLength: 1
title: DaVinci Flow Version Response Flow Name
required:
- id
- name
title: DaVinci Flow Version Response Flow
version:
type: number
title: DaVinci Flow Version Response Version
alias:
type: string
title: DaVinci Flow Version Response Alias
clonedFrom:
type: number
title: DaVinci Flow Version Response Cloned From
createdAt:
type: string
format: date-time
title: DaVinci Flow Version Response Created At
deployedAt:
type: string
format: date-time
title: DaVinci Flow Version Response Deployed At
updatedAt:
type: string
format: date-time
title: DaVinci Flow Version Response Updated At
required:
- _links
- environment
- flow
- version
title: DaVinci Flow Version Response
com.pingidentity.api.response.Link:
type: object
properties:
href:
type: string
format: uri
minLength: 1
title: JSON HAL Link Href
name:
type: string
title: JSON HAL Link Name
profile:
type: string
format: uri
title: JSON HAL Link Profile
title:
type: string
format: uri
title: JSON HAL Link Title
type:
type: string
title: JSON HAL Link Type
required:
- href
readOnly: true
title: JSON HAL Link
com.pingidentity.pingone.davinci.flows.response.fragment.Trigger:
type: object
properties:
type:
type: string
enum:
- AUTHENTICATION
- SCHEDULE
minLength: 1
title: DaVinci Flow Trigger Response Type
configuration:
type: object
properties:
mfa:
type: object
properties:
enabled:
type: boolean
title: DaVinci Flow Trigger Response Configuration MFA Enabled
time:
type: number
title: DaVinci Flow Trigger Response Configuration MFA Time
timeFormat:
type: string
minLength: 1
title: DaVinci Flow Trigger Response Configuration MFA Time Format
required:
- enabled
- time
- timeFormat
title: DaVinci Flow Trigger Response Configuration MFA
pwd:
type: object
properties:
enabled:
type: boolean
title: DaVinci Flow Trigger Response Configuration Password Enabled
time:
type: number
title: DaVinci Flow Trigger Response Configuration Password Time
timeFormat:
type: string
minLength: 1
title: DaVinci Flow Trigger Response Configuration Password Time Format
required:
- enabled
- time
- timeFormat
title: DaVinci Flow Trigger Response Configuration Password
required:
- mfa
- pwd
title: DaVinci Flow Trigger Response Configuration
required:
- type
title: DaVinci Flow Trigger Response
com.pingidentity.pingone.davinci.flowversions.data.FlowVersionAlias:
type: object
additionalProperties: true
properties:
alias:
pattern: ^(?=\S)[\p{L}\p{M}\p{N}\p{So}/.'_ -]*(?!.*((<)|(\$\{)))
maxLength: 256
type: string
minLength: 1
title: DaVinci Flow Version Alias Request Alias
required:
- alias
title: DaVinci Flow Version Alias Request
com.pingidentity.pingone.davinci.flowversions.response.FlowVersionDetailResponse:
type: object
properties:
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
flow.export:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
flow.revert:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
connectorInstances.<nodeId>:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
variables.<nodeId>.<index>:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
- flow.export
- flow.revert
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Flow Version Detail Response _links
alias:
type: string
title: DaVinci Flow Version Detail Response Alias
color:
type: string
title: DaVinci Flow Version Detail Response Color
connectors:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Version Detail Response Connector Id
required:
- id
title: DaVinci Flow Version Detail Response Connector
title: DaVinci Flow Version Detail Response Connectors
createdAt:
type: string
format: date-time
title: DaVinci Flow Version Detail Response Created At
deployedAt:
type: string
format: date-time
title: DaVinci Flow Version Detail Response Deployed At
description:
type: string
title: DaVinci Flow Version Detail Response Description
enabled:
type: boolean
title: DaVinci Flow Version Detail Response Enabled
flow:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Version Detail Response Flow Id
name:
type: string
minLength: 1
title: DaVinci Flow Version Detail Response Flow Name
required:
- id
- name
title: DaVinci Flow Version Detail Response Flow
graphData:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.fragment.GraphData'
inputSchema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.fragment.InputSchema'
outputSchema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.fragment.OutputSchema'
settings:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flows.response.fragment.Settings'
skcomponents:
type: array
items:
type: object
properties:
id:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Id
name:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Name
nodeId:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Node Id
options:
type: object
properties:
appSessionId:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options App Session Id
appid:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Appid
appsecret:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Appsecret
browsertoken:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Browsertoken
buttonImage:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Button Image
buttonImageClass:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Button Image Class
buttonImagePlacement:
type: string
enum:
- left
- right
title: DaVinci Flow Version Detail Response Skcomponent Options Button Image Placement
buttonType:
type: string
enum:
- back-to-previous
- form-submit
- mfa-reset
- next-event
- nuance-audio
- otp
title: DaVinci Flow Version Detail Response Skcomponent Options Button Type
cdn:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Cdn
class:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Class
collectBehavioralData:
type: boolean
default: true
title: DaVinci Flow Version Detail Response Skcomponent Options Collect Behavioral Data
contentType:
type: string
enum:
- image
- text
title: DaVinci Flow Version Detail Response Skcomponent Options Content Type
createP1User:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options CreateP 1 User
customLoadingIndicator:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Custom Loading Indicator
customLoadingIndicatorClass:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Custom Loading Indicator Class
defaultLoadingColor:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Default Loading Color
environmentId:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Environment Id
errorId:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Error Id
form:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Form
height:
type: string
default: 600px
title: DaVinci Flow Version Detail Response Skcomponent Options Height
host:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Host
id:
type: string
title: DaVinci Flow Version Detail Response Skcomponent Options Id
identityProviderId:
ty
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ping-identity/refs/heads/main/openapi/ping-identity-davinci-admin-flow-versions-api-openapi.yml