Hypervisor Users Api List Hypervisor Users

Hypervisor Users Api List Hypervisor Users
List Hypervisor MFA Users

Returns a Spring Data Page of users. ADMIN only; any other role gets 403 FORBIDDEN. Carries no secret material.

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

Case-insensitive substring match on username, canonical username, display name and email; matched literally

search example
alice
enrollmentStatus
Optional

Filter by enrollment status

enrollmentStatus example
PENDING
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default: 0)

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

Number of items per page (default 20, maximum 200). A size above 200 is capped at 200, not rejected.

size example
20
string
sort
Optional

Sort spec in Spring Data 'property,direction' format (e.g. "canonicalUsername,asc"). Sortable properties: id, username, canonicalUsername, displayName, email, identitySource, realm, provisioningSource, enrollmentStatus, enabled, secretVersion, enrolledAt, createdAt, updatedAt. Any other property is rejected with 400 INVALID_SORT.

sort example
canonicalUsername,asc

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of hypervisor users, with no secret material

Returns SpringPage_HypervisorUserSummaryDto of type(s) application/json
{
    "content": [
        {
            "id": 1,
            "username": "alice.example",
            "canonicalUsername": "alice.example",
            "displayName": "Alice Example",
            "email": "[email protected]",
            "identitySource": "LOCAL",
            "provisioningSource": "MANUAL",
            "enrollmentStatus": "ENROLLED",
            "enabled": true,
            "secretVersion": 1,
            "enrolledAt": "2026-01-15T09:35:00Z",
            "createdAt": "2026-01-15T09:30:00Z",
            "updatedAt": "2026-01-15T09:35:00Z"
        },
        {
            "id": 2,
            "username": "bob.example",
            "canonicalUsername": "[email protected]",
            "displayName": "Bob Example",
            "email": "[email protected]",
            "identitySource": "ACTIVE_DIRECTORY",
            "realm": "example.com",
            "provisioningSource": "CSV_IMPORT",
            "enrollmentStatus": "PENDING",
            "enabled": true,
            "secretVersion": 0,
            "createdAt": "2026-01-15T09:32:00Z",
            "updatedAt": "2026-01-15T09:32:00Z"
        }
    ],
    "totalElements": 2,
    "totalPages": 1,
    "number": 0,
    "size": 20,
    "numberOfElements": 2,
    "first": true,
    "last": true,
    "empty": false
}
array of object
content
Required  

The users on the requested page

integer As int64 As int64
totalElements
Required  

Total number of items matching the filters

integer As int32 As int32
totalPages
Required  

Total number of pages at the requested page size

integer As int32 As int32
number
Required  

Zero-based page index

integer As int32 As int32
size
Required  

Requested page size

integer As int32 As int32
numberOfElements
Optional

Number of items on this page

boolean
first
Optional

True when this is the first page

boolean
last
Optional

True when this is the last page

boolean
empty
Optional

True when this page holds no items


400

400 Bad Request: INVALID_ARGUMENT when enrollmentStatus is not a known status or a parameter has the wrong type; INVALID_SORT when sort names a property that cannot be sorted on

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: 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 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.


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