| Field | Type | Required | Description |
|---|---|---|---|
externalId |
JsonNullable<String> | ➖ | The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. |
firstName |
JsonNullable<String> | ➖ | The first name to assign to the user |
lastName |
JsonNullable<String> | ➖ | The last name to assign to the user |
locale |
JsonNullable<String> | ➖ | The locale to assign to the user (e.g., "en-US", "fr-FR") |
primaryEmailAddressId |
JsonNullable<String> | ➖ | The ID of the email address to set as primary. It must be verified, and present on the current user. |
notifyPrimaryEmailAddressChanged |
JsonNullable<Boolean> | ➖ | If set to true, the user will be notified that their primary email address has changed.By default, no notification is sent. |
primaryPhoneNumberId |
JsonNullable<String> | ➖ | The ID of the phone number to set as primary. It must be verified, and present on the current user. |
primaryWeb3WalletId |
JsonNullable<String> | ➖ | The ID of the web3 wallets to set as primary. It must be verified, and present on the current user. |
username |
JsonNullable<String> | ➖ | The username to give to the user. It must be unique across your instance. |
profileImageId |
JsonNullable<String> | ➖ | The ID of the image to set as the user's profile image |
password |
JsonNullable<String> | ➖ | The plaintext password to give the user. Must be at least 8 characters long, and cannot be in any list of hacked passwords. |
passwordDigest |
Optional<String> | ➖ | 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 digests should be generated with one of the supported algorithms. The hashing algorithm can be specified using the password_hasher property. |
passwordHasher |
Optional<String> | ➖ | The hashing algorithm that was used to generate the password digest. The algorithms we support at the moment are bcrypt, bcrypt_sha256_django, md5, pbkdf2_sha1, pbkdf2_sha256, pbkdf2_sha256_django,pbkdf2_sha512, phpass, md5_phpass, scrypt_firebase,scrypt_werkzeug, sha256,ldap_ssha, the argon2 variants: argon2i and argon2id, sha512_symfony, the SHA-512 variant of the Symfony legacy hasher,and pbkdf2_sha512_hex, a variant of pbkdf2_sha512 that accepts hex-encoded salt and hash.Each of the supported hashers expects the incoming digest to be in a particular format. See the Clerk docs for more information. |
skipPasswordChecks |
JsonNullable<Boolean> | ➖ | Set it to true if you're updating the user's password and want to skip any password policy settings check. This parameter can only be used when providing a password. |
signOutOfOtherSessions |
JsonNullable<Boolean> | ➖ | Set to true to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a password. |
totpSecret |
JsonNullable<String> | ➖ | In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it. |
backupCodes |
List<String> | ➖ | If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them. |
deleteSelfEnabled |
JsonNullable<Boolean> | ➖ | If true, the user can delete themselves with the Frontend API. |
createOrganizationEnabled |
JsonNullable<Boolean> | ➖ | If true, the user can create organizations with the Frontend API. |
legalAcceptedAt |
JsonNullable<String> | ➖ | A custom timestamp denoting when the user accepted legal requirements, specified in RFC3339 format. |
skipLegalChecks |
JsonNullable<Boolean> | ➖ | When set to true all legal checks are skipped. |
createOrganizationsLimit |
JsonNullable<Long> | ➖ | The maximum number of organizations the user can create. 0 means unlimited. |
createdAt |
JsonNullable<String> | ➖ | A custom date/time denoting when the user signed up to the application. |
bypassClientTrust |
JsonNullable<Boolean> | ➖ | When set to true, the user will bypass client trust checks during sign-in. |