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 8becad4b1..dac6678ce 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx @@ -8,7 +8,7 @@ The Login class implements the `login` screen functionality. This screen collect ## Constructors -Creates an instance of Login screen manager +Create an instance of Login screen manager ```ts Example import Login from "@auth0/auth0-acul-js/login"; @@ -22,7 +22,7 @@ loginManager.login({ ## Properties BrandingMembers}> -Provides branding-related configurations, such as theme settings for the `login` screen. +Provides branding-related configurations, such as branding theme and settings. ClientMembers}> @@ -77,11 +77,11 @@ loginManager.federatedLogin({ -The social connection name to use +The social connection name to use. -The authentication transaction state +Additional data collected from the user. @@ -120,7 +120,7 @@ The captcha code or response from the captcha provider. This property is require -The authentication transaction state +Additional data collected from the user. @@ -142,7 +142,7 @@ loginManager.pickCountryCode(); -The authentication transaction state +Additional data collected from the user. @@ -151,21 +151,14 @@ The authentication transaction state Error[]}> -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. +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. ---- ScreenIdentifierType[]}> -**`Utility Feature`** - -Gets the active identifier types for the login screen - -An array of active identifier types or null if none are active +This method lets the active identifier types for the login screen. An array of active identifier types or `null` if none are active ```typescript Example import Login from "@auth0/auth0-acul-js/login"; 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 b026e5d42..95f110cdd 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx @@ -10,7 +10,7 @@ to verify their identity during the login process. ## Constructors -Creates an instance of LoginEmailVerification screen manager +Create an instance of LoginEmailVerification screen manager ```typescript Example // How to use the LoginEmailVerification screen SDK: @@ -24,11 +24,11 @@ const loginEmailVerificationManager = new LoginEmailVerification(); ## Properties BrandingMembers}> -Provides branding-related configurations, such as theme settings for the `login-email-verification` screen. +Provides branding-related configurations, such as branding theme and settings. ClientMembers}> -Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login-email-verification`screen. +Provides client-related configurations, such as `id`, `name`, and `logoUrl`. OrganizationMembers}> @@ -88,7 +88,7 @@ or alphanumeric string that the user must enter into the form. -The authentication transaction state +Additional data collected from the user. @@ -120,7 +120,7 @@ manager.resendCode() -The authentication transaction state +Additional data collected from the user. @@ -129,7 +129,7 @@ The authentication transaction state -This method resends functionality with timeout management for this screen +This method gets resend functionality with timeout management for this screen. ```typescript Example import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; @@ -153,7 +153,9 @@ startResend(); -OnStatusChangeCallback}/> +OnStatusChangeCallback}> +Callback function for status changes during resend countdown. + @@ -165,8 +167,6 @@ startResend(); Error[]}> -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. +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. 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 014546624..57ed4571f 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx @@ -18,7 +18,7 @@ loginIdManager.getLoginIdentifiers(); ## Properties BrandingMembers}> -Provides branding-related configurations, such as theme settings for the `login-id` screen. +Provides branding-related configurations, such as branding theme and settings. ClientMembers}> @@ -84,10 +84,6 @@ loginIdManager.federatedLogin({ **Method Parameters** - -An object containing the necessarty parameters for selecting a specific social connection for login. - - @@ -95,14 +91,14 @@ The social connection name to use -The authentication transaction state +Additional data collected from the user. --- - + This method prompts the user to provide their username. @@ -129,7 +125,7 @@ The captcha code or response from the captcha provider. This property is require -The authentication transaction state +Additional data collected from the user. @@ -153,7 +149,7 @@ loginIdManager.passkeyLogin(); -The authentication transaction state +Additional data collected from the user. @@ -175,16 +171,16 @@ loginIdManager.pickCountryCode(); -The authentication transaction state +Additional data collected from the user. --- - + -Registers the browser's Conditional UI for passkeys (autocomplete experience). +This method registers the browser's Conditional UI for passkeys (autocomplete experience). This method initializes a passive WebAuthn credential request using `navigator.credentials.get()` with `mediation: "conditional"`. When supported, @@ -195,7 +191,21 @@ Call this **once** when the login screen is initialized (for example, on page lo After registration, focusing the username input will automatically display matching passkeys as suggestions. Selecting a passkey completes authentication without requiring additional user interaction. - + +```ts Example +import LoginId from '@auth0/auth0-acul-js/login-id'; + +// Example: initializing passkey autocomplete inside an async setup block. +async function initializeLogin() { + const loginId = new LoginId(); + // Make sure associated HTML input exists: + // + // Conditional UI registration. + await loginId.registerPasskeyAutofill('username'); +} + +initializeLogin().catch(console.error); +``` **Input configuration** If an `inputId` is provided, the SDK will: @@ -221,27 +231,16 @@ the input element manually with the correct attributes: **Method Parameters** + + -`string` Optional ID of the username `` element (without `#`). Example: `"username"`. If omitted, the developer must manually ensure the correct `autocomplete` attributes. -```ts Example -import LoginId from '@auth0/auth0-acul-js/login-id'; - -// Example: initializing passkey autocomplete inside an async setup block. -async function initializeLogin() { - const loginId = new LoginId(); - // Make sure associated HTML input exists: - // - // Conditional UI registration. - await loginId.registerPasskeyAutofill('username'); -} + -initializeLogin().catch(console.error); -``` **Remarks** @@ -253,16 +252,15 @@ only be invoked once per page lifecycle. Error[]}> -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. ---- ScreenIdentifierType[]}> -Gets the active identifier types for the login screen +This method gets the active identifier types for the login screen. ```typescript Example import LoginId from "@auth0/auth0-acul-js/login"; 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 72dfb58bb..e176a5fea 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx @@ -8,7 +8,7 @@ The LoginPassword class implements the `login-password` screen functionality. Th ## Constructors -Creates an instance of LoginPassword screen manager +Create an instance of LoginPassword screen manager ```ts Example import LoginPassword from "@auth0/auth0-acul-js/login-password"; @@ -22,11 +22,11 @@ loginPasswordManager.login({ ## Properties BrandingMembers}> -Provides branding-related configurations, such as theme settings for the `login-password` screen. +Provides branding-related configurations, such as branding theme and settings. ClientMembers}> -Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login-password` screen. +Provides client-related configurations, such as `id`, `name`, and `logoUrl`. OrganizationMembers}> @@ -89,11 +89,11 @@ loginIdManager.federatedLogin({ -The social connection name to use +The social connection name to use. -The authentication transaction state +Additional data collected from the user. @@ -129,7 +129,7 @@ The captcha code or response from the captcha provider. This property is require -The authentication transaction state +Additional data collected from the user. @@ -160,11 +160,11 @@ handleSwitchConnection('sms'); // Switch to SMS-based authentication -The social connection name to use +The social connection name to use. -The authentication transaction state +Additional data collected from the user. @@ -173,8 +173,6 @@ The authentication transaction state Error[]}> -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. +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. 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 bc7920b8b..9f45f8588 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx @@ -70,9 +70,7 @@ Details of the active user, including `username`, `email`, and `roles`. Error[]}> -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. +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. @@ -93,7 +91,7 @@ loginPasswordlessEmailCode.resendCode(); -The authentication transaction state +Additional data collected from the user. @@ -165,11 +163,9 @@ The code entered by the user. -The authentication transaction state +Additional data collected from the user. -Additional data collected from the user. - --- 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 05e836bef..83d5052fd 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx @@ -128,7 +128,7 @@ loginPasswordlessSmsOtp.resendOTP(); -The authentication transaction state +Additional data collected from the user. 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 78eb8861c..3ddb93667 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Logout.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Logout.mdx @@ -8,7 +8,7 @@ The Logout class implements the `logout` screen functionality. This screen allow ## Constructors -Creates an instance of the Logout screen manager. +Create an instance of the Logout screen manager. ```ts Example import Logout from '@auth0/auth0-acul-js/logout'; @@ -75,11 +75,11 @@ await logout.confirmLogout({ action: 'accept' }); -The authentication transaction state +The authentication transaction state. -The authentication transaction state +Additional data collected from the user. @@ -88,8 +88,6 @@ The authentication transaction state Error[]}> -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. +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. 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 320b99ccb..722678512 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/Signup.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/Signup.mdx @@ -2,90 +2,102 @@ title: "Signup" --- +The Signup class implements the `signup` screen functionality. This screen collects the user's identifier and password. Depending on your tenant, this identifer can be an email, phone number, or username. + ACUL Signup screen image +## Constructors + +Create an instance of Signup screen manager + ```ts Example import Signup from '@auth0/auth0-acul-js/signup'; - const signupManager = new Signup(); - signupManager.signup({ email: 'test@example.com', password: 'P@$wOrd123!', }); ``` -## Constructors - - ## Properties -BrandingMembers}/> +BrandingMembers}> +Provides branding-related configurations, such as branding theme and settings. + -ClientMembers}/> +ClientMembers}> +Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login` screen. + -OrganizationMembers}/> +OrganizationMembers}> +Provides information about the user's organization, such as organization `id` and `name`. + -PromptMembers}/> +PromptMembers}> +Contains data about the current prompt in the authentication flow. + -ScreenMembersOnSignup}/> +ScreenMembersOnSignup}> +Contains details specific to the `signup` screen, including its configuration and context. + -TenantMembers}/> +TenantMembers}> +Contains data related to the tenant, such as `id` and associated metadata. + -TransactionMembersOnSignup}/> +TransactionMembersOnSignup}> +Provides transaction-specific data for the `signup` screen, such as active identifiers and flow states. + -UntrustedDataMembers}/> +UntrustedDataMembers}> +Handles untrusted data passed to the SDK, such as user input during login. + -UserMembers}/> +UserMembers}> +Details of the active user, including `username`, `email`, and `roles`. + - ## Methods - - -Handles the submission of the social signup form. + -#### Remarks - -This method is similar to the [signup](#signup) method but is used for social signups. +This method handles the submission of the social signup form. It is similar to the [signup](#signup) method but is used for social signups. ```typescript Example import Signup from '@auth0/auth0-acul-js/signup'; - const signupManager = new Signup(); - signupManager.federatedSignup({ connection: 'google-oauth2' }); ``` +**Method Parameters** + -FederatedSignupPayloadOptions}> -**Properties** - + +The social connection name to use. - + +Additional data collected from the user. -Error[]}> + -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. +Error[]}> + +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. Identifier[]}> -**`Utility Feature`** - -Returns the list of enabled identifiers for the signup form, -marking each as required or optional based on transaction config. - -Array of identifier objects (e.g., email, phone, username). +This method returns the list of enabled identifiers for the signup form, +marking each as required or optional based on transaction config. An Array of identifier objects (e.g., email, phone, username). ```ts Example const signup = new Signup(); @@ -95,7 +107,9 @@ const identifiers = signup.getSignupIdentifiers(); - + + +This method redirects the user to the country code selection list, where they can update the country code prefix for their phone numnber. ```ts Example import Signup from "@auth0/auth0-acul-js/signup"; @@ -104,11 +118,19 @@ const signupManager = new Signup(); signupManager.pickCountryCode(); ``` +**Method Parameters** + + + +Additional data collected from the user. - + -#### Remarks +--- + + + This method handles the submission of the signup form. @@ -123,35 +145,43 @@ signupManager.signup({ }); ``` - -SignupPayloadOptions}> +**Method Parameters** -**Properties** + - + +The user's identifier. + - + +The user's password. + - + +The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled. + - + +The user's email. + - + +The user's phone number. - + +--- PasswordValidationResult}> -**`Utility Feature`** +This method returns an object of type [PasswordValidationResult](/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult) indicating whether the password is valid and why. -An object of type [PasswordValidationResult](/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult) indicating whether the password is valid and why. +**Method Parameters** - -`string` - + +The user's password. @@ -159,12 +189,7 @@ An object of type [PasswordValidationResult](/docs/libraries/acul/js-sdk/Screens UsernameValidationResult}> -**`Utility Feature`** - -Validates a given username against the current username policy -defined in the transaction context. - -Result object indicating whether the username is valid and why. +This method validates a given username against the current username policy defined in the transaction context. It returns an object indicating whether the username is valid and why. ```ts Example const signup = new Signup(); @@ -172,13 +197,12 @@ const result = signup.validateUsername('myusername'); // result => { valid: true, errors: [] } ``` - - -`string` - -The username string to validate. +**Method Parameters** + + +`The username string to validate. - \ No newline at end of file + 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 fb41ac3eb..b5db8e87c 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx @@ -2,8 +2,14 @@ title: "SignupId" --- +The SignupId class implements the `signup-id` screen functionality. This screen collects the user's identifier. + Signup ID + +## Constructors +Create an instance of SignupId screen manager + ```ts Example import SignupId from "@auth0/auth0-acul-js/signup-id"; const signupIdManager = new SignupId(); @@ -18,39 +24,50 @@ const signupParams = { signupIdManager.signup(signupParams); ``` -## Constructors - ## Properties -BrandingMembers}/> - -ClientMembers}/> +BrandingMembers}> +Provides branding-related configurations, such as branding theme and settings. + -OrganizationMembers}/> +ClientMembers}> +Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login` screen. + -PromptMembers}/> +OrganizationMembers}> +Provides information about the user's organization, such as organization `id` and `name`. + -ScreenMembersOnSignupId}/> +PromptMembers}> +Contains data about the current prompt in the authentication flow. + -TenantMembers}/> +ScreenMembersOnSignupId}> +Contains details specific to the `signup-id` screen, including its configuration and context. + -TransactionMembersOnSignupId}/> +TenantMembers}> +Contains data related to the tenant, such as `id` and associated metadata. + -UntrustedDataMembers}/> +TransactionMembersOnSignupId}> +Provides transaction-specific data for the `signup-id` screen, such as active identifiers and flow states. + -UserMembers}/> +UntrustedDataMembers}> +Handles untrusted data passed to the SDK, such as user input during login. + - +UserMembers}> +Details of the active user, including `username`, `email`, and `roles`. + ## Methods - + -#### Remarks - -This methods handles allows signup via different social identifiers. -Eg: Google, Facebook etc. +This method handles allows signup via different social identifiers. For example: Google, Facebook etc. ```ts Example import SignupId from "@auth0/auth0-acul-js/signup-id"; @@ -68,33 +85,31 @@ const signupParams = { signupIdManager.federatedSignup(signupParams); ``` +**Method Parameters** + -FederatedSignupOptions}> -**Properties** + +The social connection name to use. + - + +Additional data collected from the user. - -Error[]}> +--- -Retrieves the array of transaction errors from the context, or an empty array if none exist. +Error[]}> -An array of error objects from the transaction context. +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. Identifier[]}> -**`Utility Feature`** - -Returns the list of enabled identifiers for the signup-id form, -marking each as required or optional based on transaction config. - -Array of identifier objects (e.g., email, phone, username). +This method returns the list of enabled identifiers for the `signup-id` form, marking each as required or optional based on transaction config. An Array of identifier objects (e.g., email, phone, username). ```ts Example const signupId = new SignupId(); @@ -104,7 +119,9 @@ const identifiers = signupId.getSignupIdentifiers(); - + + +This method redirects the user to the country code selection list, where they can update the country code prefix for their phone numnber. ```ts Example import SignupId from "@auth0/auth0-acul-js/signup-id"; @@ -113,14 +130,20 @@ const signupIdManager = new SignupId(); signupIdManager.pickCountryCode(); ``` +**Method Parameters** + + + +Additional data collected from the user. - + -#### Remarks +--- -This methods handles signup-id related configuration. -It allows to signup new users via different identifiers. + + +This methods handles `signup-id` related configuration. It allows to signup new users via different identifiers. ```ts Example import SignupId from "@auth0/auth0-acul-js/signup-id"; @@ -140,45 +163,50 @@ const signupParams = { signupIdManager.signup(signupParams); ``` - -SignupOptions}> +**Method Parameters** -**Properties** + - + +The user's identifier. + - + +The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled. + - + +The user's email. + - + +The user's phone number. - + +Additional data collected from the user. -UsernameValidationResult}> + -**`Utility Feature`** +--- -Validates a given username against the current username policy -defined in the transaction context. +UsernameValidationResult}> -Result object indicating whether the username is valid and why. +This method validates a given username against the current username policy defined in the transaction context. It returns an object indicating whether the username is valid and why. ```ts Example -const signupIdManager = new SignupId(); -const result = signupIdManager.validateUsername('myusername'); +const signup = new Signup(); +const result = signup.validateUsername('myusername'); // result => { valid: true, errors: [] } ``` - - -`string` - -The username string to validate. +**Method Parameters** + + +`The username string to validate. - \ No newline at end of file + 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 071e30806..c249fd4e8 100644 --- a/main/docs/libraries/acul/js-sdk/Screens/classes/SignupPassword.mdx +++ b/main/docs/libraries/acul/js-sdk/Screens/classes/SignupPassword.mdx @@ -2,6 +2,12 @@ title: "SignupPassword" --- +The SignupPassword class implements the `signup-password` screen functionality. This screen collects the user's password. + +## Constructors + +Create an instance of SignupPassword screen manager + Signup Password with Flexible IDs ```ts Example @@ -16,39 +22,49 @@ console.log(validationResults); // ] ``` -## Constructors - - ## Properties -BrandingMembers}/> - -ClientMembers}/> +BrandingMembers}> +Provides branding-related configurations, such as branding theme and settings. + -OrganizationMembers}/> +ClientMembers}> +Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login` screen. + -PromptMembers}/> +OrganizationMembers}> +Provides information about the user's organization, such as organization `id` and `name`. + -ScreenMembersOnSignupPassword}/> +PromptMembers}> +Contains data about the current prompt in the authentication flow. + -TenantMembers}/> +ScreenMembersOnSignupPassword}> +Contains details specific to the `signup-password` screen, including its configuration and context. + -TransactionMembersOnSignupPassword}/> +TenantMembers}> +Contains data related to the tenant, such as `id` and associated metadata. + -UntrustedDataMembers}/> +TransactionMembersOnSignupPassword}> +Provides transaction-specific data for the `signup-password` screen, such as active identifiers and flow states. + -UserMembers}/> +UntrustedDataMembers}> +Handles untrusted data passed to the SDK, such as user input during login. + - +UserMembers}> +Details of the active user, including `username`, `email`, and `roles`. + ## Methods - - -#### Remarks + -This methods handles allows signup via different social identifiers. -Eg: Google, Facebook etc. +This methods handles allows signup via different social identifiers. For example: Google, Facebook etc. ```ts Example import SignupPassword from "@auth0/auth0-acul-js/signup-id"; @@ -66,31 +82,31 @@ const signupParams = { signupIdManager.federatedSignup(signupParams); ``` +**Method Parameters** + -FederatedSignupPasswordPayloadOptions}> -**Properties** + +The social connection name to use. + - + +Additional data collected from the user. - -Error[]}> +--- -Retrieves the array of transaction errors from the context, or an empty array if none exist. +Error[]}> -An array of error objects from the transaction context. +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. - + -#### Remarks - -This methods handles signup-password related screen configuration. -It allows to proceed with registering signup password along with signup identifiers passed in previous screen +This methods handles signup-password related screen configuration. It allows to proceed with registering signup password along with signup identifiers passed in previous screen ```ts Example import SignupPassword from "@auth0/auth0-acul-js/signup-password"; @@ -113,33 +129,42 @@ const signupParams = { signupPasswordManager.signup(signupParams); ``` +**Method Parameters** + -SignupPasswordOptions}> -**Properties** - + +The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled. + - + +The user's email. + - + +The user's password. + - + +The user's phone number. + - + +The user's identifier. - + +Additional data collected from the user. -PasswordValidationResult}> + -**`Utility Feature`** +--- -Validates a password string against the current transaction's password policy. +PasswordValidationResult}> -This method retrieves the password policy from the current transaction context -and delegates the actual validation to `coreValidatePassword`. +This method validates a password string against the current transaction's password policy. This method retrieves the password policy from the current transaction context and delegates the actual validation to `coreValidatePassword`. It returns an array of validation results, each containing: - `code`: the identifier of the password rule, @@ -158,13 +183,13 @@ console.log(validationResults); // ] ``` - - -`string` -The password string to validate. +**Method Parameters** + + +The password string to validate. - \ No newline at end of file +