User Management

GET /ATX/userManagement/users

Returns an array of users permissioned to access the device at various restriction levels

Example request:

GET /ATX/userManagement/users HTTP/1.0
Host: 192.168.168.168
Accept: application/json, text/javascript

Example response:

HTTP/1.0 200 OK
Content-Type: application/json

{
   "users": ["admin", "thomas"]
}

GET /ATX/userManagement/users/(string: user_id)

Returned detailed meta-data for a specific user

Example request:

GET /ATX/userManagement/users/thomas HTTP/1.0
Host: 192.168.168.168
Accept: application/json, text/javascript

Example response:

HTTP/1.0 200 OK
Content-Type: application/json

{
   "thomas": {
     "user": "thomas",
     "fail": 0,
     "enable": 1,
     "realms": ["/ATX/userManagement/users/thomas/pass", "1:/ATX/userManagement/users", "3:/ATX/exe/save"]
   }
}

Response JSON Object:  

• user (string) – The name of the user in reference
• fail (string) – The number of failed login attempts
• enable (number) – 1 - user is enabled, 0 - user is not enabled
• realms (object) – An array of URL endpoints that this user is allowed to have access too.

POST /ATX/userManagement/users

Create an additional user

Example request:

POST /ATX/userManagement/users HTTP/1.0
Host: 192.168.168.168
Accept: application/json, text/javascript
Content-Type: application/json

{
   "user":"new user name",
   "pass":"new user password",
   "realms":["/"]
}

Request JSON Object:  

• user (string) – The name of the new user
• pass (string) – The password of the new user
• realms (number) – An array of realms this new user shall have access too

Example response:

HTTP/1.0 200 OK
Content-Type: application/json

{
   "error":200
}