VmGuestCredentials

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


Properties

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.


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.


type Required

The guest credentials type

Possible values are: USERNAME_PASSWORDSAML_BEARER_TOKEN


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.

JSON Example

{
    "interactive_session": false,
    "type": "enum"
}
Feedback

Was this page helpful?