Add support for enrolling passkeys with My Account API [SDK-5543] #962

Widcket · 2025-05-23T19:16:43Z

All new/changed/fixed functionality is covered by tests (or N/A)
I have added documentation for all new/changed functionality (or N/A)

📋 Changes

This PR adds:

A new API client for the My Account API, including its own error type MyAccountError.
A sub-client for the authentication methods endpoints.
- A method for requesting a passkey enrollment challenge.
- A method for enrolling a newly created passkey.

The new API client was built in a more self-contained fashion, to make it easier to extract into its own package in the future. This required a bit of refactoring of the existing code.

🎯 Testing

Besides a full test suite, the changes were tested manually with Xcode 16.3 (16E140), using:

Simulator running iOS 18.4
iPhone 14 Pro Max running iOS 18.4

Widcket · 2025-05-23T19:18:11Z

Auth0/Auth0Error.swift

-}
-
-/// Generic representation of Auth0 API errors.
-public protocol Auth0APIError: Auth0Error {


This was moved into its own file.

Widcket · 2025-05-23T19:19:26Z

Auth0/AuthenticationError.swift

@@ -27,15 +27,9 @@ public struct AuthenticationError: Auth0APIError, @unchecked Sendable {
    /// HTTP status code of the response.
    public let statusCode: Int

-    /// The underlying `Error` value, if any. Defaults to `nil`.
-    public var cause: Error? {


This was moved into Auth0APIError.

Widcket · 2025-05-23T19:19:55Z

Auth0/AuthenticationError.swift

-    /// - [callIsActive](https://developer.apple.com/documentation/foundation/urlerror/2293147-callisactive)
-    ///
-    /// The underlying `URLError` is available in the ``Auth0Error/cause-9wuyi`` property.
-    public var isNetworkError: Bool {


This was moved into Auth0APIError, so it's available for all API error types, not just AuthenticationError.

Widcket · 2025-05-23T19:22:20Z

Auth0/Handlers.swift

@@ -1,77 +0,0 @@
-import Foundation


The contents of this file were moved to AuthenticationHandlers.swift. Since the internal Response type now makes use of Swift 6's typed throws, most handlers no longer need that last catch: callback(.failure(AuthenticationError(cause: error))).

Widcket · 2025-05-23T19:23:47Z

Auth0/Management.swift

                callback(.success(dictionary))
            } else {
                callback(.failure(ManagementError(from: response)))
            }
-        } catch let error as ManagementError {


Since the internal Response type now makes use of Swift 6's typed throws, these handlers no longer need that last catch: callback(.failure(ManagementError(cause: error))).

Widcket · 2025-05-23T19:24:21Z

Auth0/ManagementError.swift

@@ -23,14 +23,9 @@ public struct ManagementError: Auth0APIError, @unchecked Sendable {
    /// HTTP status code of the response.
    public let statusCode: Int

-    /// The underlying `Error` value, if any. Defaults to `nil`.
-    public var cause: Error? {


This was moved into Auth0APIError.

Widcket · 2025-05-23T19:27:20Z

Auth0Tests/CryptoExtensions.swift

-
-@testable import Auth0
-
-extension SecKey {


This was moved into Generators.swift.

…h0/Auth0.swift into feature/myaccount-passkey-enrollment

Widcket · 2025-05-23T19:37:21Z

Auth0/MyAccount/AuthenticationMethods/Auth0MyAccountAuthenticationMethods.swift

+    // MARK: - Passkey Enrollment
+
+    #if PASSKEYS_PLATFORM
+    @available(iOS 16.6, macOS 13.5, visionOS 1.0, *)


This is the implementation of the method that requests a passkey enrollment challenge.

Widcket · 2025-05-23T19:37:40Z

Auth0/MyAccount/AuthenticationMethods/Auth0MyAccountAuthenticationMethods.swift

+                       telemetry: self.telemetry)
+    }
+
+    @available(iOS 16.6, macOS 13.5, visionOS 1.0, *)


This is the implementation of the method that enrolls the new passkey.

Widcket · 2025-05-23T19:46:24Z

Auth0/Response.swift

 struct Response<E: Auth0APIError> {
    let data: Data?
    let response: HTTPURLResponse?
    let error: Error?

-    func result() throws -> Any? {
+    func result() throws(E) -> JSONResponse? {


This internal method is now using a typed throw.

Widcket · 2025-05-23T19:47:25Z

Auth0/SignupPasskey.swift


 @available(iOS 16.6, macOS 13.5, visionOS 1.0, *)
 extension ASAuthorizationPlatformPublicKeyCredentialRegistration: SignupPasskey {}
-
-@available(iOS 16.6, macOS 13.5, visionOS 1.0, *)
-extension ASAuthorizationPublicKeyCredentialAttachment {


This was moved into NewPasskey.swift, so it can be used by both the Authentication API client and the My Account API client.

Widcket · 2025-05-23T19:49:00Z

Auth0Tests/MyAccount/AuthenticationMethods/MyAccountAuthenticationMethodsSpec.swift

+        }
+
+        #if PASSKEYS_PLATFORM
+        if #available(iOS 16.6, macOS 13.5, visionOS 1.0, *) {


Here are the tests for:

The method for requesting an enrollment challenge

The method for enrolling a newly created passkey

Widcket · 2025-05-23T19:49:39Z

Auth0Tests/MyAccount/MyAccountErrorSpec.swift

+
+@testable import Auth0
+
+class MyAccountErrorSpec: QuickSpec {


Here are the tests for the new error type MyAccountError.

pmathew92 · 2025-05-29T05:17:48Z

Auth0/MyAccount/AuthenticationMethods/MyAccountAuthenticationMethods.swift

+    ///
+    /// ```swift
+    /// Auth0
+    ///     .myAccount(token: apiCredentials.accessToken)


wouldn't .myAccount(token:) return a new instance of MyAccount each time we invoke these api's ?
With the following enroll api ,now we will have two separate instances of MyAccount calling these individual apis. This might cause state management issue when these classes evolve in the future

Yes, that's deliberate, and in line with the existing clients in the SDK, for instance the Authentication API client, the Management API client (for users endpoints), and the Web Auth client.

Similarly, every time you call Auth0.myAccount().authenticationMethods you get a new instance of the authentication methods sub client.

Like with the existing clients, you can always store an instance in a constant or variable if needed.

pmathew92 · 2025-05-29T05:18:28Z

Auth0/MyAccount/AuthenticationMethods/MyAccountAuthenticationMethods.swift

+    ///
+    /// ```swift
+    /// Auth0
+    ///     .myAccount(token: apiCredentials.accessToken)


Same query as above

Answered in #962 (comment)

pmathew92

LGTM , just a minor query

Widcket added 21 commits May 14, 2025 17:28

Add initial implementation

182e263

Add unit tests for My Account client

7d25a5d

Update models

282fce3

Fix error messages

13dc56f

Fix date formatting

dc6f42f

Add URL extension

47b43bc

Fix error tests

0a2f0d8

Remove percent encoding from the authentication method id

d7d36bc

Add unit tests for MyAccountError

276ea00

Add unit tests for the models

101de65

Add remaining unit tests

67aa081

Add remaining API docs

7943f3f

Extract credential details into PasskeyCredential

08df1c4

Update API docs

a83fe22

WIP Fix Real Devices

483f2e5

Remove passkey files from tvOS and visionOS targets

8d680d5

Move isNetworkError to Auth0APIError

eb4f8be

Add reminaining documentation

e85e812

Update links in Documentation.md

7fe1055

Remove leftover test changes

441d28a

Document the required scopes

Loading
Loading status checks…

35cd94e

Widcket requested a review from a team as a code owner May 23, 2025 19:16

Widcket added review:large CH: Added labels May 23, 2025

Merge branch 'master' into feature/myaccount-passkey-enrollment

Loading
Loading status checks…

662b4c4

Widcket commented May 23, 2025

View reviewed changes

Auth0Tests/CryptoExtensions.swift

@testable import Auth0

extension SecKey {

Copy link

Contributor Author

Widcket May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was moved into Generators.swift.

Widcket added 3 commits May 23, 2025 20:32

Add missing PASSKEYS_PLATFORM check

5293ee9

Merge branch 'feature/myaccount-passkey-enrollment' of github.com:aut…

Loading
Loading status checks…

3f39f2c

…h0/Auth0.swift into feature/myaccount-passkey-enrollment

Remove unnecessary assertion

Loading
Loading status checks…

20c9f7b

Widcket commented May 23, 2025

View reviewed changes

Widcket added 10 commits May 23, 2025 20:54

Remove passkeys-specific tests from tvOS test target

Loading
Loading status checks…

59b4bdd

Add Mocks.swift to the tvOS target

Loading
Loading status checks…

1540c33

Guard MyAccountResult with WEB_AUTH_PLATFORM check

Loading
Loading status checks…

ec85d1f

Guard beUnsuccessful() with WEB_AUTH_PLATFORM check

Loading
Loading status checks…

1840d78

Adjust glob in Podspec

Loading
Loading status checks…

030b015

Revert WEB_AUTH_PLATFORM checks

Loading
Loading status checks…

18b5da5

Empty commit to trigger CI

Loading
Loading status checks…

90fc0bb

Empty commit to trigger CI

Loading
Loading status checks…

1fe59bb

Amend matcher description

Loading
Loading status checks…

ed323e5

Use bundle fot MyAccountSpec.self in test case

Loading
Loading status checks…

939da9d

pmathew92 reviewed May 29, 2025

View reviewed changes

pmathew92 approved these changes May 29, 2025

View reviewed changes

Widcket merged commit e120d73 into master May 29, 2025
12 of 13 checks passed

Widcket deleted the feature/myaccount-passkey-enrollment branch May 29, 2025 22:13

Widcket mentioned this pull request May 30, 2025

Release 2.13.0 #965

Merged

Add support for enrolling passkeys with My Account API [SDK-5543] #962

Add support for enrolling passkeys with My Account API [SDK-5543] #962

Conversation

Widcket commented May 23, 2025

📋 Changes

🎯 Testing

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Widcket May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Widcket May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Widcket May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Widcket May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmathew92 May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pmathew92 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Widcket May 23, 2025 •

edited

Loading

Widcket May 23, 2025 •

edited

Loading

Widcket May 23, 2025 •

edited

Loading

Widcket May 23, 2025 •

edited

Loading

pmathew92 May 29, 2025 •

edited

Loading

pmathew92 left a comment •

edited

Loading