Class Signup

Hierarchy

BaseContext
- Signup

Implements

Screens.SignupMembers

Index

Constructors

constructor

new Signup(): Signup
Returns Signup
Overrides BaseContext.constructor
- Defined in src/screens/signup/index.ts:30

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnSignup

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembersOnSignup

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.SIGNUP

Methods - Language

changeLanguage

changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>
Utility Feature
Changes the language/locale for the current authentication flow.

This method triggers a language change by submitting the new locale preference to the server with the 'change-language' action. The language change will cause the current screen to re-render with the new locale.
Parameters
- options: Screens.LanguageChangeOptions
  Language change options including the target language code
  
  Options for changing the language/locale during the authentication flow
  - [key: string]: string | number | boolean | undefined
    Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.
  - language: string
    Short language name (locale code) to be set (e.g., 'en', 'fr', 'es').
  - Optionalpersist?: "session"
    Defines persistence scope for the language preference. Currently only 'session' is supported.
    
    Default
    'session'
Returns Promise<void>
A promise that resolves when the form submission is complete
Example
```
import LoginId from "@auth0/auth0-acul-js/login-id";

const loginManager = new LoginId();

// Change language to French
await loginManager.changeLanguage({
  language: 'fr',
  persist: 'session'
});
```
Example
```
import LoginPassword from "@auth0/auth0-acul-js/login-password";

const loginPasswordManager = new LoginPassword();

// Change language to Spanish with additional custom data
await loginPasswordManager.changeLanguage({
  language: 'es',
  persist: 'session',
  'ulp-custom-field': 'custom-value'
});
```
Remarks
- This method is available on all screen instances that extend BaseContext
- The language must be one of the enabled locales configured in your Auth0 tenant
- The screen will automatically re-render with the new language after submission
- Custom fields can be included and will be accessible in the Post Login Trigger
Implementation of SignupMembers.changeLanguage
Inherited from BaseContext.changeLanguage
- Defined in src/models/base-context.ts:156

Methods - Other

federatedSignup

federatedSignup(payload: Screens.FederatedSignupPayloadOptions): Promise<void>
Handles the submission of the social signup form.
Parameters
- payload: Screens.FederatedSignupPayloadOptions
  The payload containing the social signup options.
Returns Promise<void>
Remarks
This method is similar to the signup method but is used for social signups.
Example
```
import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.federatedSignup({
 connection: 'google-oauth2'
});
```
Implementation of SignupMembers.federatedSignup
- Defined in src/screens/signup/index.ts:82

getErrors

getErrors(): Screens.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Screens.Error[]
An array of error objects from the transaction context.
Implementation of SignupMembers.getErrors
Inherited from BaseContext.getErrors
- Defined in src/models/base-context.ts:103

getSignupIdentifiers

getSignupIdentifiers(): Screens.Identifier[] | null
Utility Feature
Returns the list of enabled identifiers for the signup form, marking each as required or optional based on transaction config.

Returns Screens.Identifier[] | null
Array of identifier objects (e.g., email, phone, username).
Example
```
const signup = new Signup();
const identifiers = signup.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]
```
Implementation of SignupMembers.getSignupIdentifiers
- Defined in src/screens/signup/index.ts:129

pickCountryCode

pickCountryCode(): Promise<void>
Returns Promise<void>
Example
```
import Signup from "@auth0/auth0-acul-js/signup";
const signupManager = new Signup();

signupManager.pickCountryCode();
```
Implementation of SignupMembers.pickCountryCode
- Defined in src/screens/signup/index.ts:97

signup(payload: Screens.SignupPayloadOptions): Promise<void>
Parameters
- payload: Screens.SignupPayloadOptions
Returns Promise<void>
Remarks
This method handles the submission of the signup form.
Example
```
import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.signup({
 email: 'test@example.com',
 password: 'P@$$wOrd123!',
});
```
Implementation of SignupMembers.signup
- Defined in src/screens/signup/index.ts:54

validatePassword

validatePassword(password: string): Screens.PasswordValidationResult
Utility Feature
Parameters
- password: string
Returns Screens.PasswordValidationResult
An object of type PasswordValidationResult indicating whether the password is valid and why.
Implementation of SignupMembers.validatePassword
- Defined in src/screens/signup/index.ts:113

validateUsername

validateUsername(username: string): Screens.UsernameValidationResult
Utility Feature
Validates a given username against the current username policy defined in the transaction context.
Parameters
- username: string
  The username string to validate.
Returns Screens.UsernameValidationResult
Result object indicating whether the username is valid and why.
Example
```
const signup = new Signup();
const result = signup.validateUsername('myusername');
// result => { valid: true, errors: [] }
```
Implementation of SignupMembers.validateUsername
- Defined in src/screens/signup/index.ts:150

Class Signup

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns Signup

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

StaticscreenIdentifier

Methods - Language

changeLanguage

Parameters

[key: string]: string | number | boolean | undefined

language: string

Optionalpersist?: "session"

Default

Returns Promise<void>

Example

Example

Remarks

Methods - Other

federatedSignup

Parameters

Returns Promise<void>

Remarks

Example

getErrors

Returns Screens.Error[]

getSignupIdentifiers

Returns Screens.Identifier[] | null

Example

pickCountryCode

Returns Promise<void>

Example

signup

Parameters

Returns Promise<void>

Remarks

Example

validatePassword

Parameters

Returns Screens.PasswordValidationResult

validateUsername

Parameters

Returns Screens.UsernameValidationResult

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"