Update a User

Update a user.

These are the attributes that can be updated at the root level:

• app_metadata
• blocked
• email
• email_verified
• family_name
• given_name
• name
• nickname
• password
• phone_number
• phone_verified
• picture
• username
• user_metadata
• verify_email

Some considerations:

• The properties of the new object will replace the old ones.
• The metadata fields are an exception to this rule (user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
• If you are updating email, email_verified, phone_number, phone_verified, username or password of a secondary identity, you need to specify the connection property too.
• If you are updating email or phone_number you can specify, optionally, the client_id property.
• Updating email_verified is not supported for enterprise and passwordless sms connections.
• Updating the blocked to false does not affect the user’s blocked state from an excessive amount of incorrectly provided credentials. Use the “Unblock a user” endpoint from the “User Blocks” API to change the user’s state.
• Supported attributes can be unset by supplying null as the value.

Updating a field (non-metadata property)

To mark the email address of a user as verified, the body to send should be:

{ "email_verified": true }

Updating a user metadata root property

Let’s assume that our test user has the following user_metadata:

{ "user_metadata" : { "profileCode": 1479 } }

To add the field addresses the body to send should be:

{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}

The modified object ends up with the following user_metadata property:

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": { "work_address": "100 Industrial Way" }
  }
}

Updating an inner user metadata property

If there’s existing user metadata to which we want to add "home_address": "742 Evergreen Terrace" (using the addresses property) we should send the whole addresses object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:

{
  "user_metadata": {
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

The modified object ends up with the following user_metadata property:

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

PATCH https://{tenantDomain}/api/v2/users/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateUserRequestContent{}
    client.Users.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "email": "[e-mail]",
  "email_verified": false,
  "username": "johndoe",
  "phone_number": "[phone]",
  "phone_verified": false,
  "created_at": "<string>",
  "updated_at": "<string>",
  "identities": [
    {
      "connection": "<string>",
      "user_id": "<string>",
      "isSocial": true,
      "access_token": "<string>",
      "access_token_secret": "<string>",
      "refresh_token": "<string>",
      "profileData": {
        "email": "<string>",
        "email_verified": true,
        "name": "<string>",
        "username": "johndoe",
        "given_name": "<string>",
        "phone_number": "<string>",
        "phone_verified": true,
        "family_name": "<string>"
      }
    }
  ],
  "app_metadata": {},
  "user_metadata": {},
  "picture": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "multifactor": [
    "<string>"
  ],
  "last_ip": "<string>",
  "last_login": "<string>",
  "logins_count": 123,
  "blocked": true,
  "given_name": "<string>",
  "family_name": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

ID of the user to update.

Body

application/jsonapplication/x-www-form-urlencoded

blocked · boolean · default: false

Whether this user was blocked by an administrator (true) or not (false).

email_verified · boolean · default: false

Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless verify_email is set to true.

email · string<email> | null · default: [e-mail]

Email address of this user.

phone_number · string | null · default: [phone]

The user's phone number (following the E.164 recommendation).

Pattern: ^\+[0-9]{1,15}$

phone_verified · boolean · default: false

Whether this phone number has been verified (true) or not (false).

user_metadata · object

User metadata to which this user has read/write access.

app_metadata · object

User metadata to which this user has read-only access.

given_name · string | null · default: John

Given name/first name/forename of this user.

Required string length: 1 - 150

family_name · string | null · default: Doe

Family name/last name/surname of this user.

Required string length: 1 - 150

name · string | null · default: John Doe

Name of this user.

Required string length: 1 - 300

nickname · string | null · default: Johnny

Preferred nickname or alias of this user.

Required string length: 1 - 300

picture · string<strict-uri> | null · default: https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png

URL to picture, photo, or avatar of this user.

verify_email · boolean · default: false

Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of email_verified parameter.

verify_phone_number · boolean · default: false

Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number for SMS connections.

password · string | null · default: secret

New password for this user. Only valid for database connections.

Minimum string length: 1

connection · string · default: Initial-Connection

Name of the connection to target for this user update.

Minimum string length: 1

client_id · string · default: DaM8bokEXBWrTUFCiJjWn50jei6ardyX

Auth0 client ID. Only valid when updating email address.

Minimum string length: 1

username · string | null · default: johndoe

The user's username. Only valid if the connection requires a username.

Required string length: 1 - 128

Response

200

application/json

User successfully updated.

user_id · string · default: auth0|507f1f77bcf86cd799439020

ID of the user which can be used when interacting with other APIs.

email · string<email> · default: [e-mail]

Email address of this user.

email_verified · boolean · default: false

Whether this email address is verified (true) or unverified (false).

username · string · default: johndoe

Username of this user.

phone_number · string · default: [phone]

Phone number for this user. Follows the E.164 recommendation.

phone_verified · boolean · default: false

Whether this phone number has been verified (true) or not (false).

created_at · string object

Date and time when this user was created (ISO_8601 format).

updated_at · string object

Date and time when this user was created (ISO_8601 format).

identities · object[]

Array of user identity objects when accounts are linked.

Show child attributes

app_metadata · object

User metadata to which this user has read-only access.

user_metadata · object

User metadata to which this user has read/write access.

picture · string

URL to picture, photo, or avatar of this user.

name · string

Name of this user.

nickname · string

Preferred nickname or alias of this user.

multifactor · string[]

List of multi-factor authentication providers with which this user has enrolled.

last_ip · string

Last IP address from which this user logged in.

last_login · string object

Date and time when this user was created (ISO_8601 format).

logins_count · integer

Total number of logins this user has performed.

blocked · boolean

Whether this user was blocked by an administrator (true) or is not (false).

given_name · string

Given name/first name/forename of this user.

family_name · string

Family name/last name/surname of this user.