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

NameTypeDescription
_thisManagedObjectReference A reference to the AuthenticationManager used to make the method call.
usernamexsd:string

The username
passwordSecureString

The password
domainxsd:string

The domain

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AuthenticationManager_LoginByToken

Login using supplied JWT token.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthenticationManager used to make the method call.
dataJwtTokenData

The token data.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



AuthenticationManager_Logout

Logout session.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the AuthenticationManager used to make the method call.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the AuthenticationManager used to make the method call.
localexsd:string

The locale of the user messages.
  • This can take the values:
  • ValueDescription
    deGerman Language
    enEnglish Language
    esSpanish Language
    frFrench Language
    jaJapanese Language
    koKorean Language
    zhChinese Language
    zh_TWChinese-Taiwan Language


Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition