signUp
Inscrire un utilisateur. Pour les fournisseurs avec activation des utilisateurs, un code d'activation est envoyé par le moyen de notification de l'utilisateur.
Description
Renvoie un ISignUpEntity.
.signUp(
,
,
);
Schéma des paramètres
Schema
marker(required): string
Marqueur du fournisseur d'authentification.
exemple : "email"
body(required): ISignUpData
Corps de la requête.
exemple :
{
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": [
{
"marker": "last_name",
"type": "string",
"value": "Name"
}
],
"notificationData": {
"email": "john@example.com",
"phonePush": [
"fcm_token_1234567890abcdefg"
],
"phoneSMS": "+12025550147"
}
}
body.formIdentifier(required): string
Marqueur du formulaire d'inscription.
exemple : "reg"
body.langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
body.authData(required): Array
Champs d'authentification, chacun avec un marker et une value.
body.formData(required): FormDataType | FormDataType[]
Champs du formulaire d'inscription. Valeurs des champs : FormDataType — une valeur selon le type du champ (une chaîne, un objet date, un objet texte, une liste, un descripteur de fichier), pas seulement une chaîne. Un fichier se transmet sous la forme du descripteur renvoyé par FileUploading.upload : ces méthodes n'envoient pas elles-mêmes un File/Blob.
body.notificationData(required): INotificationData
Contacts de notification : email, phonePush et phoneSMS.
notificationData.email(required): string
E-mail de l'utilisateur utilisé pour les notifications.
exemple : "john@example.com"
notificationData.phonePush(required): string[]
Jetons d'appareil FCM enregistrés pour les notifications push.
exemple :
[
"fcm_token_1234567890abcdefg"
]
notificationData.phoneSMS: string
Numéro de téléphone utilisé pour les notifications SMS.
exemple : "+12025550147"
langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"
Exemples
Exemple minimal
const body = { , { , }, { , } ], { , , } ], , "fcm-token" ], }};
const response = await AuthProvider.signUp('email', body);
Exemple avec un formData de types simples : "string", "integer", "float"
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": [
{
"marker": "last_name",
"type": "string",
"value": "Smith"
},
{
"marker": "age",
"type": "integer",
"value": 30
},
{
"marker": "height",
"type": "float",
"value": 1.82
}
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec un attribut "date"
Les champs dateTime et time prennent la même forme de valeur.
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": [
{
"marker": "birthday",
"type": "date",
"value": {
"fullDate": "2024-05-07T21:02:00.000Z",
"formattedValue": "08-05-2024 00:02",
"formatString": "DD-MM-YYYY HH:mm"
}
}
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec un attribut "text"
Fournissez exactement un des champs htmlValue (HTML), plainValue (texte brut) ou mdValue (Markdown).
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": [
{
"marker": "about",
"type": "text",
"value": {
"htmlValue": "<p>This is me</p>",
// "plainValue": "",
// "mdValue": ""
}
}
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec un attribut "textWithHeader"
Dans value, à côté de header, fournissez exactement un des champs htmlValue (HTML), plainValue (texte brut) ou mdValue (Markdown).
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
"formData": [
{
"marker": "about",
"type": "textWithHeader",
"value": {
"header": "Header",
"htmlValue": "<p>This is me</p>",
// "plainValue": "",
// "mdValue": ""
}
}
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec les attributs "image" et "groupOfImages"
signUp n'envoie pas de fichiers. Envoyez d'abord le fichier avec FileUploading.upload() et passez ce qu'il renvoie comme valeur du champ.
Voir le scénario de formulaire avec fichier dans le bac à sable.
// The file the user picked, e.g. from <input type="file">.
const input = document.querySelector('input[type="file"]');
if (!(input instanceof HTMLInputElement) || !input.files?.length) throw new Error('No file selected');
const file = input.files[0];
const uploaded = await FileUploading.upload(file, {
type: "page",
entity: "editor",
id: 3492,
});
if ('statusCode' in uploaded) throw new Error(uploaded.message);
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
formData: [
{
marker: "image",
type: "image",
value: uploaded,
},
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec un attribut "file"
signUp n'envoie pas de fichiers. Envoyez d'abord le fichier avec FileUploading.upload() et passez ce qu'il renvoie comme valeur du champ.
Voir le scénario de formulaire avec fichier dans le bac à sable.
// The file the user picked, e.g. from <input type="file">.
const input = document.querySelector('input[type="file"]');
if (!(input instanceof HTMLInputElement) || !input.files?.length) throw new Error('No file selected');
const file = input.files[0];
const uploaded = await FileUploading.upload(file, {
type: "page",
entity: "editor",
id: 3492,
});
if ('statusCode' in uploaded) throw new Error(uploaded.message);
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
formData: [
{
marker: "file",
type: "file",
value: uploaded,
},
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec un attribut "list"
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
formData: [
{
marker: "list",
type: "list",
value: ["1"],
},
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple avec un attribut "entity" (liste imbriquée)
const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "login",
"value": "john@example.com"
},
{
"marker": "password",
"value": "12345"
}
],
formData: [
{
marker: "entity",
type: "entity",
value: [2954, 2957],
},
],
"notificationData": {
"email": "john@example.com",
"phonePush": [],
"phoneSMS": "+12025550147"
}
};
const response = await AuthProvider.signUp('email', body);
Exemple de réponse
{
"id": 1764,
"identifier": "john@example.com",
"isActive": false,
"isDeleted": false,
"deletedAt": null,
"createdDate": "2026-10-27T10:00:00.000Z",
"updatedDate": "2026-10-27T10:00:00.000Z",
"version": 0,
"locale": "en_US",
"formData": [
{
"marker": "last_name",
"type": "string",
"value": "Smith"
}
],
"notificationData": {
"email": "john@example.com",
"phonePush": ["fcm-token"],
"phoneSMS": "+12025550147"
},
"state": {},
"rating": {},
"attributesSets": {}
}
identifier est la valeur d'identifiant de connexion issue de authData. isActive vaut false lorsque le fournisseur d'authentification exige une confirmation par code (isCheckCode) ; sinon l'utilisateur est actif immédiatement.
L'API renvoie
formDatasous forme d'objet indexé par code de langue ({ "en_US": [ … ] }). Le SDK le déballe pour ne garder que les champs dulangCodedemandé : vous obtenez unIAuthFormData[]à plat.
Schéma de réponse
Schéma : ISignUpEntity
id: number
ID de l'utilisateur créé par l'inscription.
exemple : 12345
updatedDate: string
Date de la dernière mise à jour de l'utilisateur.
exemple : "2023-10-01T12:00:00Z"
version: number
Numéro de version de l'utilisateur ; change à chaque mise à jour.
exemple : 1
identifier: string
Marqueur de l'utilisateur créé par l'inscription.
exemple : "signup_12345"
isActive: boolean
Indique si le compte utilisateur est actif.
exemple : true
isConfirmed: boolean
Indique si le compte utilisateur est confirmé (par exemple activé). Renvoyé par la réponse d'inscription.
exemple : true
formData: IAuthFormData[]
Champs du formulaire.
exemple :
[
{
"marker": "first_name",
"value": "John"
}
]
formData.marker: string
Marqueur du champ de formulaire.
exemple : "email"
formData.type: string
Type du champ de formulaire, par exemple "string" ou "email".
exemple : "string"
formData.value: string
La valeur saisie dans le champ du formulaire.
exemple : "john@example.com"
notificationData: INotificationData
Contacts de notification : email, phonePush et phoneSMS.
exemple :
{
"email": "john@example.com",
"phonePush": [
"fcm_token_1234567890abcdefg"
],
"phoneSMS": "+12025550147"
}
notificationData.email: string
E-mail de l'utilisateur utilisé pour les notifications.
exemple : "john@example.com"
notificationData.phonePush: string[]
Jetons d'appareil FCM enregistrés pour les notifications push.
exemple :
[
"fcm_token_1234567890abcdefg"
]
notificationData.phoneSMS: string
Numéro de téléphone utilisé pour les notifications SMS.
exemple : "+12025550147"
locale: string
Locale de l'utilisateur créé par l'inscription.
exemple : "en_US"
createdDate: string
Date de création de l'enregistrement utilisateur.
exemple : "2023-10-01T12:00:00Z"
importId: unknown
Identifiant d'import.
exemple : null
deletedAt: string | null
Date de suppression, ou null.
exemple : null
isDeleted: boolean
Indique si le compte utilisateur est supprimé.
exemple : false
oauthSub: string | null
Sujet du compte OAuth auquel l'utilisateur est lié ; null pour un utilisateur inscrit par e-mail.
exemple : null
state: Record<string, unknown>
Données clé-valeur personnalisées stockées avec l'utilisateur.
exemple :
{}
rating: IRating
Données de notation : valeur moyenne, j'aime et je n'aime pas, et méthode de calcul.
attributeSetId: number | null
ID de l'ensemble d'attributs rattaché à l'utilisateur, ou null si aucun n'est rattaché.
exemple : null
attributesSets: Record<string, unknown>
Ensembles d'attributs rattachés à l'utilisateur, indexés par marqueur ; un objet vide s'il n'y en a aucun.
exemple :
{}
Exemples d'utilisation
Tutoriel pas à pas dans la documentation :
- Register user : récupérez un formulaire d'inscription, collectez les données de l'utilisateur et créez le compte via
AuthProvider.signUp().
Essayer en direct
Exécutez cette méthode dans le bac à sable JS SDK. Lors de votre première visite, connectez l'URL de votre projet et votre App Token, puis ouvrez :
- Register user : récupérez un formulaire d'inscription, collectez les données de l'utilisateur et créez le compte via
AuthProvider.signUp().