Skip to content

Commit a567dd2

Browse files
committed
Revise redirect URI API doc wording
1 parent 29a9916 commit a567dd2

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Sources/BrowserSignin/BrowserSignin.swift

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,15 @@ public enum BrowserSigninError: Error {
5151
///
5252
/// ## Redirect URI Support
5353
///
54-
/// This library supports both custom URIs and HTTPS redirect URLs on supporting platforms and versions. The use of an `https://` redirect URI is recommended, but this requires that [your application is configured to use associated domains](https://developer.apple.com/documentation/Xcode/supporting-associated-domains). This involves:
54+
/// This library supports both custom URIs and HTTPS redirect URLs on supporting platforms and versions. The use of an `https://` redirect URI is recommended, but this requires that [your application is configured to use associated domains](https://developer.apple.com/documentation/Xcode/supporting-associated-domains).
5555
///
56-
/// 1. Including the redirect URI's domain in your application's [Associated Domains capability](https://developer.apple.com/documentation/xcode/configuring-an-associated-domain) as a `webcredential`.
57-
/// 2. Ensuring the application identifier (i.e. `<TEAM_ID>.<BUNDLE_ID>`) is included in the `webcredentials` list on that domain's `/.well-known/apple-app-site-association` well-known URI. For more information on how to update this in your Okta OAuth2 client configuration, see the [Customize associated domains developer guide ](https://developer.okta.com/docs/guides/custom-well-known-uri/main/) document for more details.
58-
/// 3. Change the `redirect_uri` value used in your client configuration to the `https` URL configured within your OAuth2 client configuration.
56+
/// Ensure that you do the following:
5957
///
60-
/// > Note: The use of HTTPS addresses within the redirect callback URI is limited by the availability of support within ASWebAuthenticationSession, which currently requires a minimum of iOS 17.4, macOS 14.4, watchOS 10.4, tvOS 17.4, or visionOS 1.1.
58+
/// * Include the domain of the redirect URI as a `webcredential` in your app's [associated domains capability](https://developer.apple.com/documentation/xcode/configuring-an-associated-domain).
59+
/// * Ensure that the app identifier (that is, the `<TEAM_ID>.<BUNDLE_ID>`) is included in the `webcredentials` list on that domain's `/.well-known/apple-app-site-association` well-known URI. See [Customize associated domains developer guide ](https://developer.okta.com/docs/guides/custom-well-known-uri/main/) to update `webcredentials` in your Okta OAuth2 client configuration.
60+
/// * Change the `redirect_uri` value used in your client configuration to the `https` URL configured within your OAuth2 client configuration.
61+
///
62+
/// > Note: The use of HTTPS addresses within the redirect callback URI is limited by the availability of support within ASWebAuthenticationSession. The session requires a minimum of iOS v17.4, macOS v14.4, watchOS v10.4, tvOS v17.4, or visionOS v1.1.
6163
@MainActor
6264
public final class BrowserSignin {
6365
#if os(macOS)

0 commit comments

Comments
 (0)