PingOne Platform APIs

Step 7: Submit Login Credentials

 

POST {{authPath}}/{{envID}}/flows/{{flowID}}

To respond to the USERNAME_PASSWORD_REQUIRED flow state, the user initiates the usernamePassword.check action. You’ll then call the flow service using POST {{authPath}}/{{envID}}/flows/{{flowID}}. You’ll need the application/vnd.pingidentity.usernamePassword.check+json custom media type in the Content-type HTTP request header to identify the action.

The request body requires the username and password properties, which specify the user’s login credentials. In this workflow, if the usernamePassword.check action completes successfully, the flow proceeds to the next sign-on policy action. The flow status value of OTP_REQUIRED requires a one-time passcode (OTP) verification.

Headers

Content-Type      application/vnd.pingidentity.usernamePassword.check+json

Body

raw ( application/vnd.pingidentity.usernamePassword.check+json )

{
    "username": "{{appUsername}}",
    "password": "{{userPassword}}"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{authPath}}/{{envID}}/flows/{{flowID}}' \
--header 'Content-Type: application/vnd.pingidentity.usernamePassword.check+json' \
--data '{
    "username": "{{appUsername}}",
    "password": "{{userPassword}}"
}'
var options = new RestClientOptions("{{authPath}}/{{envID}}/flows/{{flowID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.usernamePassword.check+json");
var body = @"{" + "\n" +
@"    ""username"": ""{{appUsername}}""," + "\n" +
@"    ""password"": ""{{userPassword}}""" + "\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 := "{{authPath}}/{{envID}}/flows/{{flowID}}"
  method := "POST"

  payload := strings.NewReader(`{
    "username": "{{appUsername}}",
    "password": "{{userPassword}}"
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/vnd.pingidentity.usernamePassword.check+json")

  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 /{{envID}}/flows/{{flowID}} HTTP/1.1
Host: {{authPath}}
Content-Type: application/vnd.pingidentity.usernamePassword.check+json

{
    "username": "{{appUsername}}",
    "password": "{{userPassword}}"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.usernamePassword.check+json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"username\": \"{{appUsername}}\",\n    \"password\": \"{{userPassword}}\"\n}");
Request request = new Request.Builder()
  .url("{{authPath}}/{{envID}}/flows/{{flowID}}")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.usernamePassword.check+json")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{authPath}}/{{envID}}/flows/{{flowID}}",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.usernamePassword.check+json"
  },
  "data": JSON.stringify({
    "username": "{{appUsername}}",
    "password": "{{userPassword}}"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{authPath}}/{{envID}}/flows/{{flowID}}',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.usernamePassword.check+json'
  },
  body: JSON.stringify({
    "username": "{{appUsername}}",
    "password": "{{userPassword}}"
  })

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

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

payload = json.dumps({
  "username": "{{appUsername}}",
  "password": "{{userPassword}}"
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.usernamePassword.check+json'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{authPath}}/{{envID}}/flows/{{flowID}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.usernamePassword.check+json'
));
$request->setBody('{\n    "username": "{{appUsername}}",\n    "password": "{{userPassword}}"\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("{{authPath}}/{{envID}}/flows/{{flowID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.usernamePassword.check+json"
request.body = JSON.dump({
  "username": "{{appUsername}}",
  "password": "{{userPassword}}"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"username\": \"{{appUsername}}\",\n    \"password\": \"{{userPassword}}\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{authPath}}/{{envID}}/flows/{{flowID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.usernamePassword.check+json", forHTTPHeaderField: "Content-Type")

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

200 OK

{
    "_links": {
        "self": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/000c3af2-bbcc-4c20-b449-e24fbf32034d"
        }
    },
    "id": "000c3af2-bbcc-4c20-b449-e24fbf32034d",
    "session": {
        "id": "88ec52b8-a83b-4f8b-b800-84536b1bb786"
    },
    "resumeUrl": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as/resume?flowId=000c3af2-bbcc-4c20-b449-e24fbf32034d",
    "status": "COMPLETED",
    "createdAt": "2024-11-27T15:22:56.966Z",
    "expiresAt": "2024-11-27T15:44:39.894Z",
    "_embedded": {
        "user": {
            "id": "1dc0e711-d8e0-48a8-8a6d-2b4fc10532b7",
            "username": "id-token-app_user_1732720932",
            "name": {
                "given": "Test",
                "family": "ApplicationUser"
            }
        },
        "application": {
            "name": "ID_Token-App_1732720845"
        }
    }
}