WebAuthnRegistrationCallback

open class WebAuthnRegistrationCallback : WebAuthnCallback

extension WebAuthnRegistrationCallback: PlatformAuthenticatorRegistrationDelegate

extension WebAuthnRegistrationCallback: FRWebAuthnManagerDelegate

WebAuthnRegistrationCallback is a representation of AM’s WebAuthn Registration Node to generate WebAuthn attestation based on given credentials, and optionally set the WebAuthn outcome value in Node‘s designated HiddenValueCallback

Public properties

_type
_type value in Callback response
Declaration
Swift

public var _type: String
relyingPartyName
Relying Party Name value from Callback response
Declaration
Swift

public var relyingPartyName: String
attestationPreference
Attestation Preference enum value from authenticatorSelection attribute of Callback response
Declaration
Swift

public var attestationPreference: WAAttestationPreference
displayName
Display Name of the user from Callback response
Declaration
Swift

public var displayName: String
relyingPartyId
Relying Party Identifier value from Callback response
Declaration
Swift

public var relyingPartyId: String
userName
Username of the user from Callback response
Declaration
Swift

public var userName: String
userId
User Identifier value from Callback response
Declaration
Swift

public var userId: String
timeout
Timeout value from Callback response
Declaration
Swift

public var timeout: Int
excludeCredentials
Excluded credentials list of credential identifiers from Callback response
Declaration
Swift

public var excludeCredentials: [[UInt8]]
pubKeyCredParams
Public Key Credentials Parameters from Callback response
Declaration
Swift

public var pubKeyCredParams: [[String : Any]]
challenge
Challenge string value from Callback response
Declaration
Swift

public var challenge: String
userVerification
User Verification enum value from Callback response
Declaration
Swift

public var userVerification: WAUserVerification
requireResidentKey
Boolean indicator of Require Resident Key value from Callback response
Declaration
Swift

public var requireResidentKey: Bool
authenticatorAttachment
Authenticator Attachment option value from authenticatorSelection attribute of Callback response
Declaration
Swift

public var authenticatorAttachment: WAAuthenticatorAttachment
delegate
Delegation to perform required user interaction while generating assertion
Declaration
Swift

public weak var delegate: PlatformAuthenticatorRegistrationDelegate?

Lifecycle


                    
                    
                    init(json:)

Initializes WebAuthnRegistrationCallback from AM’s WebAuthn Registration Node JSON response

Throws

AuthErrorfor invalid Callback response

Declaration

Swift

public required init(json: [String : Any]) throws

Parameters


                                json

JSON response of Callback

Public methods


                    
                    
                    register(node:window:deviceName:usePasskeysIfAvailable:onSuccess:onError:)

Registers against AM’s WebAuthn Registration Node based on the JSON callback and WebAuthn’s properties within the Callback

Declaration

Swift

public func register(node: Node? = nil, window: UIWindow? = UIApplication.shared.windows.first, deviceName: String? = nil, usePasskeysIfAvailable: Bool = false, onSuccess: @escaping StringCompletionCallback, onError: @escaping ErrorCallback)

Parameters

`node`	Optional `Node` object to set WebAuthn value to the designated `HiddenValueCallback`
`window`	Optional `Window` set the presenting Window for the Apple Passkeys UI. If not set it will default to `UIApplication.shared.windows.first`
`deviceName`	Optional `Device Name` object to set Device Name value to the designated `HiddenValueCallback`
`usePasskeysIfAvailable`	Optional `usePasskeysIfAvailable` set this to enable Passkeys in supported devices (iOS 16+). Setting this to true will not affect older OSs
`onSuccess`	Completion callback for successful WebAuthn assertion outcome; note that the outcome will automatically be set to the designated `HiddenValueCallback`
`onError`	Error callback to notify any error thrown while generating WebAuthn assertion


                    
                    
                    excludeCredentialDescriptorConsent(consentCallback:)

Declaration

Swift

public func excludeCredentialDescriptorConsent(consentCallback: @escaping WebAuthnUserConsentCallback)


                    
                    
                    createNewCredentialConsent(keyName:rpName:rpId:userName:userDisplayName:consentCallback:)

Declaration

Swift

public func createNewCredentialConsent(keyName: String, rpName: String, rpId: String?, userName: String, userDisplayName: String, consentCallback: @escaping WebAuthnUserConsentCallback)

WebAuthnManagerDelegate

didFinishAuthorization()
Declaration
Swift

public func didFinishAuthorization()


                    
                    
                    didCompleteWithError(_:)

Declaration

Swift

public func didCompleteWithError(_ error: Error)

didCancelModalSheet()
Declaration
Swift

public func didCancelModalSheet()