> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.generaltranslation.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Inscription

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/generaltranslationinc/Tx-zTp2kMjjdY0gu/docs/images/cdy7uua7fh8z/5IrmDuvj5xma8DmkIMJ7ol/42363cde670f86561666c9e930f76883/Screenshot_2025-02-05_at_15.43.23.png?fit=max&auto=format&n=Tx-zTp2kMjjdY0gu&q=85&s=56449c420b6e7694467c2e51df68ffc2" alt="Image de l'écran d'inscription d'ACUL" width="374" height="736" data-path="docs/images/cdy7uua7fh8z/5IrmDuvj5xma8DmkIMJ7ol/42363cde670f86561666c9e930f76883/Screenshot_2025-02-05_at_15.43.23.png" />
</Frame>

```ts Example theme={null}
import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.signup({
 email: 'test@example.com',
 password: 'P@$wOrd123!',
});
```

<div id="constructors">
  ## Constructeurs
</div>

<ParamField body="Inscription" type="Constructor" />

<div id="properties">
  ## Propriétés
</div>

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

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

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

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

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

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

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

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

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

<ParamField body="screenIdentifier" type="string" />

<div id="methods">
  ## Méthodes
</div>

<ParamField body="federatedSignup" type="Promise<void>">
  Gère l'envoi du formulaire d'inscription via un fournisseur social.

  #### Remarques

  Cette méthode est similaire à la méthode [signup](#signup), mais elle est utilisée pour les inscriptions via un fournisseur social.

  ```typescript Example theme={null}
  import Signup from '@auth0/auth0-acul-js/signup';

  const signupManager = new Signup();

  signupManager.federatedSignup({
   connection: 'google-oauth2'
  });
  ```

  <Expandable title="Paramètres">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions">FederatedSignupPayloadOptions</a></span>}>
      **Propriétés**

      <ParamField body="connection" type="string" />
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="getErrors" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
  Récupère, à partir du contexte, le tableau des erreurs de la transaction ou un tableau vide si aucune erreur n'existe.

  Un tableau d'objets d'erreur provenant du contexte de transaction.
</ParamField>

<ParamField body="getSignupIdentifiers" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}>
  **`Utility Feature`**

  Renvoie la liste des identifiants activés pour le formulaire d'inscription,
  en indiquant pour chacun s'il est obligatoire ou facultatif selon la configuration de la transaction.

  Tableau d'objets d'identifiant (par exemple, courriel, téléphone, nom d'utilisateur).

  ```ts Example theme={null}
  const signup = new Signup();
  const identifiers = signup.getSignupIdentifiers();
  // [{ type: 'email', required: true }, { type: 'username', required: false }]
  ```
</ParamField>

<ParamField body="pickCountryCode" type="Promise<void>">
  ```ts Example theme={null}
  import Signup from "@auth0/auth0-acul-js/signup";
  const signupManager = new Signup();

  signupManager.pickCountryCode();
  ```
</ParamField>

<ParamField body="signup" type="Promise<void>">
  #### Remarques

  Cette méthode gère l'envoi du formulaire d'inscription.

  ```typescript Example theme={null}
  import Signup from '@auth0/auth0-acul-js/signup';

  const signupManager = new Signup();

  signupManager.signup({
   email: 'test@example.com',
   password: 'P@$$wOrd123!',
  });
  ```

  <Expandable title="Paramètres">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPayloadOptions">SignupPayloadOptions</a></span>}>
      **Propriétés**

      <ParamField body="captcha?" type="string" />

      <ParamField body="email?" type="string" />

      <ParamField body="password?" type="string" />

      <ParamField body="phoneNumber?" type="string" />

      <ParamField body="username?" type="string" />
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="validatePassword" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}>
  **`Utility Feature`**

  Un objet de type [PasswordValidationResult](/docs/fr-CA/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult) indiquant si le mot de passe est valide et pourquoi.

  <Expandable title="Paramètres">
    <ParamField body="password" type="string">
      `string`
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="validateUsername" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}>
  **`Utility Feature`**

  Valide un nom d'utilisateur donné par rapport à la stratégie de noms d'utilisateur actuelle
  définie dans le contexte de transaction.

  Objet de résultat indiquant si le nom d'utilisateur est valide et pourquoi.

  ```ts Example theme={null}
  const signup = new Signup();
  const result = signup.validateUsername('myusername');
  // result => { valid: true, errors: [] }
  ```

  <Expandable title="Paramètres">
    <ParamField body="username" type="string">
      `string`

      La chaîne de caractères du nom d'utilisateur à valider.
    </ParamField>
  </Expandable>
</ParamField>
