Skip to content

Commit ad6d05c

Browse files
docs: sync documentation with current API (automated) (#1639)
## Summary Automated documentation drift fix. 2 findings addressed (1 P1 · 1 P2). ## Changes - `EXAMPLES.md` — fixed wrong variable `voiceEnrollment` → `emailEnrollment` in the "Enrolling Email" MFA section (P1: `ReferenceError` if copy-pasted without the voice section) - `EXAMPLES.md` — upgraded inline `exchangeToken()` deprecation comment to a visible Markdown callout (P2: deprecated since v2.14.0 with no visible notice) <details> <summary>Full Drift Report</summary> | # | Severity | File | Line | Issue | |---|---|---|---|---| | 1 | P1 | `EXAMPLES.md` | 1308 | Wrong variable `voiceEnrollment.oobCode` in Enrolling Email section — should be `emailEnrollment.oobCode` | | 2 | P2 | `EXAMPLES.md` | 525 | `exchangeToken()` deprecated in v2.14.0 but no visible callout block | </details> --- 🤖 Generated with [syncing-docs](https://github.com/atko-cic/claude-marketplace) skill <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a clear deprecation notice for `exchangeToken()`, with guidance to use `loginWithCustomTokenExchange()` instead. * **Bug Fixes** * Corrected the Email MFA enrollment example so it uses the proper enrollment data and removes an incorrect line. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 864593c commit ad6d05c

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

EXAMPLES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,8 @@ async function performTokenExchange() {
676676
// Note: exchangeToken() is deprecated - use loginWithCustomTokenExchange() instead
677677
```
678678

679+
> ⚠️ **Deprecated**`exchangeToken()` will be removed in the next major version. Use `loginWithCustomTokenExchange()` instead.
680+
679681
### Required Auth0 Configuration
680682

681683
1. **Create Token Exchange Profile** in Auth0 Dashboard:
@@ -1456,9 +1458,7 @@ const emailEnrollment = await auth0.mfa.enroll({
14561458
email: 'user@example.com'
14571459
});
14581460

1459-
const oobCode = voiceEnrollment.oobCode; // Use this code to complete enrollment verification
1460-
1461-
// Use this code to complete enrollment verification
1461+
const oobCode = emailEnrollment.oobCode; // Use this code to complete enrollment verification
14621462
```
14631463

14641464
#### Enrolling Push Notification

0 commit comments

Comments
 (0)