Kanorio
Kanorio 開發者

API 參考

Passkeys

Customer API: GET /passkeys, POST /passkeys/register/options, POST /passkeys/register, …

這頁只有英文版。API 參考、Webhook 事件與變更紀錄維持英文，和程式碼裡的欄位名稱、錯誤碼一致。
Base URL https://{site}/api/v1/customerErrorsPagination

List the customer's passkeys

GET/passkeys
beta

Response 200

  • passkeysobject[]required
  • passkeys[].idstringrequired
  • passkeys[].namestringrequired
  • passkeys[].backedUpbooleanrequired
  • passkeys[].createdAtstringrequired
  • passkeys[].lastUsedAtstring | nullrequired
  • passkeys[].stalebooleanrequired

    Bound to a previous primary domain; no longer usable on this site.

curl -X GET "https://{site}/api/v1/customer/passkeys" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"

Get WebAuthn creation options to add a passkey

POST/passkeys/register/options
beta

Request body

  • originstring

    Origin the WebAuthn ceremony runs on. Only `localhost` origins are honoured; production always uses the site's primary domain.

Response 200

  • optionsobjectrequired

    `PublicKeyCredentialCreationOptionsJSON` for `navigator.credentials.create()`.

Errors

  • METHOD_DISABLED 422
  • LIMIT_REACHED 403
  • RATE_LIMITED 429
curl -X POST "https://{site}/api/v1/customer/passkeys/register/options" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Verify a WebAuthn registration and save the passkey

POST/passkeys/register
beta

Request body

  • responseobjectrequired

    `RegistrationResponseJSON` from the browser.

  • namestring

    Label shown to the customer; defaults to the device and browser.

Response 200

  • passkeyobjectrequired
  • passkey.idstringrequired
  • passkey.namestringrequired
  • passkey.backedUpbooleanrequired
  • passkey.createdAtstringrequired
  • passkey.lastUsedAtstring | nullrequired
  • passkey.stalebooleanrequired

    Bound to a previous primary domain; no longer usable on this site.

Errors

  • VERIFY_FAILED 422
  • CHALLENGE_EXPIRED 422
  • ALREADY_REGISTERED 422
  • LIMIT_REACHED 403
curl -X POST "https://{site}/api/v1/customer/passkeys/register" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Remove one of the customer's passkeys

DELETE/passkeys/{id}
beta

Parameters

  • idstring · pathrequired

Errors

  • NOT_FOUND 404
curl -X DELETE "https://{site}/api/v1/customer/passkeys/{id}" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"