๐จโ๐ผUsers
This page provides a description of the available API routes for managing users.
Every person that uses the system has their own user profile, which contains a collection of devices that the user is allowed to log into. For each device, the user can be granted different rights.
API methods
Get users
GET http://{server-address}/users
Returns all users that matches query parameters. Result is of type QueryResult<UserProfile>.
Query Parameters
| Name | Type | Description |
|---|---|---|
isActive | bool | Supports NData syntax. |
isVirtual | bool | Supports NData syntax. |
$skip | int | Pagination property. Describing number of records to skip from beginning of result collection. |
$take | int | Pagination property. Maximum count of items to be returned. |
$sort | string[] | Comma separated list of property names. Please see NData syntax. |
$count | bool | If set to |
featureName | string | Supports NData syntax. |
userName | string | Supports NData syntax. |
name | string | Supports NData syntax. |
Headers
| Name | Type | Description |
|---|---|---|
Authorization* | string | Authorization header with authorization token. |
{
"items":
[
{
"id": "62ffb6c57028d4f9c14f0fc1",
"isActive": true,
"isVirtual": false,
"userName": "999",
"featureName": null,
"name": "Majiteฤพ",
"devices":
[
{
"isActive": true,
"envName": "CashRegister",
"name": "P01",
"roles":
[
"admin"
],
"description": "Pokladลa 01",
"preferences":
{}
},
{
"isActive": true,
"envName": "BackOffice",
"name": "BackOffice",
"roles":
[
"admin"
],
"description": "BackOffice",
"preferences":
{}
},
{
"isActive": true,
"envName": "Tool",
"name": "mPOS Link",
"roles":
[
"admin"
],
"description": "mPOS Link",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA1",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA2",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "CashRegister",
"name": "P02",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
}
],
"hasPassword": false,
"_v": 4
},
{
"id": "63260d6e046c7b515ea93beb",
"isActive": true,
"isVirtual": true,
"userName": "Qerko",
"featureName": "Portos.Features.Qerko",
"name": "Qerko",
"devices":
[
{
"isActive": true,
"envName": "System",
"name": "SYSTEM",
"roles":
[
"admin"
],
"description": null,
"preferences":
{}
}
],
"hasPassword": false,
"_v": 1
}
],
"count": 2,
"totalCount": 2
}Get user
GET http://{server-address}/users/{id}
Result is of type UserProfile.
Path Parameters
| Name | Type | Description |
|---|---|---|
id* | string | Unique user identifier. |
Headers
| Name | Type | Description |
|---|---|---|
Authorization* | string | Authorization header with authorization token. |
{
"id": "62ffb6c57028d4f9c14f0fc1",
"isActive": true,
"isVirtual": false,
"userName": "999",
"featureName": null,
"name": "Majiteฤพ",
"devices":
[
{
"isActive": true,
"envName": "CashRegister",
"name": "P01",
"roles":
[
"admin"
],
"description": "Pokladลa 01",
"preferences":
{}
},
{
"isActive": true,
"envName": "BackOffice",
"name": "BackOffice",
"roles":
[
"admin"
],
"description": "BackOffice",
"preferences":
{}
},
{
"isActive": true,
"envName": "Tool",
"name": "mPOS Link",
"roles":
[
"admin"
],
"description": "mPOS Link",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA1",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA2",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "CashRegister",
"name": "P02",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
}
],
"hasPassword": false,
"_v": 1
}{
"title": "Zdroj nebol nรกjdenรฝ",
"status": 404
}Create user
POST http://{server-address}/users
Creates new user. Method accepts UserCreateUpdateContext in the request body. Result is of type UserProfile.
Required rights
Authorized user must have UserCreate right assigned.
Headers
| Name | Type | Description |
|---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
| Name | Type | Description |
|---|---|---|
(body)* | UserCreateUpdateContext | Context create or update user. |
{
"id": "62ffb6c57028d4f9c14f0fc1",
"isActive": true,
"isVirtual": false,
"userName": "999",
"featureName": null,
"name": "Majiteฤพ",
"devices":
[
{
"isActive": true,
"envName": "CashRegister",
"name": "P01",
"roles":
[
"admin"
],
"description": "Pokladลa 01",
"preferences":
{}
},
{
"isActive": true,
"envName": "BackOffice",
"name": "BackOffice",
"roles":
[
"admin"
],
"description": "BackOffice",
"preferences":
{}
},
{
"isActive": true,
"envName": "Tool",
"name": "mPOS Link",
"roles":
[
"admin"
],
"description": "mPOS Link",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA1",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA2",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "CashRegister",
"name": "P02",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
}
],
"hasPassword": false,
"_v": 1
}Create or update user
PUT http://{server-address}/users/{id}
Updates existing or creates new user. Method accepts UserCreateUpdateContext in the request body. Result is of type UserProfile.
Required rights
Authorized user must have assigned UserCreate or UserUpdate right.
Path Parameters
| Name | Type | Description |
|---|---|---|
id* | string | Unique user identifier. |
Headers
| Name | Type | Description |
|---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
| Name | Type | Description |
|---|---|---|
(body)* | UserCreateUpdateContext | Context create or update user. |
{
"id": "62ffb6c57028d4f9c14f0fc1",
"isActive": true,
"isVirtual": false,
"userName": "999",
"featureName": null,
"name": "Majiteฤพ",
"devices":
[
{
"isActive": true,
"envName": "CashRegister",
"name": "P01",
"roles":
[
"admin"
],
"description": "Pokladลa 01",
"preferences":
{}
},
{
"isActive": true,
"envName": "BackOffice",
"name": "BackOffice",
"roles":
[
"admin"
],
"description": "BackOffice",
"preferences":
{}
},
{
"isActive": true,
"envName": "Tool",
"name": "mPOS Link",
"roles":
[
"admin"
],
"description": "mPOS Link",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA1",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA2",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "CashRegister",
"name": "P02",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
}
],
"hasPassword": false,
"_v": 1
}Delete user
DELETE http://{server-address}/users/{id}
Required rights
Authorized user must have UserDelete right assigned.
Path Parameters
| Name | Type | Description |
|---|---|---|
id* | string | Unique user identifier. |
Headers
| Name | Type | Description |
|---|---|---|
Authorization* | string | Authorization header with authorization token. |
{
"id": "62ffb6c57028d4f9c14f0fc1",
"isActive": true,
"isVirtual": false,
"userName": "999",
"featureName": null,
"name": "Majiteฤพ",
"devices":
[
{
"isActive": true,
"envName": "CashRegister",
"name": "P01",
"roles":
[
"admin"
],
"description": "Pokladลa 01",
"preferences":
{}
},
{
"isActive": true,
"envName": "BackOffice",
"name": "BackOffice",
"roles":
[
"admin"
],
"description": "BackOffice",
"preferences":
{}
},
{
"isActive": true,
"envName": "Tool",
"name": "mPOS Link",
"roles":
[
"admin"
],
"description": "mPOS Link",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA1",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "PDA",
"name": "PDA2",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
},
{
"isActive": true,
"envName": "CashRegister",
"name": "P02",
"roles":
[
"sale",
"statsCurrent",
"statsTicketsCurrent",
"openDrawer",
"negativeSale",
"overviewSalesReport",
"ticketSplit",
"storno",
"stats",
"statsPlus",
"cashTransfer",
"allTickets",
"ticketSetDiscount",
"admin"
],
"description": "",
"preferences":
{}
}
],
"hasPassword": false,
"_v": 1
}{
"title": "Zdroj nebol nรกjdenรฝ",
"status": 404
}Last updated