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.

Assigning admin roles and permissions to this service

Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to PingOne Permissions by Service for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to PingOne Permissions by Resource when assigning admin roles per service resources.

Admin assignments to roles are set by:

Refer to Roles Management for more information.

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.

Flow policy errors

In addition to the general error codes, flow policy operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_DATA

None

Message: Identifies the allowed filter attributes.

When and details

When: The filter query parameter uses an unsupported equality attribute

Details: None.

400

REQUEST_FAILED

INVALID_FILTER

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: The filter query parameter cannot be parsed, or uses ne for an attribute other than trigger.subtype

Details: Describes the filter parser or evaluator failure.

400

REQUEST_FAILED

None

Message: Describes the downstream client error.

When and details

When: A DaVinci client request fails with an HTTP client error while listing or reading flow policies

Details: None.

404

NOT_FOUND

None

Message: Identifies the active flow policy and environment.

When and details

When: GET /flowPolicies/{flowPolicyID} references a flow policy that does not exist or is not active

Details: None.

500

UNEXPECTED_ERROR

None

Message: Echoes the underlying failure, such as Failed to get access_token when calling DaVinci endpoints. For unhandled internal failures, There was an unexpected error with the service. Please try again later.

When and details

When: A flow‑policy service operation fails unexpectedly, including DaVinci access‑token retrieval

Details: None.
Related topics