PingOne Platform APIs

Flow Policies

The flow policies endpoint identifies the DaVinci flow policy resources defined in the specified environment. It provides operations to list all flow policies in the environment or get one flow policy specified by its flow policy ID in the request URL.

Flow policies are associated with DaVinci applications. A flow policy can have one or more DaVinci-defined flows associated with it.

Flow policies data model

Property Type Required? Mutable? Description

application

Object

Required

Read only

An object that specifies the application information associated with the flow policy resource.

application.id

String

Required

Read only

The unique identifier of the application resource associated with the flow policy.

application.name

String

Required

Read only

The name of the application resource associated with the flow policy.

enabled

Boolean

Required

Read only

A boolean that specifies whether the flow policy is enabled.

environment.id

String

Required

Read only

The environment resource’s unique identifier associated with the flow policy.

id

String

Required

Read only

The flow policy resource’s unique identifier.

name

String

Required

Read only

The flow policy resource name.

trigger

Object

Optional

Mutable

An object that specifies the predefined trigger that can initiate the flow.

trigger.type

String

Required

Mutable

A string that specifies the trigger type. This property is required if the trigger property is set. Options include AUTHENTICATION.

Response codes

Code Message

200

Successful operation.

400

The request could not be completed.

404

The requested resource was not found.

Related topics