Homarr
Users

Set a profile image

PUT/api/users/profileImage

Set a user's image to a base64 PNG, JPEG, GIF, or WebP data URL, or null to clear it. The data URL is limited to 350,000 characters. Users can update themselves; updating another user requires admin permission.

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/profileImage" \  -H "Content-Type: application/json" \  -d '{    "userId": "string",    "image": "string"  }'
null

Create a user

Create a credentials account and assign the supplied groups. Requires admin permission and credentials authentication to be enabled. The username must be unique and password confirmation must match.

List selectable users

Return user IDs, names, profile images, and email addresses for selection controls, optionally filtered by authentication provider. Requires authentication.