Hypervisor User Groups Api List Hypervisor User Group Members
Members sorted by canonical username, unpaged. ADMIN only; any other role gets 403 FORBIDDEN (they see mfaIneligibleMemberCount on the group instead). 404 HYPERVISOR_USER_GROUP_NOT_FOUND.
Group id
1
200 OK successful response envelope. The members of the group sorted by username, unpaged
[
{
"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"
}
]
A Hypervisor MFA User as listed and fetched. Carries no secret material, ever. canonicalUsername is the server-computed name the Agent matches an SSH login against; it is unique case-insensitively.
400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number
{
"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.
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.
404 Not Found: HYPERVISOR_USER_GROUP_NOT_FOUND when no hypervisor user group has the id
"ApiErrorResponse Object"
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/{id}/members