SAMLTokenAuthentication

SAMLTokenAuthentication
SAMLTokenAuthentication

SAMLTokenAuthentication contains the information necessary to authenticate within a guest using a SAML bearer token.

SAML token authentication relies on a guest alias that associates a guest account with the subject and certificate encoded in a SAML token obtained from the VMware SSO Server.

  • Use the GuestAliasManager. AddGuestAlias method to create a guest alias.
  • Use a SAMLTokenAuthentication object for the auth parameter to guest operations methods.

After you have created an alias, you can use SAML token authentication for guest operations methods. Do not use SAML token authentication for the AcquireCredentialsInGuest and ReleaseCredentialsInGuest methods.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "interactiveSession": false,
    "token": "string",
    "username": "string"
}
string As password As password
token
Required

The SAML bearer token.

string
username
Optional

This is the guest user to be associated with the authentication.

If none is specified, a guest dependent mapping will decide what user account is applied.