Skip to content

Commit 60ce6d9

Browse files
committed
Link residentKey option to JavaDoc
1 parent 5b6eab0 commit 60ce6d9

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -420,8 +420,9 @@ Many passkey-capable authenticators also offer a credential sync mechanism
420420
to allow one passkey to be used on multiple devices.
421421

422422
Passkeys can be created by setting the
423-
link:https://www.w3.org/TR/webauthn-2/#dom-publickeycredentialcreationoptions-authenticatorselection[`authenticatorSelection`].link:https://www.w3.org/TR/webauthn-2/#dom-authenticatorselectioncriteria-residentkey[`residentKey`]
424-
option:
423+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.4.1/com/yubico/webauthn/StartRegistrationOptions.StartRegistrationOptionsBuilder.html#authenticatorSelection(com.yubico.webauthn.data.AuthenticatorSelectionCriteria)[`authenticatorSelection`].link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.4.1/com/yubico/webauthn/data/AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder.html#residentKey(com.yubico.webauthn.data.ResidentKeyRequirement)[`residentKey`]
424+
option to
425+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.4.1/com/yubico/webauthn/data/ResidentKeyRequirement.html#REQUIRED[`REQUIRED`]:
425426

426427
[source,java]
427428
----------
@@ -442,8 +443,11 @@ AssertionRequest request = rp.startAssertion(StartAssertionOptions.builder().bui
442443
----------
443444

444445
Some authenticators might create passkeys even if not required, and setting
445-
the `residentKey` option to `ResidentKeyRequirement.PREFERRED` will create a passkey
446-
if the authenticator supports it.
446+
the
447+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.4.1/com/yubico/webauthn/data/AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder.html#residentKey(com.yubico.webauthn.data.ResidentKeyRequirement)[`residentKey`]
448+
option to
449+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.4.1/com/yubico/webauthn/data/ResidentKeyRequirement.html#PREFERRED[`PREFERRED`]
450+
will create a passkey if the authenticator supports it.
447451
The
448452
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/2.4.1/com/yubico/webauthn/RegistrationResult.html#isDiscoverable()[`RegistrationResult.isDiscoverable()`]
449453
method can be used to determine whether the created credential is a passkey.

0 commit comments

Comments
 (0)