PingOne Platform APIs

Sign On with Kerberos

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

The POST /{{envID}}/flows/{{flowID}}/kerberos operation initiates an action to allow users to sign on using Kerberos authentication. This operation uses the application/vnd.pingidentity.kerberos.lookup+json custom media type as the content type in the request header.

Prerequisites

The flow response will then include the kerberos.authenticate action.

Headers

Authorization      Negotiate {{kerberosToken}}

Content-Type      application/vnd.pingidentity.kerberos.authenticate+json

Body

raw ( application/vnd.pingidentity.kerberos.authenticate+json )

{}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

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

  payload := strings.NewReader(`{}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Negotiate {{kerberosToken}}")
  req.Header.Add("Content-Type", "application/vnd.pingidentity.kerberos.authenticate+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}}/kerberos HTTP/1.1
Host: {{authPath}}
Authorization: Negotiate {{kerberosToken}}
Content-Type: application/vnd.pingidentity.kerberos.authenticate+json

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

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{authPath}}/{{envID}}/flows/{{flowID}}/kerberos',
  'headers': {
    'Authorization': 'Negotiate {{kerberosToken}}',
    'Content-Type': 'application/vnd.pingidentity.kerberos.authenticate+json'
  },
  body: JSON.stringify({})

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

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

payload = json.dumps({})
headers = {
  'Authorization': 'Negotiate {{kerberosToken}}',
  'Content-Type': 'application/vnd.pingidentity.kerberos.authenticate+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}}/kerberos');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Negotiate {{kerberosToken}}',
  'Content-Type' => 'application/vnd.pingidentity.kerberos.authenticate+json'
));
$request->setBody('{}');
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}}/kerberos")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Negotiate {{kerberosToken}}"
request["Content-Type"] = "application/vnd.pingidentity.kerberos.authenticate+json"
request.body = JSON.dump({})

response = http.request(request)
puts response.read_body
let parameters = "{}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{authPath}}/{{envID}}/flows/{{flowID}}/kerberos")!,timeoutInterval: Double.infinity)
request.addValue("Negotiate {{kerberosToken}}", forHTTPHeaderField: "Authorization")
request.addValue("application/vnd.pingidentity.kerberos.authenticate+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-test.pingone.com/f00666c0-1ba2-4a37-a3f8-0157450ef0ac/flows/000daea9-2ffe-441c-ab5e-09ea2de2b9c7"
    }
  },
  "id" : "000daea9-2ffe-441c-ab5e-09ea2de2b9c7",
  "session" : {
    "id" : "0a2bb1fa-7ff9-49a8-a6ee-cb4def00f500"
  },
  "resumeUrl" : "https://auth-test.pingone.com/f00666c0-1ba2-4a37-a3f8-0157450ef0ac/as/resume?flowId=000daea9-2ffe-441c-ab5e-09ea2de2b9c7",
  "status" : "COMPLETED",
  "createdAt" : "2022-07-06T17:16:59.999Z",
  "expiresAt" : "2022-07-06T17:32:10.095Z",
  "_embedded" : {
    "user" : {
      "id" : "fbab3528-c376-492d-9174-e1e5e788c973",
      "username" : "efudd",
      "name" : {
        "formatted" : "Elmer Fudd",
        "given" : "Elmer",
        "family" : "Fudd"
      }
    },
    "application" : {
      "name" : "PingOne Self-Service - MyAccount",
      "icon" : {
        "id" : "a3d073bc-3108-49ad-b96c-404bea59a1d0",
        "href" : "https://assets.pingone.com/ux/ui-library/4.18.0/images/logo-pingidentity.png"
      }
    }
  }
}