Sign in
Users
Deprecated

Update current user

Update the current user making the API request.

put/users/me

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/users/me
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Request body

avatarColor'primary' | 'pink' | 'red' | 'yellow' | 'blue' | 'green' | 'purple' | 'orange' | 'gray' | 'amber'

User avatar color

emailstring email

User email

namestring

User name

passwordstring

User password (deprecated, use change password endpoint)

Response

avatarColor'primary' | 'pink' | 'red' | 'yellow' | 'blue' | 'green' | 'purple' | 'orange' | 'gray' | 'amber' required

User avatar color

createdAtstring date-time required

Creation date

deletedAtstring date-time nullable required

Deletion date

emailstring email required

User email

idstring uuid required

User ID

isAdminboolean required

Is admin user

namestring required

User name

oauthIdstring required

OAuth ID

profileChangedAtstring date-time required

Profile change date

profileImagePathstring required

Profile image path

quotaSizeInBytesinteger nullable required

Storage quota in bytes

quotaUsageInBytesinteger nullable required

Storage usage in bytes

shouldChangePasswordboolean required

Require password change on next login

status'active' | 'removing' | 'deleted' required

User status

storageLabelstring nullable required

Storage label

updatedAtstring date-time required

Last update date

Example response

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "deletedAt": "2024-01-01T00:00:00.000Z",
  "license": {
    "activatedAt": "2024-01-01T00:00:00.000Z"
  },
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

Changes