Skip to main content
GET
/
sdk
/
{environmentId}
/
users
/
passkeys
/
authenticate
Get passkey authentication options
curl --request GET \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/passkeys/authenticate \
  --header 'Authorization: Bearer <token>'
{
  "challenge": "An example name",
  "timeout": 123,
  "rpId": "An example name",
  "allowCredentials": [
    {
      "id": "<string>",
      "transports": []
    }
  ],
  "extensions": {
    "appid": "<string>",
    "appidExclude": "<string>",
    "credProps": true,
    "uvm": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Related origin rp id

Response

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

​
extensions
object
​
hints
enum<string>
Available options:
hybrid,
security-key,
client-device