Hypervisor User Groups Api List Hypervisor User Groups
Returns a Spring Data Page of groups (ADMIN, SECURITY_OPERATOR or AUDITOR); the SSH MFA Rule wizard reads this list.
Case-insensitive substring match on name or description; matched literally
ops
Zero-based page index (default: 0)
Number of items per page (default 20, maximum 200). A size above 200 is capped at 200, not rejected.
20
Sort spec in Spring Data 'property,direction' format (e.g. "name,asc"). This list publishes no list of sortable properties; use a property of the listed item.
name,asc
200 OK successful response envelope. A page of hypervisor user groups
{
"content": [
{
"id": 1,
"name": "Production Operators",
"description": "Operators who may log in to production ESXi hosts over SSH",
"memberCount": 2,
"mfaIneligibleMemberCount": 1,
"createdAt": "2026-01-15T09:36:00Z",
"updatedAt": "2026-01-15T09:38:00Z"
},
{
"id": 2,
"name": "Read-only Reviewers",
"description": "Staff who review SSH sessions without changing hosts",
"memberCount": 0,
"mfaIneligibleMemberCount": 0,
"createdAt": "2026-01-15T09:37:00Z",
"updatedAt": "2026-01-15T09:37:00Z"
}
],
"totalElements": 2,
"totalPages": 1,
"number": 0,
"size": 20,
"numberOfElements": 2,
"first": true,
"last": true,
"empty": false
}
The groups on the requested page
Total number of items matching the filters
Total number of pages at the requested page size
Zero-based page index
Requested page size
Number of items on this page
True when this is the first page
True when this is the last page
True when this page holds no items
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 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)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisor-user-groups