CLASS

WebAuthnRegistrationClientOperationActionModel

Contents

• Properties
  • arguments
  • platformOptions
  • crossPlatformOptions
  • fallbackActions
• Methods
  • init(from:)
  • encode(to:)

public final class WebAuthnRegistrationClientOperationActionModel: ClientOperationActionModel

Represents the model for the WebAuthn registration client operation, which instructs a client that WebAuthn needs to be used to continue the flow. The client should guide the user in registering a new device or security-key, according to the options defined by this model. Authentication Services native APIs provide support for both platform and cross-platform authenticators, thus the model provides configuration for each separately. Depending on the server response, this model will provide configuration for either one or both. When both configurations are present, the user should be presented with a choice. When Passkeys mode is configured on the server, the configuration is provided via the platformJson property. PassKeys support is provided by the ASAuthorizationPlatformPublicKeyCredentialProvider native APIs.

• Note: Starting from iOS 15, WebAuthn can be used with the Authentication Services ASAuthorizationPublicKey APIs (native) but it is also possible to use the fallbackActions(web browser). Below iOS 15, fallbackActions (web browser) is the only way to handle WebAuthn.

Properties

arguments

public let arguments: [String: Any]

JSON representation of the client operation arguments.

platformOptions

public var platformOptions: PlatformCredentialRequestOptions?

Platform attachment PublicKey options.

crossPlatformOptions

public var crossPlatformOptions: CrossPlatformCredentialRequestOptions?

CrossPlatform attachment PublicKey options.

fallbackActions

public var fallbackActions: [Action]

Returns the actions that should be triggered when WebAuthnhandling fails or is impossible to use with the native APIs.

Methods

init(from:)

public required init(from decoder: Decoder) throws

encode(to:)

override public func encode(to encoder: Encoder) throws