Service - UnauthenticatedAccessUser

Class: VMware.Hv.UnauthenticatedAccessUser
See also: UnauthenticatedAccessUserData, UnauthenticatedAccessUserInfo, UserOrGroupId
Since: Horizon 7.1

Service Description

Service Interface for Unauthenticated Access user settings.

Methods

Methods defined in this Service
UnauthenticatedAccessUser_Create, UnauthenticatedAccessUser_Delete, UnauthenticatedAccessUser_Get, UnauthenticatedAccessUser_IsUnauthenticatedAccessUser, UnauthenticatedAccessUser_List, UnauthenticatedAccessUser_Update

UnauthenticatedAccessUser_Create

Creates Unauthenticated Access user using user data.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to create a new Unauthenticated Access user.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to to create a new Unauthenticated Access user.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the UnauthenticatedAccessUser used to make the method call.
userData	UnauthenticatedAccessUserData	attributes needed to create a Unauthenticated Access user.

Return Value

Type	Description
UserOrGroupId	User Id used for creating Unauthenticated Access user.

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.
InvalidRequest	Thrown if user is already an Unauthenticated Access user. Thrown if user is a kiosk user. Thrown if User Principal Name is null or empty.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_UNAUTHENTICATED_ACCESS_USER_CREATED	If the Unauthenticated Access user was successfully created.
VLSI_UNAUTHENTICATED_ACCESS_USER_CREATION_FAILED	If the Unauthenticated Access user could not be created.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_Create" type="vdi:UnauthenticatedAccessUser_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:UserOrGroupId"/>
               </sequence>
            </complexType>
         </element>

UnauthenticatedAccessUser_Delete

Deletes Unauthenticated Access user entry. Note that only users which was created in current pod can be deleted.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	is required to delete Unauthenticated Access user.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to delete Unauthenticated Access user.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the UnauthenticatedAccessUser used to make the method call.
userId	UserOrGroupId	AD user id which Unauthenticated Access user is associated with.

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.
InvalidRequest	Thrown if user is not an Unauthenticated Access user. Thrown if Unauthenticated Access user was created by other pod.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_UNAUTHENTICATED_ACCESS_USER_DELETED	If the Unauthenticated Access user was successfully deleted.
VLSI_UNAUTHENTICATED_ACCESS_USER_DELETION_FAILED	If the Unauthenticated Access user could not be deleted.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_Delete" type="vdi:UnauthenticatedAccessUser_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_DeleteResponse">
            <complexType/>
         </element>

UnauthenticatedAccessUser_Get

Gets Unauthenticated Access user info using id.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global config view privilege is required to read a Unauthenticated Access user info.
FEDERATED_LDAP_VIEW	Global LDAP view is required to read a global Unauthenticated Access user info.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the UnauthenticatedAccessUser used to make the method call.
userId	UserOrGroupId	User id of AD user.

Return Value

Type	Description
UnauthenticatedAccessUserInfo	Unauthenticated Access user info for the user with the given userId.

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="UnauthenticatedAccessUser_Get" type="vdi:UnauthenticatedAccessUser_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:UnauthenticatedAccessUserInfo"/>
               </sequence>
            </complexType>
         </element>

UnauthenticatedAccessUser_IsUnauthenticatedAccessUser

Returns true if the unauthenticated access user exists with given userId.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the UnauthenticatedAccessUser used to make the method call.
userId	UserOrGroupId	AD user id which Unauthenticated Access user is associated with.

Return Value

Type	Description
xsd:boolean	Returns true if the unauthenticated access user exists with given userId.

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="UnauthenticatedAccessUser_IsUnauthenticatedAccessUser" type="vdi:UnauthenticatedAccessUser_IsUnauthenticatedAccessUserRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_IsUnauthenticatedAccessUserResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

UnauthenticatedAccessUser_List

Lists the Unauthenticated Access User info of all Unauthenticated Access users.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global config view privilege is required to list the Unauthenticated Access users information.
FEDERATED_LDAP_VIEW	Global LDAP view is required to list global Unauthenticated Access users information.

Parameters

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

Return Value

Type	Description
UnauthenticatedAccessUserInfo[]	The list of all the Unauthenticated Access users info.

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="UnauthenticatedAccessUser_List" type="vdi:UnauthenticatedAccessUser_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:UnauthenticatedAccessUserInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

UnauthenticatedAccessUser_Update

Updates Unauthenticated Access user using user data.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to update existing Unauthenticated Access user.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to to update existing Unauthenticated Access user.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the UnauthenticatedAccessUser used to make the method call.
userData	UnauthenticatedAccessUserData	attributes needed to create a Unauthenticated Access user.

Return Value

Type	Description
UserOrGroupId	User Id used for creating Unauthenticated Access user.

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.
InvalidRequest	Thrown if user is not member of local pod. Thrown if user is a kiosk user. Thrown if User Principal Name is null or empty.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_UNAUTHENTICATED_ACCESS_USER_UPDATED	If the Unauthenticated Access user was successfully updated.
VLSI_UNAUTHENTICATED_ACCESS_USER_UPDATE_FAILED	If the Unauthenticated Access user could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_Update" type="vdi:UnauthenticatedAccessUser_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="UnauthenticatedAccessUser_UpdateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:UserOrGroupId"/>
               </sequence>
            </complexType>
         </element>