v1

latestOpenAPI 3.0.12026-08-0435481.5 MB

Users

Create user

Create a new user with the given data.

post/api/users

Request body

primaryPhonestring regex

Primary phone number for the user. It should be unique across all users.

primaryEmailstring regex

Primary email address for the user. It should be unique across all users.

usernamestring regex

Username for the user. It should be unique across all users.

passwordstring

Plain text password for the user.

passwordDigeststring

In case you already have the password digests and not the passwords, you can use them for the newly created user via this property. The algorithm can be specified using the passwordAlgorithm property. For Legacy, pass a JSON string in the format [algorithm, args, encryptedPassword], where args is a string array that MUST contain an @ placeholder, which will be replaced by the plain text password at runtime. For PBKDF2 under Legacy, args is expected to be in the order [salt, iterations, keylen, digest, '@']. The salt supports a plain string or a hex:-prefixed hex string (for binary salt bytes).

The hash algorithm used for the password. It should be one of the supported algorithms, including Legacy for custom legacy expressions. Should the encryption algorithm differ from Argon2i, it will automatically be upgraded to Argon2i upon the user's next sign-in.

namestring

customDataobject

arbitrary

Response

User data for the newly created user.

idstring required

usernamestring nullable required

primaryEmailstring nullable required

primaryPhonestring nullable required

namestring nullable required

avatarstring nullable required

customDataobject required

arbitrary

identitiesobject required

lastSignInAtnumber nullable required

createdAtnumber required

updatedAtnumber required

applicationIdstring nullable required

isSuspendedboolean required

hasPasswordboolean

hasSecurityVerificationMethodboolean

passwordDigeststring nullable