GET users/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns meta data information used by Users configuration.

Resource URL

http://{host}/api/2.0/users/meta/.format

Example Request

GET

http://44.235.52.211/api/2.0/users/meta/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Groups": {
        "1": "Administrators",
        "2": "Technicians",
        "3": "Viewers"
    }
}

GET users

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of all Users configuration in the system.

Resource URL

http://{host}/api/2.0/users/.format

Example Request

GET

http://44.235.52.211/api/2.0/users/.json

Expand

title	RESPONSE

Code Block

language	json

[
    {
        "User": {
            "id": 1,
            "username": "Admin",
            "modified": "1612359795589",
            "created": "1611142282208",
            "last_login": "1612359795589",
            "group_id": 1
        }
    },
    {
        "User": {
            "id": 2,
            "username": "Tech",
            "modified": "1611142282208",
            "created": "1611142282208",
            "last_login": null,
            "group_id": 2
        }
    },
    {
        "User": {
            "id": 3,
            "username": "View",
            "modified": "1611142282208",
            "created": "1611142282208",
            "last_login": null,
            "group_id": 3
        }
    }
]

GET users/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a single specific User configuration.

Resource URL

http://{host}/api/2.0/users/{id}/.format

Example Request

GET

http://44.235.52.211/api/2.0/users/1/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "User": {
        "id": 1,
        "username": "Admin",
        "modified": "1612359795589",
        "created": "1611142282208",
        "last_login": "1612359795589",
        "group_id": 1
    }
}

POST users

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new User.

Resource URL

http://{host}/api/2.0/users/.format

Example Request

POST

http://44.235.52.211/api/2.0/users/.json

Expand

title

Body

BODY

Code Block

language	json

{
    "User": {
        "username": "NEW_USER",
        "password": "password",
        "group_id": 3
    }
}

Expand

title

Response

RESPONSE

Code Block
{ "User": { "id": 4, "username": "NEW_USER", "modified": "1619962757463", "created": "1619962757463", "last_login": null, "group_id": 3 } }

PUT users/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates a single specific User information.

Resource URL

http://{host}/api/2.0/users/{id}/.format

Parameters

Parameter	Data Type	Description
1 (required)	integer	The ID of the desired User information to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/users/4/.json

Expand

title

Body

BODY

Code Block

language	json

{
    "User": {
        "username": "EDIT_USER",
        "password": "newpassWord",
        "group_id": 2
    }
}

Expand

Response

title	RESPONSE

Code Block
{ "User": { "id": 4, "username": "EDIT_USER", "modified": "1619962822452", "created": "1619962757463", "last_login": null, "group_id": 2 } }

DELETE users/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes a single specific User.

Resource URL

http://{host}/api/2.0/users/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired User to be deleted.

Example Request

DELETE

http://44.235.52.211/api/2.0/users/4/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "success": true
}

Versions Compared

Old Version 1

New Version Current

Key

GET users/meta

Resource Information

Resource URL

Example Request

GET users

Resource Information

Resource URL

Example Request

GET users/{id}

Resource Information

Resource URL

Example Request

POST users

Resource Information

Resource URL

Example Request

PUT users/{id}

Resource Information

Resource URL

Parameters

Example Request

DELETE users/{id}

Resource Information

Resource URL

Parameters

Example Request

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

GET users/meta

Resource Information

Resource URL

Example Request

GET users

Resource Information

Resource URL

Example Request

GET users/{id}

Resource Information

Resource URL

Example Request

POST users

Resource Information

Resource URL

Example Request

PUT users/{id}

Resource Information

Resource URL

Parameters

Example Request

DELETE users/{id}

Resource Information

Resource URL

Parameters

Example Request