Update user

PATCH

Updates a user. Only the values provided will be updated.

Path parameters

user_idstringRequired

The ID of the user, or the special value me for the currently authenticated user

Request

This endpoint expects an object.

display_namestringOptional

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

profile_image_urlstringOptional

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.

client_metadatamap from strings to anyOptional

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

client_read_only_metadatamap from strings to anyOptional

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.

server_metadatamap from strings to anyOptional

Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the user here.

primary_emailstringOptional

Primary email

primary_email_verifiedbooleanOptional

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

primary_email_auth_enabledbooleanOptional

Whether the primary email is used for authentication. If this is set to false, the user will not be able to sign in with the primary email with password or OTP

passwordstringOptional

Sets the user’s password. Doing so revokes all current sessions.

password_hashstringOptional

If password is not given, sets the user’s password hash to the given string in Modular Crypt Format (ex.: $2a$10$VIhIOofSMqGdGlL4wzE//e.77dAQGqNtF/1dT7bqCrVtQuInWy2qi). Doing so revokes all current sessions.

totp_secret_base64stringOptional

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

selected_team_idstringOptional

ID of the team currently selected by the user

Response

Successful response

idstring

The unique identifier of the user

primary_email_verifiedboolean

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

primary_email_auth_enabledboolean

Whether the primary email is used for authentication. If this is set to false, the user will not be able to sign in with the primary email with password or OTP

signed_up_at_millisdouble

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

last_active_at_millisdouble

The time the user was last active identify=>(the number of milliseconds since epoch, January 1, 1970, UTC)

primary_emailstringOptional

Primary email

display_namestringOptional

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

selected_teamobjectOptional

selected_team_idstringOptional

ID of the team currently selected by the user

profile_image_urlstringOptional

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.

client_metadatamap from strings to anyOptional

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

client_read_only_metadatamap from strings to anyOptional

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.

server_metadatamap from strings to anyOptional

Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the user here.

PATCH

1 curl -X PATCH https://api.stack-auth.com/api/v1/users/3241a285-8329-4d69-8f3d-316e08cf140c \
2      -H "Content-Type: application/json" \
3      -d '{
4   "display_name": "John Doe",
5   "profile_image_url": "https://example.com/image.jpg",
6   "client_metadata": {
7     "key": "value"
8   },
9   "client_read_only_metadata": {
10     "key": "value"
11   },
12   "server_metadata": {
13     "key": "value"
14   },
15   "primary_email": "johndoe@example.com",
16   "primary_email_verified": true,
17   "primary_email_auth_enabled": true,
18   "password": "my-new-password",
19   "totp_secret_base64": "dG90cC1zZWNyZXQ=",
20   "selected_team_id": "team-id"
21 }'

200Updated

1 {
2   "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
3   "primary_email_verified": true,
4   "primary_email_auth_enabled": true,
5   "signed_up_at_millis": 1630000000000,
6   "last_active_at_millis": 1630000000000,
7   "primary_email": "johndoe@example.com",
8   "display_name": "John Doe",
9   "selected_team": {
10     "created_at_millis": 1630000000000,
11     "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
12     "display_name": "My Team",
13     "server_metadata": {
14       "key": "value"
15     },
16     "profile_image_url": "https://example.com/image.jpg",
17     "client_metadata": {
18       "key": "value"
19     },
20     "client_read_only_metadata": {
21       "key": "value"
22     }
23   },
24   "selected_team_id": "team-id",
25   "profile_image_url": "https://example.com/image.jpg",
26   "client_metadata": {
27     "key": "value"
28   },
29   "client_read_only_metadata": {
30     "key": "value"
31   },
32   "server_metadata": {
33     "key": "value"
34   }
35 }