diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/AcceptInvitation.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/AcceptInvitation.mdx index 48be1dbda2..e17ed1ad43 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/AcceptInvitation.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/AcceptInvitation.mdx @@ -66,22 +66,8 @@ import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; const acceptInvitationManager = new AcceptInvitation(); await acceptInvitationManager.acceptInvitation(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method changes the display language of the Universal Login page. @@ -97,25 +83,21 @@ acceptInvitationManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblock.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblock.mdx index ff1523ecfa..97e173038a 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblock.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblock.mdx @@ -74,32 +74,27 @@ bruteForceProtectionUnblockManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -110,17 +105,4 @@ import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protec const bruteForceProtectionUnblockManager = new BruteForceProtectionUnblock(); await bruteForceProtectionUnblockManager.unblockAccount(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockFailure.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockFailure.mdx index 6364b2cb60..5ef0146446 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockFailure.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockFailure.mdx @@ -74,25 +74,21 @@ bruteForceProtectionUnblockFailureManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockSuccess.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockSuccess.mdx index 5d49e25212..26858ca2bb 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockSuccess.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/BruteForceProtectionUnblockSuccess.mdx @@ -74,25 +74,21 @@ bruteForceProtectionUnblockSuccessManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/Consent.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/Consent.mdx index 3f71c7e65b..57ae1f8fd4 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Consent.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Consent.mdx @@ -66,22 +66,8 @@ import Consent from '@auth0/auth0-acul-js/consent'; const consentManager = new Consent(); await consentManager.accept(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method changes the display language of the Universal Login page. @@ -97,25 +83,21 @@ consentManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -126,21 +108,7 @@ import Consent from '@auth0/auth0-acul-js/consent'; const consentManager = new Consent(); await consentManager.deny(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/CustomizedConsent.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/CustomizedConsent.mdx index 1a066a05cd..7cd92cd723 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/CustomizedConsent.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/CustomizedConsent.mdx @@ -66,22 +66,8 @@ import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; const customizedConsentManager = new CustomizedConsent(); await customizedConsentManager.accept(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method changes the display language of the Universal Login page. @@ -97,25 +83,21 @@ customizedConsentManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -126,21 +108,7 @@ import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; const customizedConsentManager = new CustomizedConsent(); await customizedConsentManager.deny(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivation.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivation.mdx index 12207786f4..ff9c6b1cd1 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivation.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivation.mdx @@ -72,25 +72,21 @@ deviceCodeActivationManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -105,21 +101,17 @@ await deviceCodeActivationManager.continue({ code: 'ABCD-1234' }); **Method Parameters** + + + [DeviceCodeActivationContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions). + -DeviceCodeActivationContinueOptions}> - - - The device code entered by the user. - - - - Additional data collected from the user. - + + The device code entered by the user. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx index 6f31243128..c45fa49205 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx @@ -71,25 +71,21 @@ deviceCodeActivationAllowedManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx index d22eabd9df..8dae5f390f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx @@ -71,25 +71,21 @@ deviceCodeActivationDeniedManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx index 58ebcfb4f9..4fb83cd631 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx @@ -66,22 +66,8 @@ import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmatio const deviceCodeConfirmationManager = new DeviceCodeConfirmation(); await deviceCodeConfirmationManager.cancel(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method changes the display language of the Universal Login page. @@ -97,25 +83,21 @@ deviceCodeConfirmationManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -126,21 +108,7 @@ import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmatio const deviceCodeConfirmationManager = new DeviceCodeConfirmation(); await deviceCodeConfirmationManager.confirm(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx index 491ac87ccb..12d12b4a06 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx @@ -72,32 +72,27 @@ emailIdentifierChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -108,22 +103,8 @@ import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-chal const emailIdentifierChallengeManager = new EmailIdentifierChallenge(); await emailIdentifierChallengeManager.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - ResendControl}> This method provides resend functionality with timeout management. It returns a [`ResendControl`](/docs/libraries/acul/js-sdk/Screens/interfaces/ResendControl) object with a `startResend()` method that triggers the resend and enforces a cooldown period before the user can resend again. @@ -140,25 +121,25 @@ await startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -169,22 +150,8 @@ import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-chal const emailIdentifierChallengeManager = new EmailIdentifierChallenge(); await emailIdentifierChallengeManager.returnToPrevious(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method submits the email verification code to complete the challenge. @@ -198,20 +165,17 @@ await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' } **Method Parameters** + + + [EmailChallengeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/EmailChallengeOptions). + -EmailChallengeOptions}> - - - The verification code sent to the user's email address. - - - - The CAPTCHA response token, if CAPTCHA is enabled for this tenant. - + + The verification code sent to the user's email address. + - - Additional data collected from the user. - + + The CAPTCHA response token, if CAPTCHA is enabled for this tenant. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/EmailOTPChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/EmailOTPChallenge.mdx index 28cb1625a5..5f9d9d9021 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/EmailOTPChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/EmailOTPChallenge.mdx @@ -72,32 +72,27 @@ emailOTPChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -108,22 +103,8 @@ import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; const emailOTPChallengeManager = new EmailOTPChallenge(); await emailOTPChallengeManager.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - ResendControl}> This method provides resend functionality with timeout management. It returns a [`ResendControl`](/docs/libraries/acul/js-sdk/Screens/interfaces/ResendControl) object with a `startResend()` method that triggers the resend and enforces a cooldown period before the user can resend again. @@ -140,25 +121,25 @@ await startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -173,16 +154,13 @@ await emailOTPChallengeManager.submitCode({ code: '123456' }); **Method Parameters** + + + [OtpCodeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/OtpCodeOptions). + -OtpCodeOptions}> - - - The OTP code that the user enters to submit. - - - - Additional data collected from the user. - + + The OTP code that the user enters to submit. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/EmailVerificationResult.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/EmailVerificationResult.mdx index b9724a0e9c..eb3fb44167 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/EmailVerificationResult.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/EmailVerificationResult.mdx @@ -72,25 +72,21 @@ emailVerificationResultManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/InterstitialCaptcha.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/InterstitialCaptcha.mdx index 688aef56e2..515512f363 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/InterstitialCaptcha.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/InterstitialCaptcha.mdx @@ -72,32 +72,27 @@ interstitialCaptchaManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -112,16 +107,13 @@ await interstitialCaptchaManager.submitCaptcha({ captcha: 'captchaValue' }); **Method Parameters** + + + [SubmitCaptchaOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitCaptchaOptions). + -SubmitCaptchaOptions}> - - - The CAPTCHA response token. - - - - Additional data collected from the user. - + + The CAPTCHA response token. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx index f6be06712d..322732a6d3 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx @@ -77,24 +77,24 @@ loginManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -112,20 +112,16 @@ loginManager.federatedLogin({ -FederatedLoginPayloadOptions}> - - - The social connection name to use. - + + [FederatedLoginPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions). + - - Additional data collected from the user. - + + The social connection name to use. -*** Error[]}> @@ -164,28 +160,28 @@ loginManager.login({ -LoginPayloadOptions}> + + [LoginPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LoginPayloadOptions). + - - The user's identifier. - + + The user's identifier. + - - The user's password. - + + The user's password. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -202,11 +198,12 @@ loginManager.pickCountryCode(); -CustomOptions}> + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx index 79ca006c76..af82b92484 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx @@ -76,24 +76,24 @@ loginEmailVerificationManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -111,20 +111,20 @@ loginEmailVerificationManager.continueWithCode({ -ContinueWithCodeOptions}> + + [ContinueWithCodeOptionPayload](/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload). + - - The verification code sent to the user's email. - + + The verification code sent to the user's email. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** Error[]}> @@ -148,16 +148,16 @@ loginEmailVerificationManager.resendCode(); -CustomOptions}> + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** ResendControl}> @@ -185,19 +185,20 @@ startResend(); -StartResendOptions}> + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx index 2e4f5a74f9..ba352c695c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx @@ -74,24 +74,24 @@ loginIdManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -109,24 +109,21 @@ loginIdManager.federatedLogin({ -FederatedLoginPayloadOptions}> - - - The social connection name to use. - + + [FederatedLoginPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions). + - - Additional data collected from the user. - + + The social connection name to use. -*** + Error[]}> -This method retrieves the array of transaction errors from the context, or an empty array if none exist. +This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context. @@ -143,7 +140,6 @@ loginIdManager.getLoginIdentifiers(); - This method prompts the user to provide their username. @@ -160,24 +156,25 @@ loginIdManager.login({ -LoginOptions}> + + [LoginOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LoginOptions). + - - The user's identifier. - + + The user's identifier. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** + @@ -193,16 +190,17 @@ loginIdManager.passkeyLogin(); -CustomOptions}> + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** + @@ -218,16 +216,17 @@ loginIdManager.pickCountryCode(); -CustomOptions}> + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** + @@ -247,10 +246,10 @@ initializeLogin().catch(console.error); **Method Parameters** - -string registerPasskeyAutofill}> + + Optional ID of the username `` element (without `#`). Example: `"username"`. If omitted, the developer must manually ensure the correct `autocomplete` attributes are set on the input element. - + \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx index fc135ee3f0..3acc9a038a 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx @@ -77,24 +77,24 @@ loginPasswordManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -112,20 +112,16 @@ loginPasswordManager.federatedLogin({ -FederatedLoginPayloadOptions}> - - - The social connection name to use. - + + [FederatedLoginPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions). + - - Additional data collected from the user. - + + The social connection name to use. -*** Error[]}> @@ -152,28 +148,28 @@ loginPasswordManager.login({ -LoginPayloadOptions}> + + [LoginPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LoginPayloadOptions). + - - The user's identifier. - + + The user's identifier. + - - The user's password. - + + The user's password. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -191,15 +187,16 @@ loginPasswordManager.switchConnection({ -SwitchConnectionOptions}> + + [SwitchConnectionOptionsLoginPassword](/docs/libraries/acul/js-sdk/Screens/interfaces/SwitchConnectionOptionsLoginPassword). + - - The connection name to switch to. Use `'email'` or `'sms'` for passwordless, or a DB connection name for password-based authentication. - + + The connection name to switch to. Use `'email'` or `'sms'` for passwordless, or a DB connection name for password-based authentication. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx index d248cc8eca..3cfd3277df 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx @@ -76,24 +76,24 @@ loginPasswordlessEmailCodeManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** Error[]}> @@ -116,16 +116,16 @@ loginPasswordlessEmailCodeManager.resendCode(); -CustomOptions}> + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** ResendControl}> @@ -153,24 +153,24 @@ startResend(); -StartResendOptions}> + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -188,24 +188,24 @@ loginPasswordlessEmailCodeManager.submitCode({ -SubmitCodeOptions}> + + [SubmitCodeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitCodeOptions). + - - The code entered by the user. - + + The code entered by the user. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -223,15 +223,16 @@ loginPasswordlessEmailCodeManager.switchConnection({ -SwitchConnectionOptionsEmailCode}> + + [SwitchConnectionOptionsEmailCode](/docs/libraries/acul/js-sdk/Screens/interfaces/SwitchConnectionOptionsEmailCode). + - - The connection name to switch to. Use `'email'` or `'sms'` for passwordless, or a DB connection name for password-based authentication. - + + The connection name to switch to. Use `'email'` or `'sms'` for passwordless, or a DB connection name for password-based authentication. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx index b862d59677..7c0c9c004d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx @@ -1,6 +1,6 @@ --- title: "LoginPasswordlessSmsOtp" -description: "Describes all the properties and methods available to customize the Universal Login `login-passwordless-sms-otp screen." +description: "Describes all the properties and methods available to customize the Universal Login `login-passwordless-sms-otp` screen." --- The LoginPasswordlessSmsOtp class implements the `login-passwordless-sms-otp` screen functionality. This screen collects the user's phone number and code. @@ -76,24 +76,24 @@ loginPasswordlessSmsOtpManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** Error[]}> @@ -128,24 +128,24 @@ startResend(); -StartResendOptions}> + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -161,16 +161,16 @@ loginPasswordlessSmsOtpManager.resendOTP(); -CustomOptions}> + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -188,28 +188,28 @@ loginPasswordlessSmsOtpManager.submitOTP({ -SubmitOTPOptions}> + + [SubmitOTPOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitOTPOptions). + - - The code entered by the user. - + + The code entered by the user. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - The user's identifier. - + + The user's identifier. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -227,15 +227,16 @@ loginPasswordlessSmsOtpManager.switchConnection({ -SwitchConnectionOptionsSmsOtp}> + + [SwitchConnectionOptionsSmsOtp](/docs/libraries/acul/js-sdk/Screens/interfaces/SwitchConnectionOptionsSmsOtp). + - - The connection name to switch to. Use `'email'` or `'sms'` for passwordless, or a DB connection name for password-based authentication. - + + The connection name to switch to. Use `'email'` or `'sms'` for passwordless, or a DB connection name for password-based authentication. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/Logout.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/Logout.mdx index ab57c6cd4a..972dc9731b 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Logout.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Logout.mdx @@ -75,24 +75,20 @@ logoutManager.changeLanguage({ -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -110,20 +106,16 @@ logoutManager.confirmLogout({ -ConfirmLogoutOptions}> - - - The authentication transaction state. - + + [ConfirmLogoutOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ConfirmLogoutOptions). + - - Additional data collected from the user. - + + The authentication transaction state. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutAborted.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutAborted.mdx index 7befd03662..d410dce14f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutAborted.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutAborted.mdx @@ -76,24 +76,20 @@ logoutAbortedManager.changeLanguage({ -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutComplete.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutComplete.mdx index ef6d9801db..b77927b8c0 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutComplete.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LogoutComplete.mdx @@ -75,24 +75,20 @@ logoutCompleteManager.changeLanguage({ -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx index caa88d7534..4da63903d2 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx @@ -74,25 +74,21 @@ mfaBeginEnrollOptions.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -110,21 +106,17 @@ await mfaBeginEnrollOptions.enroll({ **Method Parameters** + + + [MfaEnrollOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaEnrollOptions). + -MfaEnrollOptions} required> - - - The action indicating which factor to enroll. - - - - Additional data collected from the user. - + + The action indicating which factor to enroll. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaCountryCodes.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaCountryCodes.mdx index 70fb8243bb..361dde5870 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaCountryCodes.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaCountryCodes.mdx @@ -76,25 +76,21 @@ mfaCountryCodes.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -111,21 +107,7 @@ import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; const mfaCountryCodes = new MfaCountryCodes(); await mfaCountryCodes.goBack(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -144,20 +126,17 @@ await mfaCountryCodes.selectCountryCode({ **Method Parameters** + + + [SelectCountryCodeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SelectCountryCodeOptions). + -SelectCountryCodeOptions} required> - - - The country code (for example, `'US'`, `'GB'`). - - - - The phone prefix (for example, `'+1'`, `'+44'`). - + + The country code (for example, `'US'`, `'GB'`). + - - Additional data collected from the user. - + + The phone prefix (for example, `'+1'`, `'+44'`). diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx index e29835c447..ff9b190b2a 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx @@ -72,25 +72,21 @@ mfaDetectBrowserCapabilities.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -101,21 +97,7 @@ import MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browse const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); await mfaDetectBrowserCapabilities.detectCapabilities(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailChallenge.mdx index 25073a78f5..e919987b86 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailChallenge.mdx @@ -76,25 +76,21 @@ mfaEmailChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -113,25 +109,21 @@ await mfaEmailChallenge.continue({ **Method Parameters** + + + [ContinuePayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ContinuePayloadOptions). + -ContinuePayloadOptions} required> - - - The code entered by the user. - - - - Indicates whether to remember the device. - + + The code entered by the user. + - - Additional data collected from the user. - + + Indicates whether to remember the device. -*** Error[]}> @@ -149,21 +141,7 @@ import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; const mfaEmailChallenge = new MfaEmailChallenge(); await mfaEmailChallenge.pickEmail(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -174,21 +152,7 @@ import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; const mfaEmailChallenge = new MfaEmailChallenge(); await mfaEmailChallenge.resendCode(); ``` - -**Method Parameters** - - - -ResendCodePayloadOptions}> - - - Additional data collected from the user. - - - - -*** ResendControl}> @@ -215,22 +179,25 @@ startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - - - + + The cooldown duration in seconds before the user can resend the code again. + - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -242,17 +209,4 @@ import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; const mfaEmailChallenge = new MfaEmailChallenge(); await mfaEmailChallenge.tryAnotherMethod(); ``` - -**Method Parameters** - - - -TryAnotherMethodPayloadOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailList.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailList.mdx index 170daf144a..f90b031bb6 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailList.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEmailList.mdx @@ -75,25 +75,21 @@ mfaEmailList.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -111,21 +107,7 @@ import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; const mfaEmailList = new MfaEmailList(); await mfaEmailList.goBack(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -143,16 +125,13 @@ await mfaEmailList.selectMfaEmail({ **Method Parameters** + + + [SelectMfaEmailOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaEmailOptions). + -SelectMfaEmailOptions} required> - - - The index of the email to select. - - - - Additional data collected from the user. - + + The index of the email to select. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEnrollResult.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEnrollResult.mdx index 9a266ae9bc..eb102f032e 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEnrollResult.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaEnrollResult.mdx @@ -72,25 +72,21 @@ mfaEnrollResult.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaLoginOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaLoginOptions.mdx index 7517023d52..bc727542cf 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaLoginOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaLoginOptions.mdx @@ -75,25 +75,21 @@ mfaLoginOptions.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -111,21 +107,17 @@ await mfaLoginOptions.enroll({ **Method Parameters** + + + [LoginEnrollOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LoginEnrollOptions). + -LoginEnrollOptions} required> - - - The action indicating which factor to enroll. - - - - Additional data collected from the user. - + + The action indicating which factor to enroll. -*** Error[]}> @@ -143,17 +135,4 @@ import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; const mfaLoginOptions = new MfaLoginOptions(); await mfaLoginOptions.returnToPrevious(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpChallenge.mdx index cf90b20ee3..1890b9f85f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpChallenge.mdx @@ -76,25 +76,21 @@ mfaOtpChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -113,25 +109,21 @@ await mfaOtpChallenge.continue({ **Method Parameters** + + + [ContinueOTPOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOTPOptions). + -ContinueOTPOptions} required> - - - The OTP code entered by the user. - - - - Indicates whether to remember the browser. - + + The OTP code entered by the user. + - - Additional data collected from the user. - + + Indicates whether to remember the browser. -*** Error[]}> @@ -149,17 +141,4 @@ import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; const mfaOtpChallenge = new MfaOtpChallenge(); await mfaOtpChallenge.tryAnotherMethod(); ``` - -**Method Parameters** - - - -TryAnotherMethodMfaOtpChallengeOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx index d551fcf3ce..82ade2aaa4 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx @@ -75,25 +75,21 @@ mfaOtpEnrollmentCode.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -111,21 +107,17 @@ await mfaOtpEnrollmentCode.continue({ **Method Parameters** + + + [MfaOtpContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpContinueOptions). + -MfaOtpContinueOptions} required> - - - The OTP code entered by the user. - - - - Additional data collected from the user. - + + The OTP code entered by the user. -*** Error[]}> @@ -143,22 +135,8 @@ import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); await mfaOtpEnrollmentCode.toggleView(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method allows the user to try another MFA method. @@ -169,17 +147,4 @@ import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); await mfaOtpEnrollmentCode.tryAnotherMethod(); ``` - -**Method Parameters** - - - -MfaOtpTryAnotherMethodOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx index 5dad0c64a2..000c73153c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx @@ -73,25 +73,21 @@ mfaOtpEnrollmentQr.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -107,21 +103,17 @@ await mfaOtpEnrollmentQr.continue({ code: '123456' }); **Method Parameters** + + + [MfaOtpEnrollmentQrContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions). + -MfaOtpEnrollmentQrContinueOptions} required> - - - The OTP code entered by the user. - - - - Additional data collected from the user. - + + The OTP code entered by the user. -*** Error[]}> @@ -139,22 +131,8 @@ import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); await mfaOtpEnrollmentQr.toggleView(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method allows the user to try another MFA method. @@ -165,17 +143,4 @@ import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); await mfaOtpEnrollmentQr.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneChallenge.mdx index 1aaad4cc98..ca4c6f6fbf 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneChallenge.mdx @@ -74,25 +74,21 @@ mfaPhoneChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -108,21 +104,17 @@ await mfaPhoneChallenge.continue({ type: 'sms' }); **Method Parameters** + + + [MfaPhoneChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions). + -MfaPhoneChallengeContinueOptions} required> - - - The delivery method for the MFA code. - - - - Additional data collected from the user. - + + The delivery method for the MFA code. -*** Error[]}> @@ -140,21 +132,7 @@ import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; const mfaPhoneChallenge = new MfaPhoneChallenge(); await mfaPhoneChallenge.pickPhone(); ``` - -**Method Parameters** - - - -MfaPhoneChallengePickPhoneOptions}> - - - Additional data collected from the user. - - - - -*** @@ -167,16 +145,4 @@ const mfaPhoneChallenge = new MfaPhoneChallenge(); await mfaPhoneChallenge.tryAnotherMethod(); ``` -**Method Parameters** - - - -MfaPhoneChallengePickAuthenticatorOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx index d4743e30f6..a7445bbbd5 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx @@ -73,25 +73,21 @@ mfaPhoneEnrollment.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -107,25 +103,21 @@ await mfaPhoneEnrollment.continueEnrollment({ phone: '+1234567890', type: 'sms' **Method Parameters** + + + [MfaPhoneEnrollmentContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions). + -MfaPhoneEnrollmentContinueOptions} required> - - - The user's phone number. - - - - The delivery method for the verification code. - + + The user's phone number. + - - Additional data collected from the user. - + + The delivery method for the verification code. -*** Error[]}> @@ -143,21 +135,7 @@ import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; const mfaPhoneEnrollment = new MfaPhoneEnrollment(); await mfaPhoneEnrollment.pickCountryCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -169,17 +147,4 @@ import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; const mfaPhoneEnrollment = new MfaPhoneEnrollment(); await mfaPhoneEnrollment.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushChallengePush.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushChallengePush.mdx index 09a5b96371..41103d95a4 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushChallengePush.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushChallengePush.mdx @@ -73,25 +73,21 @@ mfaPushChallengePush.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -107,21 +103,17 @@ await mfaPushChallengePush.continue(); **Method Parameters** + + + [WithRememberOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/WithRememberOptions). + -WithRememberOptions}> - - - Indicates whether to remember the device. - - - - Additional data collected from the user. - + + Indicates whether to remember the device. -*** @@ -133,21 +125,7 @@ import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; const mfaPushChallengePush = new MfaPushChallengePush(); await mfaPushChallengePush.enterCodeManually(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> @@ -192,25 +170,25 @@ control.stopPolling(); **Method Parameters** + + + [MfaPollingOptions](/docs/libraries/acul/js-sdk/Screens/type-aliases/MfaPollingOptions). + -MfaPollingOptions} required> - - - Optional interval, in milliseconds, between consecutive polling requests. If omitted, the SDK's internal default interval is used (typically 5000 ms). - + + Optional interval, in milliseconds, between consecutive polling requests. If omitted, the SDK's internal default interval is used (typically 5000 ms). + - - Optional callback executed once the MFA push challenge is successfully approved and polling completes. Called exactly once, after which polling stops automatically. - + + Optional callback executed once the MFA push challenge is successfully approved and polling completes. Called exactly once, after which polling stops automatically. + - - Optional callback invoked if an error occurs while polling. Receives an `ULError` object containing `status` (HTTP status code) and `responseText` (raw response body). - + + Optional callback invoked if an error occurs while polling. Receives an `ULError` object containing `status` (HTTP status code) and `responseText` (raw response body). -*** @@ -226,21 +204,17 @@ await mfaPushChallengePush.resendPushNotification(); **Method Parameters** + + + [WithRememberOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/WithRememberOptions). + -WithRememberOptions}> - - - Indicates whether to remember the device. - - - - Additional data collected from the user. - + + Indicates whether to remember the device. -*** @@ -252,17 +226,4 @@ import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; const mfaPushChallengePush = new MfaPushChallengePush(); await mfaPushChallengePush.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx index 69f8c34854..d45666790d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx @@ -73,25 +73,21 @@ mfaPushEnrollmentQr.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -107,21 +103,17 @@ await mfaPushEnrollmentQr.continue(); **Method Parameters** + + + [MfaPushEnrollmentQrWithRememberOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPushEnrollmentQrWithRememberOptions). + -MfaPushEnrollmentQrWithRememberOptions}> - - - Indicates whether to remember the device. - - - - Additional data collected from the user. - + + Indicates whether to remember the device. -*** Error[]}> @@ -139,21 +131,7 @@ import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); await mfaPushEnrollmentQr.pickAuthenticator(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** MfaPushPollingControl}> @@ -192,20 +170,21 @@ control.stopPolling(); **Method Parameters** + + + [MfaPollingOptions](/docs/libraries/acul/js-sdk/Screens/type-aliases/MfaPollingOptions). + -MfaPollingOptions} required> - - - Optional interval, in milliseconds, between consecutive polling requests. If omitted, the SDK's internal default interval is used (typically 5000 ms). - + + Optional interval, in milliseconds, between consecutive polling requests. If omitted, the SDK's internal default interval is used (typically 5000 ms). + - - Optional callback executed once the MFA push enrollment is successfully approved and polling completes. Called exactly once, after which polling stops automatically. - + + Optional callback executed once the MFA push enrollment is successfully approved and polling completes. Called exactly once, after which polling stops automatically. + - - Optional callback invoked if an error occurs while polling. Receives an `ULError` object containing `status` (HTTP status code) and `responseText` (raw response body). - + + Optional callback invoked if an error occurs while polling. Receives an `ULError` object containing `status` (HTTP status code) and `responseText` (raw response body). diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushList.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushList.mdx index 59f3e7f184..dc0c0704ff 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushList.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushList.mdx @@ -73,25 +73,21 @@ mfaPushList.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -109,21 +105,7 @@ import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; const mfaPushList = new MfaPushList(); await mfaPushList.goBack(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -139,16 +121,13 @@ await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); **Method Parameters** + + + [SelectMfaPushDeviceOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions). + -SelectMfaPushDeviceOptions} required> - - - The index of the device to select from the list of enrolled devices. The index is 0-based. - - - - Additional data collected from the user. - + + The index of the device to select from the list of enrolled devices. The index is 0-based. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushWelcome.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushWelcome.mdx index 4ebe27fc46..7e806dce56 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushWelcome.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushWelcome.mdx @@ -73,25 +73,21 @@ mfaPushWelcome.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -103,21 +99,7 @@ import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; const mfaPushWelcome = new MfaPushWelcome(); await mfaPushWelcome.enroll(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> @@ -135,17 +117,4 @@ import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; const mfaPushWelcome = new MfaPushWelcome(); await mfaPushWelcome.pickAuthenticator(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx index 9a97d3d5e5..d8ec05d9d0 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx @@ -74,25 +74,21 @@ mfaRecoveryCodeChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -108,21 +104,17 @@ await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' }); **Method Parameters** + + + [MfaRecoveryCodeChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions). + -MfaRecoveryCodeChallengeContinueOptions} required> - - - The recovery code entered by the user. - - - - Additional data collected from the user. - + + The recovery code entered by the user. -*** Error[]}> @@ -140,17 +132,4 @@ import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-cha const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); await mfaRecoveryCodeChallenge.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx index 7e6210e051..dd2c987346 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx @@ -74,25 +74,21 @@ mfaRecoveryCodeChallengeNewCode.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -105,20 +101,7 @@ const mfaRecoveryCodeChallengeNewCode = new MfaRecoveryCodeChallengeNewCode(); await mfaRecoveryCodeChallengeNewCode.continue(); ``` -**Method Parameters** - - - -MfaRecoveryCodeChallengeNewCodeContinueOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx index ee2d52c27c..be7482df1d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx @@ -74,25 +74,21 @@ mfaRecoveryCodeEnrollment.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -108,21 +104,17 @@ await mfaRecoveryCodeEnrollment.continue({ isCodeCopied: true }); **Method Parameters** + + + [MfaRecoveryCodeEnrollmentContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions). + -MfaRecoveryCodeEnrollmentContinueOptions} required> - - - Indicates whether the user has copied the recovery code. - - - - Additional data collected from the user. - + + Indicates whether the user has copied the recovery code. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsChallenge.mdx index 514675ea7c..f3321efd2b 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsChallenge.mdx @@ -77,25 +77,21 @@ mfaSmsChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -114,25 +110,21 @@ await mfaSmsChallenge.continueMfaSmsChallenge({ **Method Parameters** + + + [MfaSmsChallengeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsChallengeOptions). + -MfaSmsChallengeOptions} required> - - - The SMS code entered by the user. - - - - When set to `true`, registers this device as trusted so the user is not prompted for MFA on subsequent logins from the same device. - + + The SMS code entered by the user. + - - Additional data collected from the user. - + + When set to `true`, registers this device as trusted so the user is not prompted for MFA on subsequent logins from the same device. -*** @@ -144,21 +136,7 @@ import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; const mfaSmsChallenge = new MfaSmsChallenge(); await mfaSmsChallenge.getACall(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> @@ -176,21 +154,7 @@ import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; const mfaSmsChallenge = new MfaSmsChallenge(); await mfaSmsChallenge.pickSms(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -202,21 +166,7 @@ import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; const mfaSmsChallenge = new MfaSmsChallenge(); await mfaSmsChallenge.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** ResendControl}> @@ -242,25 +192,25 @@ startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, receiving the remaining seconds and whether resend is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, receiving the remaining seconds and whether resend is currently disabled. + - - Callback invoked when the resend timeout expires and the resend option becomes available. - + + Callback invoked when the resend timeout expires and the resend option becomes available. + - - The number of seconds before the resend option becomes available. - + + The number of seconds before the resend option becomes available. -*** @@ -272,17 +222,4 @@ import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; const mfaSmsChallenge = new MfaSmsChallenge(); await mfaSmsChallenge.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsEnrollment.mdx index 3ba1437009..0f86885e2f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsEnrollment.mdx @@ -74,25 +74,21 @@ mfaSmsEnrollment.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -108,25 +104,21 @@ await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' }); **Method Parameters** + + + [MfaSmsEnrollmentOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions). + -MfaSmsEnrollmentOptions} required> - - - The CAPTCHA code or response from the CAPTCHA provider. Required if your Auth0 tenant has Bot Detection enabled. - - - - The user's phone number. - + + The CAPTCHA code or response from the CAPTCHA provider. Required if your Auth0 tenant has Bot Detection enabled. + - - Additional data collected from the user. - + + The user's phone number. -*** Error[]}> @@ -144,21 +136,7 @@ import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; const mfaSmsEnrollment = new MfaSmsEnrollment(); await mfaSmsEnrollment.pickCountryCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -170,17 +148,4 @@ import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; const mfaSmsEnrollment = new MfaSmsEnrollment(); await mfaSmsEnrollment.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsList.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsList.mdx index bcf9eee89c..d7ba2f0347 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsList.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaSmsList.mdx @@ -68,21 +68,7 @@ import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; const mfaSmsList = new MfaSmsList(); await mfaSmsList.backAction(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -100,25 +86,21 @@ mfaSmsList.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -140,16 +122,13 @@ await mfaSmsList.selectPhoneNumber({ index: 0 }); **Method Parameters** + + + [MfaSmsListOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsListOptions). + -MfaSmsListOptions}> - - - The index of the phone number to select. - - - - Additional data collected from the user. - + + The index of the phone number to select. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceChallenge.mdx index 9160b780fc..b33fabed87 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceChallenge.mdx @@ -74,25 +74,21 @@ mfaVoiceChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -111,25 +107,21 @@ await mfaVoiceChallenge.continue({ **Method Parameters** + + + [MfaVoiceChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions). + -MfaVoiceChallengeContinueOptions} required> - - - The verification code received via voice call. - - - - When `true`, remembers the browser for future MFA challenges. Only applicable if `screen.showRememberDevice` is `true`. - + + The verification code received via voice call. + - - Additional data collected from the user. - + + When `true`, remembers the browser for future MFA challenges. Only applicable if `screen.showRememberDevice` is `true`. -*** Error[]}> @@ -147,21 +139,7 @@ import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; const mfaVoiceChallenge = new MfaVoiceChallenge(); await mfaVoiceChallenge.pickPhone(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -173,21 +151,7 @@ import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; const mfaVoiceChallenge = new MfaVoiceChallenge(); await mfaVoiceChallenge.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** ResendControl}> @@ -213,25 +177,25 @@ startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, receiving the remaining seconds and whether resend is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, receiving the remaining seconds and whether resend is currently disabled. + - - Callback invoked when the resend timeout expires and the resend option becomes available. - + + Callback invoked when the resend timeout expires and the resend option becomes available. + - - The number of seconds before the resend option becomes available. - + + The number of seconds before the resend option becomes available. -*** @@ -243,22 +207,8 @@ import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; const mfaVoiceChallenge = new MfaVoiceChallenge(); await mfaVoiceChallenge.switchToSms(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method allows the user to try another MFA method. @@ -269,17 +219,4 @@ import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; const mfaVoiceChallenge = new MfaVoiceChallenge(); await mfaVoiceChallenge.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx index fe23a21875..67d64db71e 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx @@ -74,25 +74,21 @@ mfaVoiceEnrollment.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -108,21 +104,17 @@ await mfaVoiceEnrollment.continue({ phone: '+1234567890' }); **Method Parameters** + + + [MfaVoiceEnrollmentContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions). + -MfaVoiceEnrollmentContinueOptions} required> - - - The user's phone number to receive the voice call. - - - - Additional data collected from the user. - + + The user's phone number to receive the voice call. -*** Error[]}> @@ -140,22 +132,8 @@ import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; const mfaVoiceEnrollment = new MfaVoiceEnrollment(); await mfaVoiceEnrollment.selectPhoneCountryCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method allows the user to try another MFA method. @@ -166,17 +144,4 @@ import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; const mfaVoiceEnrollment = new MfaVoiceEnrollment(); await mfaVoiceEnrollment.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx index e6a7566a7f..58d247a1fc 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx @@ -74,25 +74,21 @@ mfaWebAuthnChangeKeyNickname.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -108,21 +104,17 @@ await mfaWebAuthnChangeKeyNickname.continueWithNewNickname({ nickname: 'My YubiK **Method Parameters** + + + [MfaWebAuthnChangeKeyNicknameContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions). + -MfaWebAuthnChangeKeyNicknameContinueOptions} required> - - - The new nickname for the WebAuthn security key. - - - - Additional data collected from the user. - + + The new nickname for the WebAuthn security key. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx index 253366ffa3..f4e6aefe79 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx @@ -74,25 +74,21 @@ mfaWebAuthnEnrollmentSuccess.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -104,21 +100,7 @@ import MfaWebAuthnEnrollmentSuccess from '@auth0/auth0-acul-js/mfa-webauthn-enro const mfaWebAuthnEnrollmentSuccess = new MfaWebAuthnEnrollmentSuccess(); await mfaWebAuthnEnrollmentSuccess.continue(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnError.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnError.mdx index 745b9ce18d..28b965d5f7 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnError.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnError.mdx @@ -74,25 +74,21 @@ mfaWebAuthnError.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -110,22 +106,8 @@ import MfaWebAuthnError from '@auth0/auth0-acul-js/mfa-webauthn-error'; const mfaWebAuthnError = new MfaWebAuthnError(); await mfaWebAuthnError.noThanks(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method allows the user to retry the previous WebAuthn operation. @@ -136,21 +118,7 @@ import MfaWebAuthnError from '@auth0/auth0-acul-js/mfa-webauthn-error'; const mfaWebAuthnError = new MfaWebAuthnError(); await mfaWebAuthnError.tryAgain(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -162,21 +130,7 @@ import MfaWebAuthnError from '@auth0/auth0-acul-js/mfa-webauthn-error'; const mfaWebAuthnError = new MfaWebAuthnError(); await mfaWebAuthnError.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -188,17 +142,4 @@ import MfaWebAuthnError from '@auth0/auth0-acul-js/mfa-webauthn-error'; const mfaWebAuthnError = new MfaWebAuthnError(); await mfaWebAuthnError.usePassword(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx index c2765d73cc..c2aab12f63 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx @@ -74,25 +74,21 @@ mfaWebAuthnNotAvailableError.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -110,17 +106,4 @@ import MfaWebAuthnNotAvailableError from '@auth0/auth0-acul-js/mfa-webauthn-not- const mfaWebAuthnNotAvailableError = new MfaWebAuthnNotAvailableError(); await mfaWebAuthnNotAvailableError.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx index f3a956b882..b8b4761853 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx @@ -74,25 +74,21 @@ mfaWebAuthnPlatformChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -116,18 +112,17 @@ await mfaWebAuthnPlatformChallenge.reportBrowserError({ **Method Parameters** + + + [MfaWebAuthnPlatformChallengeReportErrorOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions). + -MfaWebAuthnPlatformChallengeReportErrorOptions} required> - - WebAuthnErrorDetails} required> - The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. - - +WebAuthnErrorDetails} required> + The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. -*** @@ -140,21 +135,8 @@ const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge(); await mfaWebAuthnPlatformChallenge.tryAnotherMethod(); ``` -**Method Parameters** - - - -MfaWebAuthnPlatformChallengeTryAnotherMethodOptions}> - - - Additional data collected from the user. - - - -*** - This method initiates the WebAuthn platform authenticator challenge. @@ -169,16 +151,13 @@ await mfaWebAuthnPlatformChallenge.verify(); **Method Parameters** + + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + -CustomOptions}> - - - When `true`, remembers the browser for future MFA challenges. Only applicable if `screen.showRememberDevice` is `true`. - - - - Additional data collected from the user. - + + When `true`, remembers the browser for future MFA challenges. Only applicable if `screen.showRememberDevice` is `true`. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx index d068fd0ea8..e61712a017 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx @@ -74,25 +74,21 @@ mfaWebAuthnPlatformEnrollment.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -110,21 +106,7 @@ import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-pla const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment(); await mfaWebAuthnPlatformEnrollment.refuseEnrollmentOnThisDevice(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -142,18 +124,17 @@ await mfaWebAuthnPlatformEnrollment.reportBrowserError({ **Method Parameters** + + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + -CustomOptions} required> - - WebAuthnErrorDetails} required> - The error object from the WebAuthn API (`navigator.credentials.create()`) to be reported. - - +WebAuthnErrorDetails} required> + The error object from the WebAuthn API (`navigator.credentials.create()`) to be reported. -*** @@ -165,22 +146,8 @@ import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-pla const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment(); await mfaWebAuthnPlatformEnrollment.snoozeEnrollment(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method initiates the WebAuthn platform credential creation and submits the resulting credential to the server. @@ -191,17 +158,4 @@ import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-pla const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment(); await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx index 3ef5d20c47..cb0c8493d3 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx @@ -74,25 +74,21 @@ mfaWebAuthnRoamingChallenge.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -116,18 +112,17 @@ await mfaWebAuthnRoamingChallenge.reportWebAuthnError({ **Method Parameters** + + + [MfaWebAuthnRoamingChallengeReportErrorOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions). + -MfaWebAuthnRoamingChallengeReportErrorOptions} required> - - WebAuthnErrorDetails} required> - The error object from the WebAuthn API to be reported. - - +WebAuthnErrorDetails} required> + The error object from the WebAuthn API to be reported. -*** @@ -140,21 +135,8 @@ const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge(); await mfaWebAuthnRoamingChallenge.tryAnotherMethod(); ``` -**Method Parameters** - - - -MfaWebAuthnRoamingChallengeTryAnotherMethodOptions}> - - - Additional data collected from the user. - - - -*** - This method initiates the WebAuthn challenge using the security key. @@ -169,16 +151,13 @@ await mfaWebAuthnRoamingChallenge.verify(); **Method Parameters** + + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + -CustomOptions}> - - - When `true`, remembers the browser for future MFA challenges. Only applicable if `screen.showRememberDevice` is `true`. - - - - Additional data collected from the user. - + + When `true`, remembers the browser for future MFA challenges. Only applicable if `screen.showRememberDevice` is `true`. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx index 0472dc50d6..500d044627 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx @@ -74,25 +74,21 @@ mfaWebAuthnRoamingEnrollment.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -104,21 +100,7 @@ import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roam const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment(); await mfaWebAuthnRoamingEnrollment.enroll(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> @@ -142,18 +124,17 @@ await mfaWebAuthnRoamingEnrollment.showError({ **Method Parameters** + + + [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions). + -CustomOptions} required> - - WebAuthnErrorDetails} required> - The error object from the WebAuthn API (`navigator.credentials.create()`) to be reported. - - +WebAuthnErrorDetails} required> + The error object from the WebAuthn API (`navigator.credentials.create()`) to be reported. -*** @@ -166,16 +147,4 @@ const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment(); await mfaWebAuthnRoamingEnrollment.tryAnotherMethod(); ``` -**Method Parameters** - - - -MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationPicker.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationPicker.mdx index 4be8067d59..386e307a9d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationPicker.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationPicker.mdx @@ -72,32 +72,27 @@ organizationPickerManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -112,25 +107,21 @@ await organizationPickerManager.selectOrganization({ organization: 'org_XXXXXXXX **Method Parameters** + + + [SelectOrganizationOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SelectOrganizationOptions). + -SelectOrganizationOptions}> - - - The ID of the organization to select. - - - - An optional state value to include with the request. - + + The ID of the organization to select. + - - Additional data collected from the user. - + + An optional state value to include with the request. -*** @@ -141,17 +132,4 @@ import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; const organizationPickerManager = new OrganizationPicker(); await organizationPickerManager.skipOrganizationSelection(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationSelection.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationSelection.mdx index 9664f5e264..9e352252fa 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationSelection.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/OrganizationSelection.mdx @@ -74,25 +74,21 @@ organizationSelectionManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -109,21 +105,17 @@ await organizationSelectionManager.continueWithOrganizationName({ **Method Parameters** + + + [ContinueWithOrganizationNameOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions). + -ContinueWithOrganizationNameOptions}> - - - The name of the organization to continue with. - - - - Additional data collected from the user. - + + The name of the organization to continue with. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollment.mdx index 8c3c5397fb..04d667395b 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollment.mdx @@ -70,21 +70,17 @@ await passkeyEnrollmentManager.abortPasskeyEnrollment(); **Method Parameters** + + + [AbortEnrollmentOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/AbortEnrollmentOptions). + -AbortEnrollmentOptions}> - - - When set to `true`, hides the passkey enrollment prompt for future sessions. - - - - Additional data collected from the user. - + + When set to `true`, hides the passkey enrollment prompt for future sessions. -*** @@ -101,25 +97,21 @@ passkeyEnrollmentManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -130,21 +122,7 @@ import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; const passkeyEnrollmentManager = new PasskeyEnrollment(); await passkeyEnrollmentManager.continuePasskeyEnrollment(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx index 14fa9d0daf..52ff1118cf 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx @@ -70,21 +70,17 @@ await passkeyEnrollmentLocalManager.abortPasskeyEnrollment({ doNotShowAgain: tru **Method Parameters** + + + [AbortEnrollmentOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/AbortEnrollmentOptions). + -AbortEnrollmentOptions}> - - - When set to `true`, hides the passkey enrollment prompt for future sessions. - - - - Additional data collected from the user. - + + When set to `true`, hides the passkey enrollment prompt for future sessions. -*** @@ -101,25 +97,21 @@ passkeyEnrollmentLocalManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -130,21 +122,7 @@ import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-loca const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal(); await passkeyEnrollmentLocalManager.continuePasskeyEnrollment(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx index a2c1b353ce..41c2b904c8 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx @@ -74,32 +74,27 @@ phoneIdentifierChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -110,21 +105,7 @@ import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-chal const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge(); await phoneIdentifierChallengeManager.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** ResendControl}> @@ -142,25 +123,25 @@ await startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -171,21 +152,7 @@ import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-chal const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge(); await phoneIdentifierChallengeManager.returnToPrevious(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -202,25 +169,21 @@ await phoneIdentifierChallengeManager.submitPhoneChallenge({ **Method Parameters** + + + [PhoneChallengeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneChallengeOptions). + -PhoneChallengeOptions}> - - - The verification code sent to the user's phone number. - - - - The CAPTCHA response token, if CAPTCHA is enabled for this tenant. - + + The verification code sent to the user's phone number. + - - Additional data collected from the user. - + + The CAPTCHA response token, if CAPTCHA is enabled for this tenant. -*** @@ -231,22 +194,8 @@ import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-chal const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge(); await phoneIdentifierChallengeManager.switchToText(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - This method switches the delivery method for the verification code to a voice call. @@ -256,17 +205,4 @@ import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-chal const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge(); await phoneIdentifierChallengeManager.switchToVoice(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx index 302f5047eb..cdf6555fb5 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx @@ -74,25 +74,21 @@ phoneIdentifierEnrollmentManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -109,28 +105,23 @@ await phoneIdentifierEnrollmentManager.continuePhoneEnrollment({ **Method Parameters** + + + [PhoneEnrollmentOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneEnrollmentOptions). + -PhoneEnrollmentOptions}> - - - The delivery method for the verification code. - - - - Additional data collected from the user. - + + The delivery method for the verification code. -*** Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. -*** @@ -141,17 +132,4 @@ import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enr const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment(); await phoneIdentifierEnrollmentManager.returnToPrevious(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/RedeemTicket.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/RedeemTicket.mdx index e0124b1a73..0f30eeac5f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/RedeemTicket.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/RedeemTicket.mdx @@ -72,25 +72,21 @@ redeemTicketManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -101,21 +97,7 @@ import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; const redeemTicketManager = new RedeemTicket(); await redeemTicketManager.continue(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPassword.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPassword.mdx index 88073f966e..abdcd6d771 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPassword.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPassword.mdx @@ -75,25 +75,21 @@ resetPasswordManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -117,25 +113,21 @@ resetPasswordManager.resetPassword({ **Method Parameters** + + + [ResetPasswordOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordOptions). + -ResetPasswordOptions}> - - - The new password entered by the user. - - - - Confirmation of the new password. Must match `password-reset`. - + + The new password entered by the user. + - - Additional data collected from the user. - + + Confirmation of the new password. Must match `password-reset`. -*** PasswordValidationResult}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordEmail.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordEmail.mdx index d83f784aff..1462ec2452 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordEmail.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordEmail.mdx @@ -72,25 +72,21 @@ resetPasswordEmailManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -107,17 +103,4 @@ import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; const resetPasswordEmailManager = new ResetPasswordEmail(); resetPasswordEmailManager.resendEmail(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordError.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordError.mdx index 247cd6f6ee..c206ad4c9c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordError.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordError.mdx @@ -71,25 +71,21 @@ resetPasswordErrorManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx index 8dde6167f1..84d340c2a8 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx @@ -74,25 +74,21 @@ resetPasswordMfaEmailChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -109,25 +105,21 @@ await resetPasswordMfaEmailChallengeManager.continue({ **Method Parameters** + + + [ContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOptions). + -ContinueOptions}> - - - The verification code sent to the user's email address. - - - - Whether to remember the device for future MFA challenges. - + + The verification code sent to the user's email address. + - - Additional data collected from the user. - + + Whether to remember the device for future MFA challenges. -*** Error[]}> @@ -145,20 +137,7 @@ const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge await resetPasswordMfaEmailChallengeManager.resendCode(); ``` -**Method Parameters** - - - -ResendCodeOptions}> - - - Additional data collected from the user. - - - - -*** ResendControl}> @@ -184,25 +163,25 @@ startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - - The number of seconds to wait before allowing the user to resend the code. - + + The number of seconds to wait before allowing the user to resend the code. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback fired when the timeout expires and the resend button becomes available. - + + Callback fired when the timeout expires and the resend button becomes available. -*** @@ -214,16 +193,4 @@ const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge await resetPasswordMfaEmailChallengeManager.tryAnotherMethod(); ``` -**Method Parameters** - - - -TryAnotherMethodOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx index 1a3bf66019..08a404f5e5 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx @@ -74,25 +74,21 @@ resetPasswordMfaOtpChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -109,21 +105,17 @@ await resetPasswordMfaOtpChallengeManager.continue({ **Method Parameters** + + + [ResetPasswordMfaOtpChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions). + -ResetPasswordMfaOtpChallengeContinueOptions}> - - - The OTP code from the user's authenticator app. - - - - Additional data collected from the user. - + + The OTP code from the user's authenticator app. -*** Error[]}> @@ -141,16 +133,4 @@ const resetPasswordMfaOtpChallengeManager = new ResetPasswordMfaOtpChallenge(); await resetPasswordMfaOtpChallengeManager.tryAnotherMethod(); ``` -**Method Parameters** - - - -ResetPasswordMfaOtpChallengeTryAnotherMethodOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx index 9068839323..defdee131f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx @@ -74,25 +74,21 @@ resetPasswordMfaPhoneChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -109,21 +105,17 @@ await resetPasswordMfaPhoneChallengeManager.continue({ **Method Parameters** + + + [ResetPasswordMfaPhoneChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions). + -ResetPasswordMfaPhoneChallengeContinueOptions}> - - - The delivery method for the verification code. Use `sms` to send via text message or `voice` to send via a voice call. - - - - Additional data collected from the user. - + + The delivery method for the verification code. Use `sms` to send via text message or `voice` to send via a voice call. -*** Error[]}> @@ -146,16 +138,13 @@ await resetPasswordMfaPhoneChallengeManager.tryAnotherMethod({ **Method Parameters** + + + [ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions). + -ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions}> - - - The delivery method that was presented on the current screen. Required by the API to correctly process the method switch. - - - - Additional data collected from the user. - + + The delivery method that was presented on the current screen. Required by the API to correctly process the method switch. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx index 2684e6c571..83a4f8b68b 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx @@ -72,25 +72,21 @@ resetPasswordMfaPushChallengePushManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -101,21 +97,7 @@ import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-passwo const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush(); await resetPasswordMfaPushChallengePushManager.continue(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -126,21 +108,7 @@ import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-passwo const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush(); await resetPasswordMfaPushChallengePushManager.enterCodeManually(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** Error[]}> @@ -172,25 +140,25 @@ control.stopPolling(); **Method Parameters** + + + [MfaPollingOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPollingOptions). + -MfaPollingOptions}> - - - The interval in milliseconds between polling attempts. - + + The interval in milliseconds between polling attempts. + - - Callback invoked when the push challenge is approved and polling stops automatically. - + + Callback invoked when the push challenge is approved and polling stops automatically. + - - Callback invoked if an error occurs during polling. - + + Callback invoked if an error occurs during polling. -*** @@ -201,21 +169,7 @@ import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-passwo const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush(); await resetPasswordMfaPushChallengePushManager.resendPushNotification(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -226,17 +180,4 @@ import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-passwo const resetPasswordMfaPushChallengePushManager = new ResetPasswordMfaPushChallengePush(); await resetPasswordMfaPushChallengePushManager.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx index c634c702cf..268aa25348 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx @@ -72,25 +72,21 @@ resetPasswordMfaRecoveryCodeChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -110,13 +106,8 @@ await resetPasswordMfaRecoveryCodeChallengeManager.continue('RECOVERY_CODE'); The recovery code entered by the user. - - Additional data collected from the user. - - -*** Error[]}> @@ -133,17 +124,4 @@ import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-pa const resetPasswordMfaRecoveryCodeChallengeManager = new ResetPasswordMfaRecoveryCodeChallenge(); await resetPasswordMfaRecoveryCodeChallengeManager.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx index bdcf1ad36a..c9d73121cc 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx @@ -74,25 +74,21 @@ resetPasswordMfaSmsChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -109,21 +105,17 @@ await resetPasswordMfaSmsChallengeManager.continueMfaSmsChallenge({ **Method Parameters** + + + [ResetPasswordMfaSmsChallengeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions). + -ResetPasswordMfaSmsChallengeOptions}> - - - The SMS verification code entered by the user. - - - - Additional data collected from the user. - + + The SMS verification code entered by the user. -*** @@ -134,22 +126,8 @@ import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mf const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge(); await resetPasswordMfaSmsChallengeManager.getACall(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - Error[]}> This method retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -165,21 +143,7 @@ import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mf const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge(); await resetPasswordMfaSmsChallengeManager.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** ResendControl}> @@ -205,25 +169,25 @@ startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -234,17 +198,4 @@ import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mf const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge(); await resetPasswordMfaSmsChallengeManager.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx index 958ea465e5..d8bad1dad6 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx @@ -72,25 +72,21 @@ resetPasswordMfaVoiceChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -105,21 +101,17 @@ await resetPasswordMfaVoiceChallengeManager.continue({ code: '123456' }); **Method Parameters** + + + [ResetPasswordMfaVoiceChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions). + -ResetPasswordMfaVoiceChallengeContinueOptions}> - - - The verification code delivered to the user via voice call. - - - - Additional data collected from the user. - + + The verification code delivered to the user via voice call. -*** Error[]}> @@ -136,22 +128,8 @@ import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password- const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge(); await resetPasswordMfaVoiceChallengeManager.resendCode(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - -*** - ResendControl}> This method provides resend functionality with timeout management. It returns a [`ResendControl`](/docs/libraries/acul/js-sdk/Screens/interfaces/ResendControl) object with a `startResend()` method that triggers the resend and enforces a cooldown period before the user can resend again. @@ -176,25 +154,25 @@ startResend(); **Method Parameters** + + + [StartResendOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/StartResendOptions). + -StartResendOptions}> - - - The cooldown duration in seconds before the user can resend the code again. - + + The cooldown duration in seconds before the user can resend the code again. + - OnStatusChangeCallback}> - Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. - +OnStatusChangeCallback}> + Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled. + - - Callback invoked when the cooldown expires and resend becomes available again. - + + Callback invoked when the cooldown expires and resend becomes available again. -*** @@ -205,21 +183,7 @@ import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password- const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge(); await resetPasswordMfaVoiceChallengeManager.switchToSms(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -230,17 +194,4 @@ import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password- const resetPasswordMfaVoiceChallengeManager = new ResetPasswordMfaVoiceChallenge(); await resetPasswordMfaVoiceChallengeManager.tryAnotherMethod(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx index 64cf39d976..6fcdd54235 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -74,25 +74,21 @@ resetPasswordMfaWebAuthnPlatformChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** @@ -117,21 +113,17 @@ try { **Method Parameters** + + + [ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions). + -ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions}> - - - When `true`, marks the device as trusted so the user is not prompted for MFA again on this device. - - - - Additional data collected from the user. - + + When `true`, marks the device as trusted so the user is not prompted for MFA again on this device. -*** Error[]}> @@ -154,21 +146,17 @@ await resetPasswordMfaWebAuthnPlatformChallengeManager.reportBrowserError({ **Method Parameters** + + + [ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions). + -ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions}> - - WebAuthnErrorDetails} required> - The error object from the WebAuthn API. Must include `name` and `message` from the `DOMException` thrown by `navigator.credentials.get()`. - - - - Additional data collected from the user. - +WebAuthnErrorDetails} required> + The error object from the WebAuthn API. Must include `name` and `message` from the `DOMException` thrown by `navigator.credentials.get()`. -*** @@ -180,16 +168,4 @@ const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWeb await resetPasswordMfaWebAuthnPlatformChallengeManager.tryAnotherMethod(); ``` -**Method Parameters** - - - -ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions}> - - - Additional data collected from the user. - - - - diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx index 623cfe2e2c..37b3727afb 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -82,25 +82,21 @@ resetPasswordMfaWebAuthnRoamingChallengeManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -123,25 +119,21 @@ await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({ **Method Parameters** + + + [ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions). + -ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions}> - - WebAuthnErrorDetails} required> - The error object from the WebAuthn API. Must include `name` and `message` from the `DOMException` thrown by `navigator.credentials.get()`. - - - - When `true`, preserves the remember-device preference alongside the error report. - +WebAuthnErrorDetails} required> + The error object from the WebAuthn API. Must include `name` and `message` from the `DOMException` thrown by `navigator.credentials.get()`. + - - Additional data collected from the user. - + + When `true`, preserves the remember-device preference alongside the error report. -*** @@ -156,21 +148,17 @@ await resetPasswordMfaWebAuthnRoamingChallengeManager.tryAnotherMethod(); **Method Parameters** + + + [ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions). + -ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions}> - - - When `true`, preserves the remember-device preference when switching methods. - - - - Additional data collected from the user. - + + When `true`, preserves the remember-device preference when switching methods. -*** @@ -195,16 +183,13 @@ try { **Method Parameters** + + + [ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions). + -ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions}> - - - When `true`, marks the device as trusted so the user is not prompted for MFA again on this device. - - - - Additional data collected from the user. - + + When `true`, marks the device as trusted so the user is not prompted for MFA again on this device. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordRequest.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordRequest.mdx index a9751bef10..5c16e2c406 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordRequest.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordRequest.mdx @@ -66,21 +66,7 @@ import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; const resetPasswordRequestManager = new ResetPasswordRequest(); await resetPasswordRequestManager.backToLogin(); ``` - -**Method Parameters** - - - -CustomOptions}> - - - Additional data collected from the user. - - - - -*** @@ -97,25 +83,21 @@ resetPasswordRequestManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> @@ -148,20 +130,17 @@ await resetPasswordRequestManager.resetPassword({ username: 'testuser' }); **Method Parameters** + + + [ResetPasswordRequestOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordRequestOptions). + -ResetPasswordRequestOptions}> - - - The username or email address of the account to reset. - - - - The CAPTCHA response token, if CAPTCHA is enabled for this tenant. - + + The username or email address of the account to reset. + - - Additional data collected from the user. - + + The CAPTCHA response token, if CAPTCHA is enabled for this tenant. diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordSuccess.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordSuccess.mdx index 43e8aac4aa..5a90145e7e 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordSuccess.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/ResetPasswordSuccess.mdx @@ -71,25 +71,21 @@ resetPasswordSuccessManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - - - - When set to `'session'`, the selected language persists for the duration of the session. - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + When set to `'session'`, the selected language persists for the duration of the session. -*** Error[]}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/Signup.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/Signup.mdx index dad6028d64..09842cbc90 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Signup.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Signup.mdx @@ -76,24 +76,24 @@ signupManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -111,20 +111,16 @@ signupManager.federatedSignup({ -FederatedSignupPayloadOptions}> - - - The social connection name to use. - + + [FederatedSignupPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions). + - - Additional data collected from the user. - + + The social connection name to use. -*** Error[]}> @@ -174,36 +170,36 @@ signupManager.signup({ -SignupPayloadOptions}> + + [SignupPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPayloadOptions). + - - The user's email. - + + The user's email. + - - The user's identifier. - + + The user's identifier. + - - The user's phone number. - + + The user's phone number. + - - The user's password. - + + The user's password. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** PasswordValidationResult}> @@ -225,7 +221,6 @@ const result = signupManager.validatePassword('P@$wOrd123!'); -*** UsernameValidationResult}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx index 6344693509..43d3d58b35 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx @@ -75,28 +75,28 @@ signupIdManager.changeLanguage({ -LanguageChangeOptions}> + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** -This method handles allows signup via different social identifiers. For example: Google, Facebook, etc. +This method handles signup via different social identifiers. For example: Google, Facebook, etc. ```typescript Example import SignupId from '@auth0/auth0-acul-js/signup-id'; @@ -110,20 +110,16 @@ signupIdManager.federatedSignup({ -FederatedSignupOptions}> - - - The social connection name to use. - + + [FederatedSignupOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions). + - - Additional data collected from the user. - + + The social connection name to use. -*** Error[]}> @@ -172,32 +168,32 @@ signupIdManager.signup({ -SignupOptions}> + + [SignupOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SignupOptions). + - - The user's email. - + + The user's email. + - - The user's identifier. - + + The user's identifier. + - - The user's phone number. - + + The user's phone number. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** UsernameValidationResult}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/classes/SignupPassword.mdx b/main/docs/libraries/acul/js-sdk/Screens/classes/SignupPassword.mdx index da580e27b8..baf41eb3e2 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/SignupPassword.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/SignupPassword.mdx @@ -75,25 +75,25 @@ signupPasswordManager.changeLanguage({ **Method Parameters** + + + [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions). + -LanguageChangeOptions}> - - - The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). - + + The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`). + - - When set to `'session'`, the selected language persists for the duration of the session. - + + When set to `'session'`, the selected language persists for the duration of the session. + - - Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -110,21 +110,17 @@ signupPasswordManager.federatedSignup({ **Method Parameters** + + + [FederatedSignupPasswordPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions). + -FederatedSignupPasswordPayloadOptions}> - - - The social connection name to use. - - - - Additional data collected from the user. - + + The social connection name to use. -*** Error[]}> @@ -148,37 +144,37 @@ signupPasswordManager.signup({ **Method Parameters** + + + [SignupPasswordOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPasswordOptions). + -SignupPasswordOptions}> - - - The user's email. - + + The user's email. + - - The user's identifier. - + + The user's identifier. + - - The user's phone number. - + + The user's phone number. + - - The user's password. - + + The user's password. + - - The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. - + + The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** @@ -195,21 +191,21 @@ signupPasswordManager.switchConnection({ **Method Parameters** + + + [SwitchConnectionOptionsSignupPassword](/docs/libraries/acul/js-sdk/Screens/interfaces/SwitchConnectionOptionsSignupPassword). + -SwitchConnectionOptionsSignupPassword}> - - - The connection identifier to switch to during the signup-password authentication flow. - + + The connection identifier to switch to during the signup-password authentication flow. + - - Additional data collected from the user. - + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). -*** PasswordValidationResult}> @@ -224,7 +220,7 @@ const result = signupPasswordManager.validatePassword('MyP@ssw0rd!'); **Method Parameters** - + The password string to validate. diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx index f468765543..f61f270687 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx @@ -11,10 +11,6 @@ export interface ConfirmLogoutOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx index abfd8e8d32..84d39f0da5 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx @@ -15,12 +15,6 @@ export interface ContinueOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOptions.mdx index c0d5409ccb..3e9ea934b7 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinueOptions.mdx @@ -15,12 +15,6 @@ export interface ContinueOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx index f4d6e58677..63afeed3df 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx @@ -15,12 +15,6 @@ export interface ContinueOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions.mdx index f9f6e392c3..ca1f984720 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions.mdx @@ -8,6 +8,8 @@ export interface CustomOptions { } ``` -## Indexable +## Properties -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file + + Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`). + \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx index ba39534685..6df8257e0d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -14,10 +14,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx index 8ff8509f17..43212197f3 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx @@ -10,10 +10,6 @@ export interface EmailChallengeOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx index 7b646f0c89..fb324e7593 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx @@ -9,10 +9,6 @@ export interface FederatedLoginOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx index b9774a2b53..f46d4372d7 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx @@ -3,16 +3,12 @@ title: "FederatedLoginPasswordOptions" --- ```ts Example -export interface FederatedLoginOptions { +export interface FederatedLoginPasswordOptions { connection: string; [key: string]: string | number | boolean; } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx index 27ea315c0a..70264ed34e 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx @@ -5,7 +5,7 @@ title: "FederatedLoginPayloadOptions" Options for performing social login operations ```ts Example -export interface FederatedLoginOptions { +export interface FederatedLoginPayloadOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ @@ -13,12 +13,6 @@ export interface FederatedLoginOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx index 19e6f6c1d3..b21afe05af 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx @@ -9,10 +9,6 @@ export interface FederatedSignupOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx index 894035d333..6794d32375 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx @@ -3,16 +3,12 @@ title: "FederatedSignupPasswordPayloadOptions" --- ```ts Example -export interface FederatedSignupOptions { +export interface FederatedSignupPasswordPayloadOptions { connection: string; [key: string]: string | number | boolean; } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx index 073a4cc549..fb48dad942 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx @@ -3,16 +3,12 @@ title: "FederatedSignupPayloadOptions" --- ```ts Example -export interface FederatedSignupOptions { +export interface FederatedSignupPayloadOptions { connection: string; [key: string]: string | number | boolean; } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx index 31557a3e69..9abf05ef88 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx @@ -13,12 +13,6 @@ export interface LoginEnrollOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties MfaLoginFactorType}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx index d6407b106d..6c28399d85 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx @@ -13,12 +13,6 @@ export interface MfaEnrollOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties MfaEnrollFactorType}> diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx index 3d55ec7d6b..155ece3e21 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx @@ -18,12 +18,6 @@ export interface ContinueOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options. - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx index ea7b69c6ea..f376bb0d8c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -10,10 +10,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx index 6158a21172..239fc1a775 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx @@ -11,10 +11,4 @@ export interface TryAnotherMethodOptions { */ [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options. \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx index afe1a15c44..50c3087276 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -18,10 +18,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx index 66c198c5d3..f8f443909f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -8,8 +8,4 @@ This allows the user to choose a different MFA method if available. ```ts Example export interface PickAuthenticatorOptions extends CustomOptions {} -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx index 5f871c74c5..59a2ffd447 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -9,8 +9,4 @@ in scenarios where the server needs to redirect to a phone selection screen. ```ts Example export interface PickPhoneOptions extends CustomOptions {} -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx index d42ad371e5..322d661bf1 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -13,10 +13,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPushEnrollmentQrWithRememberOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPushEnrollmentQrWithRememberOptions.mdx index 7ce89d3bee..d566e855ce 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPushEnrollmentQrWithRememberOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaPushEnrollmentQrWithRememberOptions.mdx @@ -9,10 +9,6 @@ export interface MfaPushEnrollmentQrWithRememberOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx index 597d9577fd..96b7470bbf 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -10,10 +10,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx index de15413597..d216b7c818 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -9,8 +9,4 @@ export interface ContinueOptions extends CustomOptions { // No specific properties required beyond CustomOptions. // The 'saved' parameter is handled internally by the continue method. } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx index 56b2c05682..fb40590044 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -8,10 +8,6 @@ export interface MfaRecoveryCodeEnrollmentContinueOptions extends CustomOptions } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx index bf9bd42f83..26fe8e009f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx @@ -10,10 +10,6 @@ export interface MfaSmsChallengeOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx index f6bc4f90cc..c19c5d3f78 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx @@ -10,10 +10,6 @@ export interface MfaSmsEnrollmentOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx index 05c842a846..20f71a3e84 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx @@ -16,12 +16,6 @@ export interface MfaSmsListOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx index 863fb34d02..f626073c26 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx @@ -23,12 +23,6 @@ export interface MfaVoiceChallengeContinueOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Additional custom options to pass with the request. - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx index 407e72a60e..a9426325f2 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -10,10 +10,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx index 410da5fb7e..983dcb5562 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -18,10 +18,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx index d609598747..4d86b3a140 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -6,8 +6,4 @@ TryAnotherMethodOptions ```ts Example export interface TryAnotherMethodOptions extends CustomOptions {} -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx index d6a7058dc5..e07ad66b53 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -6,8 +6,4 @@ TryAnotherMethodOptions ```ts Example export interface TryAnotherMethodOptions extends CustomOptions {} -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx index 3b0450308c..da903b368a 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx @@ -11,10 +11,4 @@ export interface TryAnotherMethodOptions { */ [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options. \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx index 44aef5509b..bb8fa40fa1 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx @@ -10,10 +10,6 @@ export interface PhoneChallengeOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx index 2cc1c8e62a..0799af7e43 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx @@ -9,10 +9,6 @@ export interface PhoneEnrollmentOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx index 089a5126b4..77d10e296a 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx @@ -6,8 +6,4 @@ title: "ResetPasswordEmailOptions" export interface ResetPasswordEmailOptions { [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx index aea6f29c58..f4fe5ee84e 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx @@ -13,12 +13,6 @@ export interface ContinueOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx index 63451fb2ff..b4d7246b9c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx @@ -9,10 +9,4 @@ export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx index e2952f6349..645aca0c49 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -16,10 +16,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx index 7613ee5c25..8313aabde1 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -17,10 +17,6 @@ export interface TryAnotherMethodOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx index 88b20769a5..826b2ea6dc 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx @@ -9,10 +9,6 @@ export interface MfaSmsChallengeOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx index 84ced71c81..5300cc9a86 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -13,10 +13,6 @@ export interface ContinueOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx index 4776cb0d72..860c1a5710 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -15,10 +15,6 @@ export interface ContinueWithPasskeyOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx index e72e1b42a9..0634f957f9 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -9,8 +9,4 @@ export interface TryAnotherMethodOptions extends CustomOptions { // Currently, no specific properties beyond CustomOptions are defined for this action. // This interface is here for future extensibility. } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx index 2ac698b2d4..c3953d9fc4 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -16,10 +16,6 @@ export interface TryAnotherMethodOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx index c687c176ec..d9608700d3 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -17,10 +17,6 @@ export interface UseSecurityKeyOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx index c8f72b6d3f..cdf0b02d16 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx @@ -10,10 +10,6 @@ export interface ResetPasswordOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx index 0ed8ea86b9..5884f56fdf 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx @@ -10,10 +10,6 @@ export interface ResetPasswordRequestOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx index e5d202eeee..f03fd9ef9d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx @@ -16,12 +16,6 @@ export interface SelectMfaEmailOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx index 9ad05a9317..38b6bd339c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx @@ -15,10 +15,6 @@ export interface SelectMfaPushDeviceOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx index 7f5872b18f..5f082a4887 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx @@ -9,10 +9,6 @@ export interface SubmitCaptchaOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` - ## Properties \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx index 24692abe29..ffbead1fcb 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx @@ -9,10 +9,4 @@ export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx index 488f45b403..048927f5ba 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx @@ -9,10 +9,4 @@ export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx index e4a896c792..aae666c11d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx @@ -9,10 +9,4 @@ export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - -Any additional custom options \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx index 936d05fb51..6e984f5628 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -15,10 +15,6 @@ export interface VerifyPlatformAuthenticatorOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx index ad72fc90ee..648af0cda2 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx @@ -10,10 +10,6 @@ export interface VerifySecurityKeyOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx index 28554e4efc..9f332b77df 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -9,8 +9,4 @@ export interface ContinueOptions extends CustomOptions { // No screen-specific properties are required for the 'continue' action beyond CustomOptions. // The server uses `action: "default"` for this operation. } -``` - -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file +``` \ No newline at end of file diff --git a/main/docs/libraries/acul/js-sdk/Screens/interfaces/WithRememberOptions.mdx b/main/docs/libraries/acul/js-sdk/Screens/interfaces/WithRememberOptions.mdx index c0646fa4cf..1e8ce5495d 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/interfaces/WithRememberOptions.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/interfaces/WithRememberOptions.mdx @@ -8,10 +8,6 @@ export interface WithRememberOptions extends CustomOptions { } ``` -## Indexable - -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` - ## Properties \ No newline at end of file