CreateHypervisorUserRequest

CreateHypervisorUserRequest
CreateHypervisorUserRequest

Identity fields (username, identitySource, realm) are fixed at creation.

JSON Example
{
    "username": "string",
    "displayName": "string",
    "email": "string",
    "identitySource": "string",
    "realm": "string"
}
string
username
Required  

1-64 characters of letters, digits, dot, underscore or hyphen. For ACTIVE_DIRECTORY the same user part, optionally qualified as DOMAIN\user, user@domain or DOMAIN/user with a domain equal to realm (case-insensitive)

string
displayName
Optional
Constraints: maxLength: 128

Optional display name; more than 128 characters or any control character is rejected with 400 INVALID_HYPERVISOR_USER, and a blank value is stored as null

string
email
Optional
Constraints: maxLength: 254

Optional email address in the form [email protected] without spaces; an invalid or longer than 254 characters address is rejected with 400 INVALID_HYPERVISOR_USER, and a blank value is stored as null

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

Required for ACTIVE_DIRECTORY (NetBIOS or DNS domain name); refused for the other sources