EnrollmentSecretResponse

EnrollmentSecretResponse
EnrollmentSecretResponse

The only schema that carries seed material (manualEntryKey, otpauthUri, qrCodeSvg). Returned exactly once, by enroll or re-enroll, with Cache-Control no-store and Pragma no-cache; no later read returns it and the Console cannot reproduce it.

JSON Example
{
    "userId": 0,
    "username": "string",
    "canonicalUsername": "string",
    "manualEntryKey": "string",
    "otpauthUri": "string",
    "qrCodeSvg": "string",
    "secretVersion": 0,
    "enrolledAt": "string"
}
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