Skip to main content

updateUserById()

Updates the user data.

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { email: 'new@email.com' }
)

Parameters​

  • uidrequiredstring

    No description provided.

  • attributesrequiredAdminUserAttributes

    The data you want to update.

    This function should only be called on a server. Never expose your service_role key in the browser.

Notes​

  • Requires a service_role key.
  • This function should only be called on a server. Never expose your service_role key in the browser.

Examples​

Updates a user's email.​

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { email: 'new@email.com' }
)

Updates a user's password.​

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { password: 'new_password' }
)

Updates a user's metadata.​

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { user_metadata: { hello: 'world' } }
)

Updates a user's app_metadata.​

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { app_metadata: { plan: 'trial' } }
)

Confirms a user's email address.​

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { email_confirm: true }
)

Confirms a user's phone number.​

const { data: user, error } = await supabase.auth.api.updateUserById(
  '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',
  { phone_confirm: true }
)