Vm_Guest_Credentials

The Credentials structure defines the guest credentials used for guest operation authentication.

JSON Example

{
    "interactive_session": false,
    "type": "string",
    "user_name": "string",
    "password": "string",
    "saml_token": "string"
}

boolean

interactive_session

Required

If set, the operation will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the Credentials. This is currently only supported for USERNAME_PASSWORD.

Vm_Guest_Credentials_Type

type

Required

Types of guest credentials
USERNAME_PASSWORD : USERNAME_PASSWORD credentials contains the information necessary to authenticate within a guest using a username and password. This method of authentication is stateless. To use USERNAME_PASSWORD, populate userName and password with the appropriate login information.

Once populated, you can use USERNAME_PASSWORD in any guest operations operation.
SAML_BEARER_TOKEN : SAML_BEARER_TOKEN contains the information necessary to authenticate within a guest using a SAML token. SAML Bearer token credentials relies on a guest alias that associates a guest account with the subject and certificate encoded in a SAML Bearer token obtained from the VMware SSO Server.

string

user_name

Optional

For SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For USERNAME_PASSWORD this is the guest username. If no user is specified for SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied.

string As password

password

Optional

password This field is optional and it is only relevant when the value of Credentials.type is USERNAME_PASSWORD.

string As password

saml_token

Optional

SAML Bearer Token This field is optional and it is only relevant when the value of Credentials.type is SAML_BEARER_TOKEN.