UpdateUserParams
Examples

`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
userId
Type
string
Description
The ID of the user to update.
Name
firstName?
Type
string
Description
The user's first name.
Name
lastName?
Type
string
Description
The user's last name.
Name
username?
Type
string
Description
The user's username.
Name
password?
Type
string
Description
The plaintext password to give the user.
Name
skipPasswordChecks?
Type
boolean
Description
Set 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.
Name
signOutOfOtherSessions?
Type
boolean
Description
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.
Name
primaryEmailAddressID?
Type
string
Description
Email address that will replace user's current primary email address. Must be unique across your instance.
Name
primaryPhoneNumberID?
Type
string
Description
Phone number that will replace user's current primary phone number. Must be unique across your instance.
Name
primaryWeb3WalletID?
Type
string
Description
Web3 wallet that will replace user's current primary web3 wallet. Must be unique across your instance.
Name
profileImageID?
Type
string
Description
The ID of the image to set as the user's profile image.
Name
totpSecret?
Type
string
Description
If TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it. Currently, the supported options are:
Period: 30 seconds
Code length: 6 digits
Algorithm: SHA1
Name
backupCodes?
Type
string[]
Description
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. You must provide the backup codes in plain format or the corresponding bcrypt digest.
Name
externalId?
Type
string
Description
An external identifier for the user. Must be unique across your instance.
Name
createOrganizationEnabled?
Type
boolean
Description
If true, the user can create organizations with the Frontend API.
Name
createdAt?
Type
Date
Description
A custom date/time denoting when the user signed up to the application, specified in RFC3339 format

For example: 2012-10-20T07:15:20.902Z.
Name
publicMetadata?
Type
Record<string, unknown>
Description
Metadata saved on the user, that is visible to both your Frontend and Backend APIs.
Name
privateMetadata?
Type
Record<string, unknown>
Description
Metadata saved on the user that is only visible to your Backend API.
Name
unsafeMetadata?
Type
Record<string, unknown>
Description
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.

Examples

Next.js

Node

Remix

App Router

Pages Router

app/api/update-user-example/route.ts

import { NextRequest, NextResponse } from 'next/server';
import { getAuth, clerkClient } from '@clerk/nextjs/server';

// If you use `request` you don't need the type
export async function POST(req: NextRequest) {

  // Get the user ID from the session
  const { userId } = getAuth(req);

  if (!userId) return NextResponse.redirect('/sign-in');

  // The user attributes to update
  const params = { firstName: 'John', lastName: 'Wick' };

  const updatedUser = await clerkClient.users.updateUser(userId, params);

  return NextResponse.json({ updatedUser });
}

pages/api/updateUser.tsx

import { clerkClient, getAuth } from '@clerk/nextjs/server';
import type { NextApiRequest, NextApiResponse } from 'next';

export default async function handler(req: NextApiRequest, res: NextApiResponse) {

  // Get the user ID from the session
  const { userId } = getAuth(req);

  if (!userId) {
    return res.status(500).json({ error: "No valid user" })
  }

  // The user attributes to update
  const params = { firstName: 'John', lastName: 'Wick' };

  const updatedUser = await clerkClient.users.updateUser(userId, params);

  return res.status(200).json({ updatedUser });
}

updateUser.js

import clerkClient from '@clerk/clerk-sdk-node';

app.post('/api/update-user',
  // ClerkExpressRequireAuth returns an error for unauthorized requests
  ClerkExpressRequireAuth(),
  // Optionally ClerkExpressWithAuth returns an empty user with no error
  // ClerkExpressWithAuth(),
  async (req, res) => {

    // Get the user ID from req.auth
    const userId = req.auth.userId

    // The user attributes to update
    const params = { firstName: "John", lastName: "Wick" }

    const updatedUser = await clerkClient.users.updateUser(userId, params)

    res.json({ updatedUser })
  })

app/routes/profile.tsx

import { createClerkClient } from "@clerk/remix/api.server"
import { getAuth } from "@clerk/remix/ssr.server"
import { ActionFunction, json } from "@remix-run/node"

export const action: ActionFunction = async (req) => {

  // Get the user ID from the session
  const { userId } = await getAuth(req)

  // The user attributes to update
  const params = { firstName: 'John', lastName: 'Wick' };

  const updatedUser = await createClerkClient({ secretKey: process.env.CLERK_SECRET_KEY }).users.updateUser(userId, params)

  return json({ updatedUser })
}

Edit this page on GitHub

Last updated on Aug 20, 2024

updateUser()

UpdateUserParams

Examples

Feedback

`updateUser()`

`UpdateUserParams`