āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š shadcn/directory/clerk/clerk-docs/reference/backend/user/update-user ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
updateUser()'
description: Use Clerk's JS Backend SDK to update a user.
sdk: js-backend{/* clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/UserApi.ts#L148 */}
Updates a User.
function updateUser(userId: string, params: UpdateUserParams): Promise<User>
UpdateUserParamsThe ID of the user to update.
externalId?stringThe ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.
firstName?stringThe user's first name.
lastName?stringThe user's last name.
primaryEmailAddressID?stringThe ID of the email address to set as primary. It must be verified, and present on the current user.
notifyPrimaryEmailAddressChanged?booleanIf set to true, the user will be notified that their primary email address has changed. By default, no notification is sent. Defaults to false.
primaryPhoneNumberID?stringThe ID of the phone number to set as primary. It must be verified, and present on the current user.
primaryWeb3WalletID?stringThe ID of the Web3 wallet to set as primary. It must be verified, and present on the current user.
username?stringThe user's username. It must be unique across your instance.
profileImageID?stringThe ID of the image to set as the user's profile image.
password?stringThe plaintext password to give the user. Must be at least 8 characters long, and can not be in any list of hacked passwords.
passwordDigest?stringIn 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?'argon2i' | 'argon2id' | 'bcrypt' | 'bcrypt_sha256_django' | 'md5' | 'pbkdf2_sha256' | 'pbkdf2_sha256_django' | 'pbkdf2_sha1' | 'phpass' | 'scrypt_firebase' | 'scrypt_werkzeug' | 'sha256'The hashing algorithm that was used to generate the password digest. Each of the supported hashers expects the incoming digest to be in a particular format. See the Clerk Backend API reference{{ target: '_blank' }} for more information.
skipPasswordChecks?booleanWhen set to true, all password checks are skipped. It is recommended to use this method only when migrating plaintext passwords to Clerk. Upon migration the user base should be prompted to pick stronger password.
skipPasswordRequirement?booleanWhen set to true, password is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. You cannot use this flag if password is the only way for a user to sign into your instance.
signOutOfOtherSessions?booleanSet to true to sign out the user from all their active sessions once their password is updated. Can only be used when providing the password parameter.
totpSecret?stringIn case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. Currently, the supported options are: <ul><li>Period: 30 seconds</li><li>Code length: 6 digits</li><li>Algorithm: SHA1</li></ul>
backupCodes?string[]If backup codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest.
publicMetadata?UserPublicMetadataMetadata that can be read from the Frontend API and Backend API{{ target: '_blank' }} and can be set only from the Backend API. Updating this property will override the existing metadata. To merge metadata, use updateUserMetadata().
privateMetadata?UserPrivateMetadataMetadata that can be read and set only from the Backend API{{ target: '_blank' }}. Updating this property will override the existing metadata. To merge metadata, use updateUserMetadata().
unsafeMetadata?UserUnsafeMetadataMetadata that can be read and set from the Frontend API. It's considered unsafe because it can be modified from the frontend.
deleteSelfEnabled?booleanIf true, the user can delete themselves with the Frontend API.
createOrganizationEnabled?booleanIf true, the user can create organizations with the Frontend API.
createOrganizationsLimit?numberAn integer indicating the number of organizations that can be created by the user. If the value is 0, then the user can create unlimited organizations. Default is null.
legalAcceptedAt?DateThe date when the user accepted the legal documents. null if Require express consent to legal documents is not enabled.
skipLegalChecks?booleanWhen set to true all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk.
createdAt?DateA custom date/time denoting when the user signed up to the application, specified in RFC3339 format. For example: 2012-10-20T07:15:20.902Z.
skipLegalChecks?booleanWhen set to true all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk.
legalAcceptedAt?DateA custom date/time denoting when the user accepted legal requirements, specified in RFC3339 format. For example: 2012-10-20T07:15:20.902Z.
</Properties>
const userId = 'user_123'
const params = { firstName: 'John', lastName: 'Wick' }
const response = await clerkClient.users.updateUser(userId, params)
This method in the SDK is a wrapper around the BAPI endpoint PATCH/users/{user_id}. See the BAPI reference{{ target: '_blank' }} for more information.
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā