User List

Returns a list of all users in the system.

Request

Property	Value
Method	`GET`
URL	`/api/users`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/users" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Parameter	Type	Description
`data`	array	Array of user objects
`data[].id`	integer	Unique identifier of the user
`data[].attributes.username.value`	string	The username
`data[].attributes.username.editable`	boolean	Indicates if the username can be modified
`data[].attributes.username.lockedBy`	string	Identifier of the entity that locked this field (if locked)
`data[].attributes.password.value`	string	Masked password value (always returns `"******"`)
`data[].attributes.password.editable`	boolean	Indicates if the password can be modified
`data[].attributes.password.masked`	boolean	Indicates if the password value is masked
`data[].attributes.password.lockedBy`	string	Identifier of the entity that locked this field (if locked)
`data[].attributes.algorithm.value`	string	Password hashing algorithm (e.g., `"PLAIN"`, `"SHA256"`)
`data[].attributes.algorithm.editable`	boolean	Indicates if the algorithm can be modified
`data[].attributes.algorithm.lockedBy`	string	Identifier of the entity that locked this field (if locked)
`data[].attributes.accessRights`	array	List of access rights assigned to the user
`data[].attributes.accessRights[].name`	`"server"` \| `"viewer"` \| `"application"` \| `"stream"`	Access right category name
`data[].attributes.accessRights[].value`	`"none"` \| `"read_only"` \| `"read_write"`	Access right level
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": [
    {
      "id": 0,
      "attributes": {
        "username": {
          "editable": true,
          "value": "username"
        },
        "password": {
          "editable": true,
          "masked": true,
          "value": "******"
        },
        "accessRights": [
          { "name": "server", "value": "read_write" },
          { "name": "viewer", "value": "read_write" },
          { "name": "application", "value": "read_write" },
          { "name": "stream", "value": "read_write" }
        ],
        "algorithm": {
          "editable": false,
          "value": "PLAIN"
        }
      }
    }
  ],
  "meta": {
    "executionTime": 1,
    "generatedAt": 1771843565672
  }
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.