Hypervisor Users Api Enroll Hypervisor User

Hypervisor Users Api Enroll Hypervisor User
Issue the first secret

Issues the first secret (ADMIN); the user becomes ENROLLED. The response carries the seed once and is never cacheable (Cache-Control no-store). 409 ALREADY_ENROLLED unless the user is PENDING (use re-enroll); 503 MFA_KEY_UNAVAILABLE when no seed master key is available.

Request
URI
POST
https://{api_host}/api/v1/hypervisor-users/{id}/enroll
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; carries seed material exactly once

Returns EnrollmentSecretResponse of type(s) application/json
{
    "userId": 1,
    "username": "alice.example",
    "canonicalUsername": "alice.example",
    "manualEntryKey": "<redacted>",
    "otpauthUri": "<redacted>",
    "qrCodeSvg": "<redacted>",
    "secretVersion": 1,
    "enrolledAt": "2026-01-15T09:35:00Z"
}
integer As int64 As int64
userId
Required  

Identifier of the Hypervisor MFA User the enrollment was issued for

string
username
Required  

The name as entered by the administrator when the user was created

string
canonicalUsername
Required  

The name the Agent matches an SSH login against, as computed by the server when the user was created

string
manualEntryKey
Required  

Base32 setup key, grouped for manual entry

string
otpauthUri
Required  

otpauth://totp/ URI for authenticator apps

string
qrCodeSvg
Required  

SVG document of the QR code for otpauthUri

integer As int32 As int32
secretVersion
Required  

Version of the enrollment just issued: 1 for the first enrollment, and the previous version plus 1 for each re-enroll

string As date-time As date-time
enrolledAt
Required  

Time the enrollment was issued

Response Headers

string
Cache-Control

no-store; the body carries seed material and must never be cached

string
Pragma

undefined


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: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); 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 ForbiddenWrite 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
{
    "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.


409

409 Conflict: ALREADY_ENROLLED when the user is not PENDING, in which case re-enroll applies; ROOT_ENROLLMENT_NOT_ALLOWED when the user is the bare root OS account

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.


503

503 Service Unavailable: MFA_KEY_UNAVAILABLE when MFA secret protection is not available on the appliance

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 -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisor-users/{id}/enroll