Skip to content

TypeScript API / @laikacms/server/oauth2 / PasskeyOptions

Interface: PasskeyOptions ​

Passkey (WebAuthn) configuration options. Uses PasskeyCallbacks from the passkey module for storage operations.

Extends ​

Properties ​

authenticatorAttachment? ​

ts
optional authenticatorAttachment?: "platform" | "cross-platform";

Allowed authenticator types (default: both)

Inherited from ​

PasskeyConfig.authenticatorAttachment


callbacks ​

ts
callbacks: PasskeyCallbacks;

Callbacks for storage operations

Inherited from ​

PasskeyConfig.callbacks


challengeExpiration? ​

ts
optional challengeExpiration?: number;

Challenge expiration in seconds (default: 300 = 5 minutes)

Inherited from ​

PasskeyConfig.challengeExpiration


enabled ​

ts
enabled: boolean;

Enable passkey authentication


origin ​

ts
origin: string;

Origin for verification (e.g., 'https://example.com')

Inherited from ​

PasskeyConfig.origin


required? ​

ts
optional required?: boolean;

Require users to set up a passkey (forces enrollment if not configured)


residentKey? ​

ts
optional residentKey?: "required" | "preferred" | "discouraged";

Require resident key / discoverable credential (default: preferred)

Inherited from ​

PasskeyConfig.residentKey


rpId ​

ts
rpId: string;

Relying Party ID (usually the domain, e.g., 'example.com')

Inherited from ​

PasskeyConfig.rpId


rpName ​

ts
rpName: string;

Relying Party name (displayed to user)

Inherited from ​

PasskeyConfig.rpName


userVerification? ​

ts
optional userVerification?: "required" | "preferred" | "discouraged";

Require user verification (PIN/biometric) (default: true)

Inherited from ​

PasskeyConfig.userVerification

Released under the MIT License.