Update current user

Updates the currently authenticated user. Only the values provided will be updated.

PATCH /users/me

Update current user

cURL

curl --request PATCH \
  --url https://api.stack-auth.com/api/v1/users/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "John Doe",
  "profile_image_url": "https://example.com/image.jpg",
  "client_metadata": {
    "key": "value"
  },
  "selected_team_id": "team-id",
  "totp_secret_base64": "dG90cC1zZWNyZXQ=",
  "primary_email": "[e-mail]"
}
'

200

{
  "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "primary_email_verified": true,
  "signed_up_at_millis": 1630000000000,
  "is_anonymous": true,
  "is_restricted": false,
  "restricted_by_admin": false,
  "selected_team": {
    "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
    "display_name": "My Team",
    "profile_image_url": "https://example.com/image.jpg",
    "client_metadata": {
      "key": "value"
    },
    "client_read_only_metadata": {
      "key": "value"
    }
  },
  "primary_email": "[e-mail]",
  "display_name": "John Doe",
  "client_metadata": {
    "key": "value"
  },
  "client_read_only_metadata": {
    "key": "value"
  },
  "profile_image_url": "https://example.com/image.jpg",
  "selected_team_id": "team-id",
  "restricted_reason": null,
  "restricted_by_admin_reason": null
}

Body

application/json

display_name · string

Human-readable user display name. This is not a unique identifier.

Example:

"John Doe"

profile_image_url · string

URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

Example:

"https://example.com/image.jpg"

client_metadata · object

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

Example:

{ "key": "value" }

selected_team_id · string

ID of the team currently selected by the user

Example:

"team-id"

totp_secret_base64 · string

Enables 2FA and sets a TOTP secret for the user. Set to null to disable 2FA.

Example:

"dG90cC1zZWNyZXQ="

primary_email · string

Primary email

Example:

"[e-mail]"

Response

200 - application/json

Successful response

id · string · required

The unique identifier of the user

Example:

"3241a285-8329-4d69-8f3d-316e08cf140c"

primary_email_verified · boolean · required

Whether the primary email has been verified to belong to this user

Example:

true

signed_up_at_millis · number · required

The time the user signed up (identify) => (the number of milliseconds since epoch, January 1, 1970, UTC)

Example:

1630000000000

is_anonymous · boolean · required

is_restricted · boolean · required

Whether the user is in restricted state (has signed up but not completed onboarding requirements)

Example:

false

restricted_by_admin · boolean · required

Whether the user is restricted by an administrator. Can be set manually or by sign-up rules.

Example:

false

selected_team · object

Show child attributes

primary_email · string

Primary email

Example:

"[e-mail]"

display_name · string

Human-readable user display name. This is not a unique identifier.

Example:

"John Doe"

client_metadata · object

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

Example:

{ "key": "value" }

client_read_only_metadata · object

Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.

Example:

{ "key": "value" }

profile_image_url · string

URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

Example:

"https://example.com/image.jpg"

selected_team_id · string

ID of the team currently selected by the user

Example:

"team-id"

restricted_reason · object

The reason why the user is restricted (e.g., type: "email_not_verified", "anonymous", or "restricted_by_administrator"), null if not restricted

Show child attributes

Example:

null

restricted_by_admin_reason · string

Public reason shown to the user explaining why they are restricted. Optional.

Example:

null