Users
This page provides a description of the available API routes for managing users.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing users.
Last updated
Was this helpful?
Every person that uses the system has their own , which contains a collection of 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 .
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.
{
"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}
id*
string
Unique user identifier.
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
}
POST
http://{server-address}/users
Required rights
Authorization*
string
Authorization header with authorization token.
(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
}
PUT
http://{server-address}/users/{id}
Required rights
id*
string
Unique user identifier.
Authorization*
string
Authorization header with authorization token.
(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
http://{server-address}/users/{id}
Required rights
id*
string
Unique user identifier.
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
}
Result is of type .
Creates new user. Method accepts in the request body. Result is of type .
Authorized user must have UserCreate
assigned.
Updates existing or creates new user. Method accepts in the request body. Result is of type .
Authorized user must have assigned UserCreate
or UserUpdate
.
Authorized user must have UserDelete
assigned.