PingOne Platform APIs

DaVinci Admin Application Flow Policies

The PingOne DaVinci Admin Application Flow Policies service provides endpoints to create, read, update, and delete DaVinci application flow policies. Application flow policies specify which flows are run through the application. A flow policy is an entity that points to one or more flows or versions of flows.

DaVinci Admin application flow policies data model properties

Property Type? Required? Mutable? Description

createdAt

Date

N/A

Read only

The time when the flow policy was created.

environment

Object

N/A

Read only

The DaVinci company ID (environment ID) object.

environment.id

String

N/A

Read only

The DaVinci company ID, which is the PingOne environment ID.

id

String

N/A

Read only

The flow policy ID.

name

String

Required

Mutable

The flow policy name.

flowDistributions

Array

Optional

Immutable

An array of flow distribution properties that are a part of this flow policy.

flowDistributions.id

String

Optional

Immutable

The flow ID associated with this flow policy.

flowDistributions.weight

Number

Optional

Mutable

The weight that is assigned to the current flow in the flow policy.

flowDistributions.version

String

Optional

Mutable

The version of the flow to be used in the flow policy.

flowDistributions.successNodes

Array

Optional

Mutable

An array of node IDs in the flow that indicate a successful execution of the flow policy.

flowDistributions.successNodes.id

Array

Optional

Mutable

The node ID.

flowDistributions.ip

Array

Optional

Mutable

An array of IP addresses to create a whitelist of IP addresses from which flow executions can be performed.

status

String

Optional

Mutable

The status of the flow policy. Options are Enabled and Disabled.

trigger

Object

Optional

Immutable

The trigger associated with the flow.

trigger.type

String

Optional

Immutable

If the trigger type is set to AUTHENTICATION, you invoke the flow through PingOne OpenID Connect or SAML endpoints.

updatedAt

Date

N/A

Read only

The time when the flow policy was modified.

DaVinci Admin application flow policy event data model properties

Property Type? Required? Mutable? Description

environment

Object

N/A

Read only

The environment object.

environment.id

String

N/A

Read only

The DaVinci company ID, which is the PingOne environment ID.

events

Object

N/A

Read only

The DaVinci event object.

events.id

String

N/A

Read only

The DaVinci event ID.

events.timestamp

Date

N/A

Read only

A UTC timestamp that specifies when the event was logged.

flow

Object

N/A

Read only

The DaVinci flow object.

flow.id

String

N/A

Read only

The DaVinci flow ID.

flow.version

Number

N/A

Read only

The DaVinci flow version number.

totalCount

Number

N/A

Read only

The total number of flow executions.

successCount

Number

N/A

Read only

The total count of success nodes reached in flow executions.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.