Homarr
Users

Change a user password

PATCH/api/users/{userId}/changePassword

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.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Path Parameters

userId*string

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 PATCH "https://example.com/api/users/string/changePassword" \  -H "Content-Type: application/json" \  -d '{    "previousPassword": "string",    "password": "stringst",    "confirmPassword": "string"  }'
null

Update a user 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.

Change user home boards

Set or clear a user's desktop and mobile home boards. The caller must be able to view each selected board. Users can update themselves; updating another user requires admin permission.