Skip to main content
POST
/
webauthn
/
login
/
initialize
Initialize WebAuthn login
curl --request POST \
  --url https://{tenant_id}.hanko.io/webauthn/login/initialize \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"
}
'
import requests

url = "https://{tenant_id}.hanko.io/webauthn/login/initialize"

payload = { "user_id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({user_id: 'c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c'})
};

fetch('https://{tenant_id}.hanko.io/webauthn/login/initialize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant_id}.hanko.io/webauthn/login/initialize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => 'c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://{tenant_id}.hanko.io/webauthn/login/initialize"

	payload := strings.NewReader("{\n  \"user_id\": \"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{tenant_id}.hanko.io/webauthn/login/initialize")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{tenant_id}.hanko.io/webauthn/login/initialize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c\"\n}"

response = http.request(request)
puts response.read_body
{
  "publicKey": {
    "challenge": "qgOI+0KpGnl9NOqaT6dfsYvi96R87LgpErnvePeOgSU=",
    "timeout": 60000,
    "rpId": "localhost",
    "allowCredentials": [
      {
        "type": "public-key",
        "id": "Mepptysj5ZZrTlg0qiLbsZ068OtQMeGVAikVy2n1hvvG..."
      }
    ],
    "userVerification": "required"
  }
}
Deprecated. Please use the Flow API instead. What’s the Flow API?.
Returns a JSON representation of CredentialRequestOptions for use with the Webauthn API’s navigator.credentials.get(). Omitting the optional request body or using an empty JSON object results in generation of request options for a login using a discoverable credential (i.e. they will not contain allowCredentials).
The Webauthn API uses binary data represented by ArrayBuffers for certain input/output values. The Hanko API returns these values as base64url-encoded, so they must be converted to ArrayBuffers when passed to the Webauthn API. Similarly, Webauthn API output must be converted to base64url-encoded values when passed to the Hanko API (e.g. using the webauthn-json library).

Body

application/json
​
user_id
string<uuid4>

The ID of the user on whose behalf WebAuthn login should be performed

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

Response

Successful initialization

Options for assertion generation with the WebAuthn API

​
publicKey
object