Ping Identity DaVinci Admin Application Flow Policies API
Operations for managing DaVinci application flows policies
OpenAPI Specification
openapi: 3.1.1
info:
title: PingOne Platform Configuration Management DaVinci Admin Application Flow Policies 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 Application Flow Policies
description: Operations for managing DaVinci application flows policies
paths:
/environments/{environmentID}/davinciApplications/{davinciApplicationID}/flowPolicies:
get:
operationId: getFlowPoliciesByDavinciApplicationId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.davinciApplicationID'
- $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.flowpolicies.response.FlowPoliciesResponse'
'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:flowPolicies
tags:
- DaVinci Admin Application Flow Policies
post:
operationId: createFlowPolicyByDavinciApplicationId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.davinciApplicationID'
- $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.flowpolicies.data.CreateFlowPolicy'
required: true
responses:
'201':
description: Successfully created the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flowpolicies.response.FlowPolicyResponse'
'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:create:flowPolicies
tags:
- DaVinci Admin Application Flow Policies
/environments/{environmentID}/davinciApplications/{davinciApplicationID}/flowPolicies/{flowPolicyID}:
get:
operationId: getFlowPolicyByIdUsingDavinciApplicationId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.davinciApplicationID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.flowPolicies.flowPolicyID'
- $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.flowpolicies.response.FlowPolicyResponse'
'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:flowPolicies
tags:
- DaVinci Admin Application Flow Policies
put:
operationId: replaceFlowPolicyByIdUsingDavinciApplicationId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.davinciApplicationID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.flowPolicies.flowPolicyID'
- $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.flowpolicies.data.UpdateFlowPolicy'
required: true
responses:
'200':
description: Successful Operation.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.flowpolicies.response.FlowPolicyResponse'
'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:flowPolicies
tags:
- DaVinci Admin Application Flow Policies
delete:
operationId: deleteFlowPolicyByIdUsingDavinciApplicationId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.davinciApplicationID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.flowPolicies.flowPolicyID'
- $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:flowPolicies
tags:
- DaVinci Admin Application Flow Policies
/environments/{environmentID}/davinciApplications/{davinciApplicationID}/flowPolicies/{flowPolicyID}/events:
get:
operationId: getEventsByDavinciApplicationIdAndFlowPolicyId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.davinciApplicationID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.davinciApplications.flowPolicies.flowPolicyID'
- $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.flowpolicies.response.FlowPolicyEventsResponse'
'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:flowPolicies
tags:
- DaVinci Admin Application Flow Policies
components:
responses:
http.403.Forbidden.P14C63085:
description: 'Forbidden - Note: This may occur if the environment doesn''t exist. Check for environment existence with GET /environments/{environmentID} first.'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.403'
x-pingone-p14c-63085: true
http.502.BadGateway:
description: Bad Gateway
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse'
http.404.NotFound:
description: Not Found
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.404'
http.415.UnsupportedMediaType:
description: Unsupported Media Type
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.415'
http.400.BadRequest:
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.400'
http.503.ServiceUnavailable:
description: Service Unavailable
headers:
Retry-After:
$ref: '#/components/headers/http.RetryAfter'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse'
http.401.Unauthorized:
description: Unauthorized
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.401'
http.500.InternalServerError:
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.500'
http.429.TooManyRequests:
description: Too Many Requests
headers:
Retry-After:
$ref: '#/components/headers/http.RetryAfter'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.429'
schemas:
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.pingone.davinci.flowpolicies.response.FlowPolicyEventsResponse:
type: object
properties:
_links:
type: object
properties:
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- self
- environment
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Flow Policy Events Collection _links
_embedded:
type: object
properties:
events:
type: array
items:
type: object
properties:
environment:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Policy Events Collection _embedded Event Environment Id
required:
- id
title: DaVinci Flow Policy Events Collection _embedded Event Environment
flow:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Policy Events Collection _embedded Event Flow Id
version:
type: number
title: DaVinci Flow Policy Events Collection _embedded Event Flow Version
required:
- id
title: DaVinci Flow Policy Events Collection _embedded Event Flow
events:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
title: DaVinci Flow Policy Events Collection _embedded Event Event Id
timestamp:
type: string
minLength: 1
title: DaVinci Flow Policy Events Collection _embedded Event Event Timestamp
required:
- id
- timestamp
title: DaVinci Flow Policy Events Collection _embedded Event Event
title: DaVinci Flow Policy Events Collection _embedded Event Events
successCount:
type: number
title: DaVinci Flow Policy Events Collection _embedded Event Success Count
totalCount:
type: number
title: DaVinci Flow Policy Events Collection _embedded Event Total Count
required:
- environment
- flow
title: DaVinci Flow Policy Events Collection _embedded Event
title: DaVinci Flow Policy Events Collection _embedded Events
required:
- events
title: DaVinci Flow Policy Events Collection _embedded
required:
- _links
- _embedded
title: DaVinci Flow Policy Events Collection
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.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.api.Relationship.PingOne.RO:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
minLength: 1
title: Resource Relationship Read-Only Id
required:
- id
title: Resource Relationship Read-Only
com.pingidentity.api.Relationship.DaVinci.RO:
type: object
properties:
id:
type: string
pattern: ^(?=\S)[\p{L}\p{M}\p{N}\p{So}/.'_ -]*(?!.*((<)|(\$\{)))
readOnly: true
minLength: 1
title: Resource Relationship DaVinci Read-Only Id
required:
- id
title: Resource Relationship DaVinci Read-Only
com.pingidentity.pingone.davinci.flowpolicies.data.CreateFlowPolicy:
type: object
additionalProperties: true
properties:
flowDistributions:
type: array
minItems: 1
maxItems: 100
items:
type: object
additionalProperties: false
properties:
id:
type: string
pattern: ^[a-zA-Z0-9-_]+$
minLength: 1
title: DaVinci Flow Policy Create Request Flow Distribution Id
version:
type: number
title: DaVinci Flow Policy Create Request Flow Distribution Version
ip:
type: array
items:
type: string
title: DaVinci Flow Policy Create Request Flow Distribution Ip Item
title: DaVinci Flow Policy Create Request Flow Distribution Ip
successNodes:
type: array
minItems: 1
items:
type: object
additionalProperties: false
properties:
id:
pattern: ^[a-zA-Z0-9]+$
type: string
minLength: 1
title: DaVinci Flow Policy Create Request Flow Distribution Success Node Id
required:
- id
title: DaVinci Flow Policy Create Request Flow Distribution Success Node
title: DaVinci Flow Policy Create Request Flow Distribution Success Nodes
weight:
type: number
title: DaVinci Flow Policy Create Request Flow Distribution Weight
required:
- id
- version
title: DaVinci Flow Policy Create Request Flow Distribution
title: DaVinci Flow Policy Create Request Flow Distributions
name:
pattern: ^(?=\S)[\p{L}\p{M}\p{N}\p{So}/.'_ -]*(?!.*((<)|(\$\{)))
maxLength: 256
type: string
default: New Policy
title: DaVinci Flow Policy Create Request Name
status:
enum:
- disabled
- enabled
type: string
default: enabled
title: DaVinci Flow Policy Create Request Status
trigger:
type: object
additionalProperties: true
properties:
configuration:
type: object
additionalProperties: true
properties:
mfa:
type: object
additionalProperties: true
properties:
enabled:
type: boolean
title: DaVinci Flow Policy Create Request Trigger Configuration MFA Enabled
time:
type: number
minLength: 0
maxLength: 100000
title: DaVinci Flow Policy Create Request Trigger Configuration MFA Time
timeFormat:
type: string
minLength: 0
maxLength: 50
title: DaVinci Flow Policy Create Request Trigger Configuration MFA Time Format
title: DaVinci Flow Policy Create Request Trigger Configuration MFA
pwd:
type: object
additionalProperties: true
properties:
enabled:
type: boolean
title: DaVinci Flow Policy Create Request Trigger Configuration Password Enabled
time:
type: number
minLength: 0
maxLength: 100000
title: DaVinci Flow Policy Create Request Trigger Configuration Password Time
timeFormat:
type: string
minLength: 0
maxLength: 50
title: DaVinci Flow Policy Create Request Trigger Configuration Password Time Format
title: DaVinci Flow Policy Create Request Trigger Configuration Password
title: DaVinci Flow Policy Create Request Trigger Configuration
type:
type: string
minLength: 0
maxLength: 50
enum:
- AUTHENTICATION
default: AUTHENTICATION
title: DaVinci Flow Policy Create Request Trigger Type
title: DaVinci Flow Policy Create Request Trigger
required:
- flowDistributions
title: DaVinci Flow Policy Create Request
com.pingidentity.ApiErrorResponse.415:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Unsupported Media Type Error Id
code:
type: string
enum:
- INVALID_REQUEST
minLength: 1
title: Unsupported Media Type Error Code
message:
type: string
minLength: 1
title: Unsupported Media Type Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
minLength: 1
title: Unsupported Media Type Error Detail Code
message:
type: string
minLength: 1
title: Unsupported Media Type Error Detail Message
innerError:
type: object
additionalProperties: true
title: Unsupported Media Type Error Detail Inner Error
target:
type: string
title: Unsupported Media Type Error Detail Target
required:
- code
- message
title: Unsupported Media Type Error Detail
title: Unsupported Media Type Error Details
required:
- id
- code
- message
title: Unsupported Media Type Error
com.pingidentity.ApiErrorResponse.500:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uui
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ping-identity/refs/heads/main/openapi/ping-identity-davinci-admin-application-flow-policies-api-openapi.yml