Users API

All

/api/v1/users

Returns the application's users

Responses

[
  {
    "id": 96,
    "username": "example",
    "email": "example",
    "admin": true,
    "role": [
      "example"
    ],
    "privileges": [
      "example"
    ],
    "lastActive": "example"
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Add

/api/v1/users/add

Add application user

Request parameters

{
  "userName": "example",
  "displayName": "example",
  "email": "email@example.com",
  "password": "example",
  "roles": [
    "example"
  ]
}

Responses

{
  "id": 96,
  "username": "example",
  "email": "example",
  "admin": true,
  "role": [
    "example"
  ],
  "privileges": [
    "example"
  ],
  "lastActive": "example"
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Delete

/api/v1/users/delete

Delete application user

Request parameters

{
  "userName": "example"
}

Responses

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Roles

/api/v1/users/roles

Get all available user roles

Responses

[
  {
    "roleId": 96,
    "roleName": "example",
    "allowedConnections": [
      "example"
    ],
    "privileges": [
      "example"
    ],
    "isReader": true
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Assign roles

/api/v1/users/roles/assign

Assign role(s) to application user

Request parameters

{
  "userName": "example",
  "displayName": "example",
  "email": "email@example.com",
  "password": "example",
  "roles": [
    "example"
  ]
}

Responses

{
  "id": 96,
  "username": "example",
  "email": "example",
  "admin": true,
  "role": [
    "example"
  ],
  "privileges": [
    "example"
  ],
  "lastActive": "example"
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

09 October 2026