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

NameTypeDescription
_thisManagedObjectReference A reference to the UnauthenticatedAccessUser used to make the method call.
userDataUnauthenticatedAccessUserData

attributes needed to create a Unauthenticated Access user.

Return Value

Type Description
UserOrGroupIdUser Id used for creating Unauthenticated Access user.

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.
InvalidRequestThrown if user is already an Unauthenticated Access user. Thrown if user is a kiosk user. Thrown if User Principal Name is null or empty.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



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

NameTypeDescription
_thisManagedObjectReference A reference to the UnauthenticatedAccessUser used to make the method call.
userIdUserOrGroupId

AD user id which Unauthenticated Access user is associated with.

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.
InvalidRequestThrown if user is not an Unauthenticated Access user. Thrown if Unauthenticated Access user was created by other pod.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



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

NameTypeDescription
_thisManagedObjectReference A reference to the UnauthenticatedAccessUser used to make the method call.
userIdUserOrGroupId

User id of AD user.

Return Value

Type Description
UnauthenticatedAccessUserInfoUnauthenticated Access user info for the user with the given userId.

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



UnauthenticatedAccessUser_IsUnauthenticatedAccessUser

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the UnauthenticatedAccessUser used to make the method call.
userIdUserOrGroupId

AD user id which Unauthenticated Access user is associated with.

Return Value

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

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



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

NameTypeDescription
_thisManagedObjectReference 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
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



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

NameTypeDescription
_thisManagedObjectReference A reference to the UnauthenticatedAccessUser used to make the method call.
userDataUnauthenticatedAccessUserData

attributes needed to create a Unauthenticated Access user.

Return Value

Type Description
UserOrGroupIdUser Id used for creating Unauthenticated Access user.

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.
InvalidRequestThrown if user is not member of local pod. Thrown if user is a kiosk user. Thrown if User Principal Name is null or empty.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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