Get passkey authentication options

Returns the WebAuthn authentication options for passkey verification.

GET /sdk/{environmentId}/users/passkeys/authenticate

Get passkey authentication options

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate', 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://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "challenge": "An example name",
  "timeout": 123,
  "rpId": "An example name",
  "allowCredentials": [
    {
      "id": "<string>",
      "transports": []
    }
  ],
  "extensions": {
    "appid": "<string>",
    "appidExclude": "<string>",
    "credProps": true,
    "uvm": true
  }
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

relatedOriginRpId · string

The Relying Party ID (rpID) to use as the passkey challenge rpID when authenticating from a related origin (Related Origin Requests). Must be a bare hostname such as example.com (no scheme, port, or path); a full origin like https://example.com is also accepted for convenience. When omitted, the rpID is derived from the request's Origin header.

Example:

"example.com"

Response

200

application/json

returns passkey authentication options

challenge · string · required

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

timeout · number

Timeout in milliseconds

rpId · string

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

userVerification · enum<string>

Available options: discouraged, preferred, required

allowCredentials · object[]

List of credentials the authenticator may use

Show child attributes

extensions · object

Show child attributes

hints · enum<string>

Available options: hybrid, security-key, client-device