HypervisorUserSummaryDto

HypervisorUserSummaryDto
HypervisorUserSummaryDto

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.

JSON Example
{
    "id": 0,
    "username": "string",
    "canonicalUsername": "string",
    "displayName": "string",
    "email": "string",
    "identitySource": "string",
    "realm": "string",
    "provisioningSource": "string",
    "enrollmentStatus": "string",
    "enabled": false,
    "secretVersion": 0,
    "enrolledAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
}
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

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

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
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