Skip to content

fix(DOCS-5494): remove unsupported custom prompt data fields from ACUL JS SDK docs #1172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BcnCarlos merged 6 commits into from
May 19, 2026
Merged

fix(DOCS-5494): remove unsupported custom prompt data fields from ACUL JS SDK docs #1172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d421892
fix(DOCS-5494): remove unsupported custom prompt data fields from ACU…
BcnCarlos May 13, 2026
ef6bc84
update
BcnCarlos May 13, 2026
c580974
update method
BcnCarlos May 18, 2026
b437593
Update options
BcnCarlos May 18, 2026
eebd0ca
update
BcnCarlos May 18, 2026
66a29cc
Remove empty Method Parameters sections from JS SDK screen docs
BcnCarlos May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 9 additions & 27 deletions main/docs/libraries/acul/js-sdk/Screens/classes/AcceptInvitation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,8 @@ import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
await acceptInvitationManager.acceptInvitation();
```

**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional data collected from the user.
</ParamField>
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='changeLanguage' type='Promise<void>'>

This method changes the display language of the Universal Login page.
Expand All @@ -97,25 +83,21 @@ acceptInvitationManager.changeLanguage({
**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options">
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
</ParamField>

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions">LanguageChangeOptions</a></span>}>

<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>
<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
</ParamField>
<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>

Expand Down
36 changes: 9 additions & 27 deletions main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblock.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,32 +74,27 @@ bruteForceProtectionUnblockManager.changeLanguage({
**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options">
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
</ParamField>

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions">LanguageChangeOptions</a></span>}>

<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>
<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
</ParamField>
<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>

This method retrieves the array of transaction errors from the context, or an empty array if none exist.

</ParamField>
***

<ParamField body='unblockAccount' type='Promise<void>'>

Expand All @@ -110,17 +105,4 @@ import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protec
const bruteForceProtectionUnblockManager = new BruteForceProtectionUnblock();
await bruteForceProtectionUnblockManager.unblockAccount();
```

**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional data collected from the user.
</ParamField>
</ParamField>

</Expandable>
</ParamField>
22 changes: 9 additions & 13 deletions ...cs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockFailure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,25 +74,21 @@ bruteForceProtectionUnblockFailureManager.changeLanguage({
**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options">
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
</ParamField>

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions">LanguageChangeOptions</a></span>}>

<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>
<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
</ParamField>
<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>

Expand Down
22 changes: 9 additions & 13 deletions ...cs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockSuccess.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,25 +74,21 @@ bruteForceProtectionUnblockSuccessManager.changeLanguage({
**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options">
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
</ParamField>

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions">LanguageChangeOptions</a></span>}>

<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>
<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
</ParamField>
<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>

Expand Down
50 changes: 9 additions & 41 deletions main/docs/libraries/acul/js-sdk/Screens/classes/Consent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,8 @@ import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.accept();
```

**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional data collected from the user.
</ParamField>
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='changeLanguage' type='Promise<void>'>

This method changes the display language of the Universal Login page.
Expand All @@ -97,25 +83,21 @@ consentManager.changeLanguage({
**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options">
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
</ParamField>

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions">LanguageChangeOptions</a></span>}>

<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>
<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
</ParamField>
<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='deny' type='Promise<void>'>

Expand All @@ -126,21 +108,7 @@ import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.deny();
```

**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional data collected from the user.
</ParamField>
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>

Expand Down
50 changes: 9 additions & 41 deletions main/docs/libraries/acul/js-sdk/Screens/classes/CustomizedConsent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,8 @@ import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent';
const customizedConsentManager = new CustomizedConsent();
await customizedConsentManager.accept();
```

**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional data collected from the user.
</ParamField>
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='changeLanguage' type='Promise<void>'>

This method changes the display language of the Universal Login page.
Expand All @@ -97,25 +83,21 @@ customizedConsentManager.changeLanguage({
**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options">
[LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
</ParamField>

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions">LanguageChangeOptions</a></span>}>

<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>
<ParamField body="language" type="string" required>
The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
</ParamField>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
</ParamField>
<ParamField body="persist?" type='"session"'>
When set to `'session'`, the selected language persists for the duration of the session.
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='deny' type='Promise<void>'>

Expand All @@ -126,21 +108,7 @@ import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent';
const customizedConsentManager = new CustomizedConsent();
await customizedConsentManager.deny();
```

**Method Parameters**

<Expandable title="Parameters">

<ParamField body="options" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>

<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
Additional data collected from the user.
</ParamField>
</ParamField>

</Expandable>
</ParamField>
***

<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>

Expand Down
Loading
Loading