Skip to main content
Function Signature
Parameters
  • relyingParty: The relying party identifier for WebAuthn/passkey authentication. This is typically your application’s domain name (e.g., “portalhq.io”)
  • webAuthnHost: The WebAuthn host that will handle passkey operations. This should match your application’s authentication server.
Platform Availability
  • Requires iOS 16.0 or later
  • Uses the native passkey APIs introduced in iOS 16
Notes
  • Must be called before using passkey backup or recovery methods
  • The relying party should match your application’s domain name for security purposes
  • Should be used in conjunction with setPasskeyAuthenticationAnchor for complete setup
Example Usage
Implementation Flow
  1. Check iOS version compatibility
  2. Configure passkey settings using this method
  3. Set the authentication anchor using setPasskeyAuthenticationAnchor
  4. Use passkey-based backup or recovery methods
Security Considerations
  • The relying party identifier is crucial for security and should match your app’s domain
  • Passkeys provide a secure, phishing-resistant alternative to passwords
  • Each passkey is unique to the combination of user account, relying party, and device
Related Documentation For more information about passkey integration, see: