Skip to content

Commit bf083ad

Browse files
docs: add Expo callback URL format to README (#1522)
1 parent f6f2690 commit bf083ad

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,39 @@ https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
303303

304304
> Replace `{PRODUCT_BUNDLE_IDENTIFIER}` and `{YOUR_AUTH0_DOMAIN}` with your actual product bundle identifier and Auth0 domain. Ensure that {PRODUCT_BUNDLE_IDENTIFIER} is all lowercase.
305305
306+
#### Expo
307+
308+
When using Expo, the callback URL format depends on whether you provide a `customScheme` in your `app.json` plugin configuration.
309+
310+
##### With `customScheme`
311+
312+
If you set a `customScheme` (e.g., `"auth0sample"`) in your `app.json`:
313+
314+
```text
315+
{YOUR_CUSTOM_SCHEME}://{YOUR_AUTH0_DOMAIN}/ios/{BUNDLE_IDENTIFIER}/callback,
316+
{YOUR_CUSTOM_SCHEME}://{YOUR_AUTH0_DOMAIN}/android/{PACKAGE_NAME}/callback
317+
```
318+
319+
**Example:** If your custom scheme is `auth0sample`, your Auth0 domain is `example.us.auth0.com`, your iOS bundle identifier is `com.example.myapp`, and your Android package name is `com.example.myapp`:
320+
321+
```text
322+
auth0sample://example.us.auth0.com/ios/com.example.myapp/callback,
323+
auth0sample://example.us.auth0.com/android/com.example.myapp/callback
324+
```
325+
326+
> **Note:** The URL scheme uses `customScheme`, but the path always contains the bundle identifier (iOS) or package name (Android), **not** the custom scheme.
327+
328+
##### Without `customScheme`
329+
330+
If you do not provide a `customScheme`, the SDK defaults to `{BUNDLE_IDENTIFIER}.auth0` / `{PACKAGE_NAME}.auth0`:
331+
332+
```text
333+
{BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{BUNDLE_IDENTIFIER}/callback,
334+
{PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{PACKAGE_NAME}/callback
335+
```
336+
337+
> All values must be **lowercase** with **no trailing slash**.
338+
306339
#### Configure an associated domain for iOS
307340

308341
> [!IMPORTANT]

0 commit comments

Comments
 (0)