Get user passkeys

Returns the WebAuthn registration options needed to register a new passkey.

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

Get user passkeys

cURL

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

200

{
  "attestation": "direct",
  "authenticatorSelection": {
    "authenticatorAttachment": "cross-platform",
    "requireResidentKey": true,
    "residentKey": "discouraged",
    "userVerification": "discouraged"
  },
  "challenge": "<string>",
  "excludeCredentials": [
    {
      "id": "<string>",
      "type": "public-key",
      "transports": [
        "usb"
      ]
    }
  ],
  "pubKeyCredParams": [
    {
      "alg": 123,
      "type": "public-key"
    }
  ],
  "rp": {
    "id": "<string>",
    "name": "<string>"
  },
  "timeout": 123,
  "user": {
    "displayName": "<string>",
    "id": "<string>",
    "name": "<string>"
  },
  "extensions": {
    "appid": "<string>",
    "appidExclude": "<string>",
    "credProps": true,
    "uvm": true
  },
  "hints": [
    "<string>"
  ]
}

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"

Response

200

application/json

returns passkey registration options

attestation · enum<string> · required

Available options: direct, enterprise, indirect, none

authenticatorSelection · object · required

Show child attributes

challenge · string · required

Base64URL encoded challenge

excludeCredentials · object[] · required

List of credentials to exclude from registration

Show child attributes

pubKeyCredParams · object[] · required

List of acceptable public key credential parameters

Show child attributes

rp · object · required

Show child attributes

timeout · number · required

Timeout in milliseconds

user · object · required

Show child attributes

extensions · object

Show child attributes

hints · string[]

Optional hints for the authenticator