PingOne Platform APIs

Step 19: Get the flow

   

GET {{authPath}}/{{destinationEnvID}}/flows/{{flowID}}

Use the GET {{authPath}}/{{destinationEnvID}}/flows/{{flowID}} operation using the {{flowID}} value from the previous step to retrieve information about the flow and current flow state.

The status property returned in the response body specifies the next action in the authentication flow. In this example, a status value of "SIGN_ON_REQUIRED" is returned, indicating a sign-on action is required next.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  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))
}
GET /{{destinationEnvID}}/flows/{{flowID}} HTTP/1.1
Host: {{authPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
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 "net/http"

url = URI("{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{authPath}}/{{destinationEnvID}}/flows/{{flowID}}")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

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

200 OK

{
    "_links": {
        "user.lookup": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/0307997e-3a59-42ce-ae23-c480e5a9d587"
        },
        "self": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/0307997e-3a59-42ce-ae23-c480e5a9d587"
        }
    },
    "id": "0307997e-3a59-42ce-ae23-c480e5a9d587",
    "resumeUrl": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as/resume?flowId=0307997e-3a59-42ce-ae23-c480e5a9d587",
    "status": "SIGN_ON_REQUIRED",
    "createdAt": "2024-04-25T21:48:25.062Z",
    "expiresAt": "2024-04-25T22:03:51.920Z",
    "_embedded": {
        "socialProviders": [
            {
                "id": "7314c9df-53eb-4362-b4ae-1c8bdb9b79bd",
                "name": "IdentityProvider_1714081434",
                "type": "OPENID_CONNECT",
                "_links": {
                    "authenticate": {
                        "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/rp/authenticate?providerId=7314c9df-53eb-4362-b4ae-1c8bdb9b79bd&flowId=0307997e-3a59-42ce-ae23-c480e5a9d587&transactionId=63225a16-7ad0-45cb-82cf-97164cb59e1f"
                    }
                }
            }
        ],
        "application": {
            "name": "DestinationApp_1714081533"
        }
    }
}