User#
This allows user accounts on the controller to be added, modified, or removed.
Methods#
POST#
POST /api/user
Add a new user. The payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
The password for the current session. |
|
|
string |
The name of the new user to add |
|
|
string |
The new user’s password. |
|
|
array of strings |
The access level(s) to grant the new user. Includes Admin, Control and Status. |
|
PUT#
PUT /api/user
Update a user account with a new password and/or access groups. The payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
The password for the current session. |
|
|
string |
The name of the user to modify |
|
|
string |
The user’s updated password. |
|
|
array of strings |
The access level(s) to grant the user. Includes Admin, Control and Status. |
|
DELETE#
DELETE /api/user
Update a user account with a new password and/or access groups. The payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
The password for the current session. |
|
|
string |
The name of the user to delete |
|