Users Operations List

Users Operations List
List and search console users with pagination (Administrator only)

Returns a paginated collection of console user summaries matching query criteria.

Request
URI
GET
https://{api_host}/api/v1/users
COPY
Query Parameters
string
q
Optional

Case-insensitive substring search matching username, display name, or email

q example
alice
role
Optional

Filter by role

role example
SECURITY_OPERATOR
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default: 0)

integer
size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Number of items per page (default 20, maximum 100). A size above 100 answers 400 INVALID_PAGE_SIZE; it is not clamped.

size example
20
string
sort
Optional

Sort spec in Spring Data 'property,direction' format (e.g. "username,desc"). This list publishes no list of sortable properties; use a property of the listed item.

sort example
username,asc

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of user summaries, filtered by the optional q text and role

Returns PaginatedResponse_UserSummaryDto of type(s) application/json
{
    "items": [
        {
            "id": 0,
            "username": "string",
            "displayName": "string",
            "email": "string",
            "role": "string",
            "authSource": "string",
            "lastLoginAt": "string",
            "mustChangePassword": false
        }
    ],
    "page": 0,
    "pageSize": 0,
    "totalItems": 0,
    "totalPages": 0
}
array of object
items
Required  

Array of items for the current page

integer As int32 As int32
page
Required  
Constraints: minimum: 0

Zero-based current page number

integer As int32 As int32
pageSize
Required  
Constraints: minimum: 1 maximum: 100

Number of items requested per page

integer As int64 As int64
totalItems
Required  

Total number of items matching filter criteria

integer As int32 As int32
totalPages
Required  
Constraints: minimum: 0

Total number of available pages


400

400 Bad Request: INVALID_ARGUMENT when role is not a known role or a parameter has the wrong type; INVALID_PAGE_SIZE when size is outside 1 to 100

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ForbiddenRead of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/users