signUpWithPasskey()

Signs up a user using a passkey, creating a new sub-organization and session.

This function creates a new passkey authenticator and uses it to register a new sub-organization for the user.
Handles both passkey creation and sub-organization creation in a single flow.
Optionally accepts additional sub-organization parameters, a custom session key, a custom passkey display name, and a custom session expiration.
Automatically generates a new API key pair for authentication and session management.
Stores the resulting session token and manages cleanup of unused key pairs.

Package: core

Defined in: core.ts:410

params

object

Show params details

params.challenge

string

challenge string to use for passkey registration. If not provided, a new challenge will be generated.

params.createSubOrgParams

CreateSubOrgParams

parameters for creating a sub-organization (e.g., authenticators, user metadata).

params.expirationSeconds

string

session expiration time in seconds (defaults to the configured default).

params.passkeyDisplayName

string

display name for the passkey (defaults to a generated name based on the current timestamp).

params.sessionKey

string

session key to use for storing the session (defaults to the default session key).

A successful response returns the following fields:

returns

PasskeyAuthResult

required

A promise that resolves to a PasskeyAuthResult, which includes: