View API

			Local Methods
Service Types	Data Object Types	All Properties	All Methods

Service - AuthenticationManager

Class

VMware.Hv.AuthenticationManager

See also

JwtTokenData, SecureString

Service Description

AuthenticationManager provides administrative login capability.

Methods

Methods defined in this Service
AuthenticationManager_Login, AuthenticationManager_LoginByToken, AuthenticationManager_Logout, AuthenticationManager_SetLocale

AuthenticationManager_Login

Login using supplied credentials.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthenticationManager used to make the method call.
username	xsd:string	The username
password	SecureString	The password
domain	xsd:string	The domain

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_Login" type="vdi:AuthenticationManager_LoginRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_LoginResponse"> <complexType/> </element>

AuthenticationManager_LoginByToken

Login using supplied JWT token.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthenticationManager used to make the method call.
data	JwtTokenData	The token data.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_LoginByToken" type="vdi:AuthenticationManager_LoginByTokenRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_LoginByTokenResponse"> <complexType/> </element>

AuthenticationManager_Logout

Logout session.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthenticationManager used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_Logout" type="vdi:AuthenticationManager_LogoutRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_LogoutResponse"> <complexType/> </element>

AuthenticationManager_SetLocale

Used to specify the locale for the user messages. If locale is not set with this method, the messages will default to English language.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AuthenticationManager used to make the method call.
locale	xsd:string	The locale of the user messages. This can take the values: Value Description de German Language en English Language es Spanish Language fr French Language ja Japanese Language ko Korean Language zh Chinese Language zh_TW Chinese-Taiwan Language

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_SetLocale" type="vdi:AuthenticationManager_SetLocaleRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AuthenticationManager_SetLocaleResponse"> <complexType/> </element>

Top of page			Local Methods
Service Types	Data Object Types	All Properties	All Methods