> ## 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.

# SignupId

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/generaltranslationinc/zzYYN5BbwWVQSB2A/docs/images/cdy7uua7fh8z/5lzGYj0k4VcxvPCBYH37SO/ebd291cc0dbd673a70f93530f724bf65/Signup_ID.png?fit=max&auto=format&n=zzYYN5BbwWVQSB2A&q=85&s=e2438271c9658b0560f60a171c3cfbc8" alt="Signup ID" width="480" height="632" data-path="docs/images/cdy7uua7fh8z/5lzGYj0k4VcxvPCBYH37SO/ebd291cc0dbd673a70f93530f724bf65/Signup_ID.png" />
</Frame>

```ts Example theme={null}
import SignupId from "@auth0/auth0-acul-js/signup-id";
const signupIdManager = new SignupId();
const { transaction } = signupIdManager;
//obtenir les identifiants obligatoires et facultatifs requis pour l'inscription
const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // p. ex. : courriel
const optionalIdentifiers = transaction.getOptionalIdentifiers() // p. ex. : téléphone
const signupParams = {
 email : "testEmail",
 phone : "+91923456789"
};
signupIdManager.signup(signupParams);
```

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

<ParamField body="SignupId" 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/ScreenMembersOnSignupId">ScreenMembersOnSignupId</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/TransactionMembersOnSignupId">TransactionMembersOnSignupId</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>">
  <div id="remarks">
    #### Remarques
  </div>

  Cette méthode permet l'inscription à l'aide de différents identifiants sociaux.
  Par exemple : Google, Facebook, etc.

  ```ts Example theme={null}
  import SignupId from "@auth0/auth0-acul-js/signup-id";

  const signupIdManager = new SignupId();
  const { transaction } = signupIdManager;

  // obtenir les connexions sociales
  const socialConnection = transaction.alternateConnections; // p. ex. : "google-oauth2"

  const signupParams = {
   connection : socialConnection[0].name, // "google-oauth2"
  };

  signupIdManager.federatedSignup(signupParams);
  ```

  <Expandable title="Paramètres">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupOptions">FederatedSignupOptions</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 le tableau d'erreurs de transaction à partir du contexte ou un tableau vide s'il n'en existe aucune.

  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>}>
  **`Fonction utilitaire`**

  Retourne la liste des identifiants activés pour le formulaire signup-id,
  en marquant chacun comme obligatoire ou facultatif selon la configuration de la transaction.

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

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

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

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

<ParamField body="signup" type="Promise<void>">
  <div id="remarks">
    #### Remarques
  </div>

  Cette méthode gère la configuration liée à signup-id.
  Elle permet d'inscrire de nouveaux utilisateurs au moyen de différents identifiants.

  ```ts Example theme={null}
  import SignupId from "@auth0/auth0-acul-js/signup-id";

  const signupIdManager = new SignupId();
  const { transaction } = signupIdManager;

  // obtenir les identifiants obligatoires et facultatifs requis pour l'inscription
  const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // p. ex. : courriel
  const optionalIdentifiers = transaction.getOptionalIdentifiers() // p. ex. : téléphone

  const signupParams = {
   email : "testEmail",
   phone : "+91923456789"
  };

  signupIdManager.signup(signupParams);
  ```

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

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

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

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

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

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

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

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

  ```ts Example theme={null}
  const signupIdManager = new SignupId();
  const result = signupIdManager.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>
