LogoLogo
SupportGithubSign InGet Access
  • Introduction
  • GETTING STARTED
    • SDK Quick Start
    • API Quick Start
  • Guides
    • Web
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Web authentication methods
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Configure a custom subdomain
      • Eject a wallet
      • Using the EIP-1193 Provider
      • Legacy documentation
        • Back up a wallet
          • Backup Options
        • Recover a wallet
    • iOS
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Connect with WalletConnect
      • Build a WebView
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Manage ERC20 tokens
      • Eject a wallet
      • Legacy documentation
        • Back up a wallet
          • Backup Options
          • Passkey + Enclave Storage
        • Recover a wallet
      • Troubleshooting Tips
      • Feature Flags
    • Android
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Connect with WalletConnect
      • Build a WebView
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Eject a wallet
      • Legacy documentation
        • Back up a wallet
          • Backup Options
        • Recover a wallet
    • React Native
      • Create a wallet
      • Send tokens
      • Sign a transaction
      • Simulate a transaction
      • Back up a wallet
      • Recover a wallet
      • Cross-device sessions
      • Manage wallet lifecycle states
      • Connect with WalletConnect
      • Build a WebView
      • Perform swaps
      • Add custom signature hooks
      • MPC progress callbacks
      • Portal API methods
      • Eject a wallet
      • Legacy documentation
        • Back up a wallet
          • Backup Options
        • Recover a wallet
    • Enclave MPC API
      • Create a client
      • Create a wallet
      • Send tokens
      • Sign Ethereum transactions
      • Sign Solana transactions
      • Sign Tron transactions
      • Sign Stellar Transaction
      • Concurrent Transactions
      • Back up a wallet
      • Eject a wallet
  • Reference
    • iOS
      • createWallet
      • backupWallet
      • recoverWallet
      • ejectPrivateKeys
      • registerBackupMethod
      • setGDriveConfiguration
      • setPasskeyConfiguration
      • setPasskeyAuthenticationAnchor
      • setPassword
      • availableRecoveryMethods
      • doesWalletExist
      • isWalletBackedUp
      • isWalletOnDevice
      • isWalletRecoverable
      • getBalances
      • getAssets
      • getNftAssets
      • getTransactions
      • sendSol
      • evaluateTransaction
      • buildEip155Transaction
      • buildSolanaTransaction
      • getWalletCapabilities
    • Android
      • Reference Documentation
    • React Native
      • @portal-hq/core
      • Storage adapters
        • Cloud storage
          • @portal-hq/gdrive-storage
          • @portal-hq/icloud-storage
        • Mobile storage
          • @portal-hq/keychain
          • @portal-hq/mobile-key-values
    • Enclave MPC API
      • V1 endpoints
    • Client API
      • V3 endpoints
      • V1 endpoints
    • Custodian API
      • V3 endpoints
      • V1 endpoints
    • Swaps API
      • V3 endpoints
      • V1 endpoints
  • Resources
    • Flutter
      • iOS
      • Android
    • Error codes
      • Overview
      • MPC errors
      • Network errors
      • General errors
      • Encryption errors
      • Portal Connect errors
    • Portal's MPC architecture
    • Authentication and API Keys
    • Self-Managed Backups
    • Alert Webhooks
    • Wallet lifecycle
    • Backup options
      • Password/PIN
      • GDrive
      • iCloud
      • Passkey + Enclave
    • WalletConnect metadata
    • Advanced security scanning
    • Account abstraction
    • Security firewall
    • Eject
    • Security
    • Blockchain support
    • Chain ID formatting
    • Testnet faucets
    • Going to Production
    • Rate Limits
    • Multi-backup migration guide
    • Multi-wallet migration guides
      • Migrating from Android SDK v3.x.x to v4.x.x
      • Migrating from iOS SDK v3.0.x to v3.2.x
  • Support
    • Changelog
      • Android
      • iOS
      • React Native
      • Web
      • Past Releases
        • 2024 Releases
        • 2023 Releases
    • Celo Hackathon Hub
    • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. Reference
  2. iOS

setPasskeyAuthenticationAnchor

Sets the presentation anchor for passkey authentication dialogs. This method is required for configuring where the passkey UI components will be displayed in your application.

Function Signature

@available(iOS 16, *)
public func setPasskeyAuthenticationAnchor(
    _ anchor: ASPresentationAnchor
) throws

Parameters

  • anchor: The window anchor where passkey authentication UI will be presented. This is typically the main window of your application and should be of type ASPresentationAnchor (which UIWindow conforms to).

Platform Availability

  • Requires iOS 16.0 or later

  • Part of the native passkey implementation in iOS

Notes

  • Must be called before using passkey backup or recovery methods

  • Should be used in conjunction with setPasskeyConfiguration for complete setup

  • The anchor is used to present the system's native passkey authentication dialog

Example Usage

// Basic usage in UIKit
if #available(iOS 16, *) {
    do {
        // Set the authentication anchor using the main window
        try portal.setPasskeyAuthenticationAnchor(view.window!)
    } catch {
        print("Error setting passkey authentication anchor: \(error)")
    }
}

// Complete setup in UIViewController
class MyViewController: UIViewController {
    func setupPasskeys() {
        if #available(iOS 16, *) {
            do {
                // Configure passkey settings
                try portal.setPasskeyConfiguration(
                    relyingParty: "portalhq.io",
                    webAuthnHost: "backup.web.portalhq.io"
                )
                
                // Set the authentication anchor
                guard let window = view.window else {
                    print("Error: No window available")
                    return
                }
                try portal.setPasskeyAuthenticationAnchor(window)
                
                print("Passkey authentication setup complete")
            } catch {
                print("Error setting up passkey authentication: \(error)")
            }
        }
    }
}

// Usage in SwiftUI
import SwiftUI

struct PasskeyView: View {
    @Environment(\.window) var window: UIWindow?
    
    func setupPasskeyAuth() {
        if #available(iOS 16, *) {
            do {
                guard let window = window else {
                    print("Error: No window available")
                    return
                }
                try portal.setPasskeyAuthenticationAnchor(window)
            } catch {
                print("Error setting passkey authentication anchor: \(error)")
            }
        }
    }
    
    var body: some View {
        Text("Passkey Setup")
            .onAppear {
                setupPasskeyAuth()
            }
    }
}

Implementation Guide

  1. Ensure you're running on iOS 16 or later

  2. Call setPasskeyConfiguration first to set up basic passkey settings

  3. Obtain a reference to your app's main window or appropriate presentation context

  4. Call this method with the window reference

  5. Now you can use passkey-based authentication features

UI Considerations

  • The passkey dialog will be presented as a system modal over your application

  • The presentation anchor should be stable and available throughout the authentication process

  • For best user experience, call this method when your view hierarchy is fully established

Related Documentation

For more information about passkey, see:

PrevioussetPasskeyConfigurationNextsetPassword

Last updated 3 months ago

Was this helpful?

Passkey + Enclave Backup
Configuring an associated domain
Supporting associated domains
Passkey Configuration