v5.0_Users

GET users/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all users config in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/users/config

Example Request

GET 

  1. https://192.168.10.53/api/5.0/users/config

{ "data": [ { "uuid": "c627137f-b5e1-4ba1-b173-b802612b533b", "username": "Admin", "created": "2021-10-21T14:25:06.323Z", "modified": "2021-10-21T14:25:06.323Z", "role": "Admin" }, { "uuid": "cef69c2a-459f-431a-b0d3-f427dfb15293", "username": "eitan", "created": "2021-11-16T07:36:21.076Z", "modified": "2021-11-16T07:36:21.076Z", "role": "Admin" }, { "uuid": "4194f8ae-abd3-456a-984d-58eac72d0b02", "username": "Golan", "created": "2021-12-21T07:12:16.813Z", "modified": "2021-12-21T07:12:16.813Z", "role": "Admin" }, { "uuid": "8c323d80-df2b-486f-aa32-c8b21c86846c", "username": "Liyen", "created": "2021-11-16T16:07:01.888Z", "modified": "2021-11-16T16:07:01.888Z", "role": "Admin" } ], "metadata": { "item_count": 4, "total_items": 4, "current_page": 1, "sort_by": [ { "field": "username", "direction": "ASC" } ], "links": { "current": "http://192.168.10.53/api/5.0/users/config" } } }

 


 

GET users/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single users configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/users/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired users config.

Example Request

GET 

  1. https://192.168.10.53/api/5.0/users/config/c627137f-b5e1-4ba1-b173-b802612b533b

{ "data": { "uuid": "c627137f-b5e1-4ba1-b173-b802612b533b", "username": "Admin", "created": "2021-10-21T14:25:06.323Z", "modified": "2021-10-21T14:25:06.323Z", "role": "Admin" }, "metadata": {} }

 


 

DELETE users/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific users configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/users/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the users config to be deleted.

Example Request

DELETE 

  1. https://192.168.10.53/api/5.0/users/config/fe5e61a7-ead6-4bd1-983e-8322073995b1

{ "data": { "success": true }, "metadata": {} }

 


 

POST users/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new users, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/users/config

Example Request

POST 

  1. https://192.168.10.53/api/5.0/users/config

Body

Response