PingOne Platform APIs

Create OATH token (HOTP)

 

POST {{apiPath}}/environments/{{envID}}/oathTokens

This example uses the oathTokens endpoint to create a single HOTP token in the environment.

The body of the request includes the general properties for OATH tokens such as serialNumber and otpLength, and also uses the HOTP-specific setting, counter.

Request Model

Refer to OATH Tokens for the complete data models.

Property Type Required?

otpLength

Integer

Required

secret

String

Required

serialNumber

String

Required

hotp

Object

Optional

hotp.counter

Integer

Optional

type

String

Required

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "serialNumber": "2333734700388",
    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
    "type": "HOTP",
    "hotp": {
        "counter": 456789
    },
    "otpLength": 8
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/oathTokens' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "serialNumber": "2333734700388",
    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
    "type": "HOTP",
    "hotp": {
        "counter": 456789
    },
    "otpLength": 8
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/oathTokens")
{
  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" +
@"    ""serialNumber"": ""2333734700388""," + "\n" +
@"    ""secret"": ""6EBD59F71A800C48C4619CD33F6C385C9237C9BA""," + "\n" +
@"    ""type"": ""HOTP""," + "\n" +
@"    ""hotp"": {" + "\n" +
@"        ""counter"": 456789" + "\n" +
@"    }," + "\n" +
@"    ""otpLength"": 8" + "\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}}/oathTokens"
  method := "POST"

  payload := strings.NewReader(`{
    "serialNumber": "2333734700388",
    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
    "type": "HOTP",
    "hotp": {
        "counter": 456789
    },
    "otpLength": 8
}`)

  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}}/oathTokens HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "serialNumber": "2333734700388",
    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
    "type": "HOTP",
    "hotp": {
        "counter": 456789
    },
    "otpLength": 8
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"serialNumber\": \"2333734700388\",\n    \"secret\": \"6EBD59F71A800C48C4619CD33F6C385C9237C9BA\",\n    \"type\": \"HOTP\",\n    \"hotp\": {\n        \"counter\": 456789\n    },\n    \"otpLength\": 8\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/oathTokens")
  .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}}/oathTokens",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "serialNumber": "2333734700388",
    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
    "type": "HOTP",
    "hotp": {
      "counter": 456789
    },
    "otpLength": 8
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/oathTokens',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "serialNumber": "2333734700388",
    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
    "type": "HOTP",
    "hotp": {
      "counter": 456789
    },
    "otpLength": 8
  })

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

url = "{{apiPath}}/environments/{{envID}}/oathTokens"

payload = json.dumps({
  "serialNumber": "2333734700388",
  "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
  "type": "HOTP",
  "hotp": {
    "counter": 456789
  },
  "otpLength": 8
})
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}}/oathTokens');
$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    "serialNumber": "2333734700388",\n    "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",\n    "type": "HOTP",\n    "hotp": {\n        "counter": 456789\n    },\n    "otpLength": 8\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}}/oathTokens")

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({
  "serialNumber": "2333734700388",
  "secret": "6EBD59F71A800C48C4619CD33F6C385C9237C9BA",
  "type": "HOTP",
  "hotp": {
    "counter": 456789
  },
  "otpLength": 8
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"serialNumber\": \"2333734700388\",\n    \"secret\": \"6EBD59F71A800C48C4619CD33F6C385C9237C9BA\",\n    \"type\": \"HOTP\",\n    \"hotp\": {\n        \"counter\": 456789\n    },\n    \"otpLength\": 8\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/oathTokens")!,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.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/oathTokens/1817ef80-2636-45ac-8685-d440dc659f62"
        },
        "environment": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "1817ef80-2636-45ac-8685-d440dc659f62",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "serialNumber": "2333734700388",
    "type": "HOTP",
    "hotp": {
        "counter": 456789
    },
    "otpLength": 8,
    "hashAlgorithm": "HmacSHA1",
    "createdAt": "2024-12-02T12:10:41.616Z",
    "updatedAt": "2024-12-02T12:10:41.676Z"
}