PATCH
Error

Authorizations

apikey
string
header
required

Your publishable (pb_pk_…) or secret (pb_sk_…) key.

Authorization
string
header
required

The signed-in person's access token.

Body

application/json
name
string | null

Display name.

Maximum string length: 200
avatar_url
string | null

URL of the profile picture.

Maximum string length: 2048
data
Data · object | null

Merged into user_metadata

password
string | null

A new password. Requires current_password.

Maximum string length: 1024
current_password
string | null

The current password, required to change the password or email.

email
string | null

A new email address. A confirmation is sent to it.

Response

Success.

id
string
required

Unique identifier.

email
string<email>
required

Email address.

is_anonymous
boolean
required
username
string
required
name
string
required

The name.

avatar_url
null
required
email_verified
boolean
required
email_verified_at
string<date-time>
required
user_metadata
object
required
app_metadata
object
required
roles
array
required

Role names.

mfa_enabled
boolean
required
identities
array
required
created_at
string<date-time>
required

When it was created (UTC).

last_sign_in_at
string<date-time>
required
changed
string[]
required