Recommended: JavaScript SDK with React Hooks
For new React apps, we recommend the JavaScript SDK with React Hooks (
@dynamic-labs-sdk/react-hooks) instead of the legacy React SDK documented here. The JS SDK comes with many benefits such as a much smaller bundle size and other optimizations. Use the React quickstart (JavaScript SDK) to get started.Summary
This hook provides a way for clients to authenticate with MFA using a passkey. The hook needs to be initialized within a child of DynamicContextProvider.Usage
Available methods:authenticatePasskeyMFA: Authenticate with MFA using a passkey. Optionally accepts a named parameters object:{ createMfaToken?: boolean, relatedOriginRpId?: string }.
Usage
Optional parameters
relatedOriginRpId(optional): The Relying Party ID (RP ID) to use when authenticating from a related origin (for example, a sibling subdomain of the domain where the passkey was registered). The canonical form is a bare hostname such asmy.example.com; a full origin likehttps://my.example.comis also accepted and resolves to the same RP ID. It must match therpIdthe credential was registered under. See Related Origin Requests for how sibling origins are authorized.