Homarr
Users

Update a user profile

PUT/api/users/profile

Update a credentials account's username and email. Users can update themselves; updating another user requires admin permission. External-provider profiles cannot be edited, and username changes are disabled in demo mode.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/users/profile" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "name": "string"  }'
null

Delete a user

Delete a user account. Users can delete themselves; deleting another user requires admin permission. Disabled in demo mode.

Change a user password

Change a credentials account's password. Changing your own password requires the previous password, including for admins. Admins can reset another user's password without verifying their previous password. Disabled in demo mode.