PingOne Platform APIs

Create DaVinci Application Flow Policies

 

POST {{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies

The POST {{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies endpoint creates a new DaVinci application flow policy resource.

Request Model
Property Type Required?

name

String

Required

flowDistributions

Array

Optional

flowDistributions.id

String

Optional

flowDistributions.weight

Number

Optional

flowDistributions.version

String

Optional

flowDistributions.successNodes

Array

Optional

flowDistributions.successNodes.id

Array

Optional

status

String

Optional

trigger

Object

Optional

trigger.type

String

Optional

Refer to DaVinci Admin Application Flow Policies data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "Sample DaVinci Flow Policy",
    "flowDistributions": [
        {
            "id": "{{davinciFlowID}}",
            "version": 0,
            "weight": 100
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "Sample DaVinci Flow Policy",
    "flowDistributions": [
        {
            "id": "{{davinciFlowID}}",
            "version": 0,
            "weight": 100
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""name"": ""Sample DaVinci Flow Policy""," + "\n" +
@"    ""flowDistributions"": [" + "\n" +
@"        {" + "\n" +
@"            ""id"": ""{{davinciFlowID}}""," + "\n" +
@"            ""version"": 0," + "\n" +
@"            ""weight"": 100" + "\n" +
@"        }" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies"
  method := "POST"

  payload := strings.NewReader(`{
    "name": "Sample DaVinci Flow Policy",
    "flowDistributions": [
        {
            "id": "{{davinciFlowID}}",
            "version": 0,
            "weight": 100
        }
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
POST /environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "Sample DaVinci Flow Policy",
    "flowDistributions": [
        {
            "id": "{{davinciFlowID}}",
            "version": 0,
            "weight": 100
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"Sample DaVinci Flow Policy\",\n    \"flowDistributions\": [\n        {\n            \"id\": \"{{davinciFlowID}}\",\n            \"version\": 0,\n            \"weight\": 100\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "Sample DaVinci Flow Policy",
    "flowDistributions": [
      {
        "id": "{{davinciFlowID}}",
        "version": 0,
        "weight": 100
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "Sample DaVinci Flow Policy",
    "flowDistributions": [
      {
        "id": "{{davinciFlowID}}",
        "version": 0,
        "weight": 100
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies"

payload = json.dumps({
  "name": "Sample DaVinci Flow Policy",
  "flowDistributions": [
    {
      "id": "{{davinciFlowID}}",
      "version": 0,
      "weight": 100
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "name": "Sample DaVinci Flow Policy",\n    "flowDistributions": [\n        {\n            "id": "{{davinciFlowID}}",\n            "version": 0,\n            "weight": 100\n        }\n    ]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "Sample DaVinci Flow Policy",
  "flowDistributions": [
    {
      "id": "{{davinciFlowID}}",
      "version": 0,
      "weight": 100
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"Sample DaVinci Flow Policy\",\n    \"flowDistributions\": [\n        {\n            \"id\": \"{{davinciFlowID}}\",\n            \"version\": 0,\n            \"weight\": 100\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/davinciApplications/{{davinciApplicationID}}/flowPolicies")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/davinciApplications/c529ef171357b2a41faf939f47bf0ff7/flowPolicies/f56e33bb4eb1e05a1de5db5282aacbf1"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "f56e33bb4eb1e05a1de5db5282aacbf1",
    "name": "Sample DaVinci Flow Policy",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "status": "enabled",
    "flowDistributions": [
        {
            "id": "a79d1931573009379f0691befa538d97",
            "version": 0,
            "weight": 100
        }
    ],
    "createdAt": "2024-06-17T16:08:04.224Z",
    "updatedAt": "2024-06-17T16:08:04.224Z"
}