๐จโ๐ผUsers
This page provides a description of the available API routes for managing users.
Last updated
This page provides a description of the available API routes for managing users.
Last updated
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.
GET http://{server-address}/users
Returns all users that matches query parameters. Result is of type QueryResult<UserProfile>.
| Name | Type | Description |
|---|---|---|
{
"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 http://{server-address}/users/{id}
Result is of type UserProfile.
{
"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
}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.
{
"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
}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.
{
"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 http://{server-address}/users/{id}
Required rights
Authorized user must have UserDelete right assigned.
{
"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
}| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| 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 true, response will not contain items collection. Use to get resource count, not the resources themselves.
featureName
string
Supports NData syntax.
userName
string
Supports NData syntax.
name
string
Supports NData syntax.
Authorization*
string
Authorization header with authorization token.
id*
string
Unique user identifier.
Authorization*
string
Authorization header with authorization token.
Authorization*
string
Authorization header with authorization token.
(body)*
UserCreateUpdateContext
Context create or update user.
id*
string
Unique user identifier.
Authorization*
string
Authorization header with authorization token.
(body)*
UserCreateUpdateContext
Context create or update user.
id*
string
Unique user identifier.
Authorization*
string
Authorization header with authorization token.