Homarr
Users

Delete a user

DELETE/api/users/{userId}

Delete a user account. Users can delete themselves; deleting another user requires admin permission. 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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/users/string"
null

Get a user

Return a user's profile, authentication provider, and preferences. Users can read themselves; reading another user requires admin permission.

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.