Skip to main content

​
Get All Users

Retrieve all user accounts with pagination and filtering.
This endpoint requires ROLE_ADMIN permissions.

​
Query Parameters

​
page
integer
default:"0"
Page number (zero-based)
​
size
integer
default:"20"
Number of items per page
​
sort
string
Sort field and direction (e.g., login,asc)
​
login
string
Filter users by login name (partial match)

​
Response

Returns an array of user objects.
​
id
integer
User ID
​
login
string
Username
​
firstName
string
User’s first name
​
lastName
string
User’s last name
​
email
string
User’s email address
​
activated
boolean
Whether the user account is activated
​
langKey
string
User’s language preference
​
authorities
array
Array of role names assigned to the user
​
imageUrl
string
URL to user’s profile image
curl -X GET "https://your-utmstack-instance.com/api/users?page=0&size=20" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

[
  {
    "id": 1,
    "login": "admin",
    "firstName": "Admin",
    "lastName": "User",
    "email": "[email protected]",
    "activated": true,
    "langKey": "en",
    "authorities": ["ROLE_ADMIN"],
    "imageUrl": null
  },
  {
    "id": 2,
    "login": "analyst1",
    "firstName": "Security",
    "lastName": "Analyst",
    "email": "[email protected]",
    "activated": true,
    "langKey": "en",
    "authorities": ["ROLE_USER"],
    "imageUrl": null
  }
]

​
Get User by Login

Retrieve a specific user by their login name.
This endpoint requires ROLE_ADMIN permissions.

​
Path Parameters

​
login
string
required
User’s login name
curl -X GET https://your-utmstack-instance.com/api/users/analyst1 \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

{
  "id": 2,
  "login": "analyst1",
  "firstName": "Security",
  "lastName": "Analyst",
  "email": "[email protected]",
  "activated": true,
  "langKey": "en",
  "authorities": ["ROLE_USER"],
  "imageUrl": null
}

​
Filter Users by Login

Search for users by partial login match, excluding the current user.
This endpoint requires ROLE_ADMIN permissions.

​
Path Parameters

​
login
string
required
Partial login name to search for

​
Query Parameters

​
page
integer
default:"0"
Page number
​
size
integer
default:"20"
Page size
curl -X GET "https://your-utmstack-instance.com/api/users/filter/analyst?page=0&size=20" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

[
  {
    "id": 2,
    "login": "analyst1",
    "firstName": "Security",
    "lastName": "Analyst",
    "email": "[email protected]",
    "activated": true,
    "langKey": "en",
    "authorities": ["ROLE_USER"]
  },
  {
    "id": 3,
    "login": "analyst2",
    "firstName": "Senior",
    "lastName": "Analyst",
    "email": "[email protected]",
    "activated": true,
    "langKey": "en",
    "authorities": ["ROLE_USER", "ROLE_ANALYST"]
  }
]

​
Get User Authorities

Get a list of all available user roles/authorities.
This endpoint requires ROLE_ADMIN permissions.
curl -X GET https://your-utmstack-instance.com/api/users/authorities \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

[
  "ROLE_ADMIN",
  "ROLE_USER",
  "ROLE_ANALYST",
  "ROLE_VIEWER"
]

​
Response Headers

Paginated endpoints include:
  • X-Total-Count - Total number of users
  • Link - Pagination links (first, last, next, prev)

​
User Roles

Common user authorities:
  • ROLE_ADMIN - Full system access
  • ROLE_USER - Standard user access
  • ROLE_ANALYST - Security analyst permissions
  • ROLE_VIEWER - Read-only access

Build docs developers (and LLMs) love

Get started for freeTalk to us