updateUser()
Updates a user with a given ID with attribute values provided in a params object.
The provided ID must be valid, otherwise an error will be thrown.
const userId = 'my-user-id';
const params = { firstName: 'John', lastName: 'Wick' };
const user = await clerkClient.users.updateUser(userId, params);
UpdateUserParams
Name | Type | Description |
---|---|---|
userId | string | The ID of the user to update. |
firstName? | string | The user's first name. |
lastName? | string | The user's last name. |
username? | string | The user's username. |
password? | string | The plaintext password to give the user. |
primaryEmailAddressID? | string | Email address that will replays user's current primary email address. Must be unique across your instance. |
primaryPhoneNumberID? | string | Phone number that will replace user's current primary phone number. Must be unique across your instance. |
primaryWeb3WalletID? | string | Web3 wallet that will replace user's current primary web3 wallet. Must be unique across your instance. |
externalId? | string | An external identifier for the user. Must be unique across your instance. |
publicMetadata? | Record<string, unknown> | Metadata saved on the user, that is visible to both your Frontend and Backend APIs. |
privateMetadata? | Record<string, unknown> | Metadata saved on the user that is only visible to your Backend API. |
unsafeMetadata? | Record<string, unknown> | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. |