Homarr
Users

Create a user

POST/api/users

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.

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

curl -X POST "https://example.com/api/users" \  -H "Content-Type: application/json" \  -d '{    "username": "string",    "password": "stringst",    "confirmPassword": "string",    "groupIds": [      "string"    ]  }'
null

List all users

Return user IDs, names, email addresses, verification dates, and profile images. Requires admin permission.

Set a profile image

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.