User¶
Application user entity. Users are authentication and authorization objects.
Endpoints¶
| Method | URL |
|---|---|
GET |
/user/<user> |
POST |
/user |
PUT |
/user/<user> |
DELETE |
/user/<user> |
GET /user/<user>¶
Payload: No payload.
Returns: The user (password field returns the hash, not the plaintext password).
POST /user¶
| Parameter | Type | Description |
|---|---|---|
username |
string | Username (email address) |
password_hash |
string | The user's password (plaintext on POST/PUT) |
parent |
int | User ID of the parent user |
smtp_server |
int | ID of the SMTP server for this user |
sms_server |
int | ID of the SMS server for this user |
limit_contacts |
int | Maximum contacts allowed across this user's lists |
limit_monthly_emails |
int | Maximum email messages per calendar month |
limit_monthly_sms |
int | Maximum SMS per calendar month |
Returns: The new user.
PUT /user/<user>¶
Same payload as POST.
Returns: The edited user.
DELETE /user/<user>¶
Payload: No payload.
Returns: The deleted user.