Hypervisor Users Api Get Hypervisor User

Hypervisor Users Api Get Hypervisor User
Get one Hypervisor MFA User

ADMIN only; any other role gets 403 FORBIDDEN. 404 HYPERVISOR_USER_NOT_FOUND.

Request
URI
GET
https://{api_host}/api/v1/hypervisor-users/{id}
COPY
Path Parameters
integer
id
Required  

Hypervisor MFA User id

id example
1

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The hypervisor user, with no secret material

Returns HypervisorUserSummaryDto of type(s) application/json
{
    "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"
}
integer As int64 As int64
id
Required  

Identifier of the Hypervisor MFA User, assigned when the record is created

string
username
Required  

The name as entered by the administrator

string
canonicalUsername
Required  

The name the Agent matches an SSH login against: the entered name for SHARED_ROOT_PRINCIPAL and LOCAL, and for ACTIVE_DIRECTORY always lowercase in the form the user logs in with (user@domain, domain, backslash and user, or domain, slash and user)

string
displayName
Optional

Optional display name of at most 128 characters without control characters; null when none was set

string
email
Optional

Optional email address of at most 254 characters; null when none was set

string
identitySource
Required  

SHARED_ROOT_PRINCIPAL: OS login is root and the person types a Console username at the second prompt. LOCAL: a named local account. ACTIVE_DIRECTORY: an AD account; a realm is required.

  • SHARED_ROOT_PRINCIPAL: The canonical name is the name as entered (case kept, 1 to 64 letters, digits, dot, underscore or hyphen); a realm is refused, and the bare name root is refused
  • LOCAL: The canonical name is the name as entered (case kept, 1 to 64 letters, digits, dot, underscore or hyphen); a realm is refused, and the bare name root is refused
  • ACTIVE_DIRECTORY: A realm is required; the canonical name is lowercase, as user@domain when the realm contains a dot and as domain, backslash and user otherwise, or in the qualified form that was entered
Enumeration: SHARED_ROOT_PRINCIPAL, LOCAL, ACTIVE_DIRECTORY
string
realm
Optional

Present exactly when identitySource is ACTIVE_DIRECTORY

string
provisioningSource
Required  

How a Hypervisor MFA User record was created.

  • MANUAL: Created by the create operation
  • CSV_IMPORT: Created by the CSV import
Enumeration: MANUAL, CSV_IMPORT
string
enrollmentStatus
Required  

PENDING: no secret issued. ENROLLED: a secret is issued. REVOKED: every secret version is destroyed.

  • PENDING: The initial status; also set again when cancelling the first enrollment; only a PENDING user can be enrolled
  • ENROLLED: An enrollment was issued by enroll or re-enroll; also restored when cancelling a re-enroll returns to the previous enrollment
  • REVOKED: The revoke operation was applied; also set when cancelling a re-enroll finds no previous enrollment to restore
Enumeration: PENDING, ENROLLED, REVOKED
boolean
enabled
Required  

Whether the user is enabled; a new user starts enabled and the update operation changes it

integer As int32 As int32
secretVersion
Required  

Current secret version; 0 while PENDING

string As date-time As date-time
enrolledAt
Optional

Time the current MFA enrollment was issued by enroll or re-enroll; null while no enrollment has been issued, and again after the first enrollment is cancelled

string As date-time As date-time
createdAt
Required  

Time the user record was created

string As date-time As date-time
updatedAt
Required  

Time the user record was last changed


400

400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number

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.


404

404 Not Found: HYPERVISOR_USER_NOT_FOUND when no hypervisor user has the id

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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/{id}