Visual Guard Class Library Documentation
Visual Guard API Reference
Novalys.VisualGuard.Security.Membership
VGMembershipInstance Class
VGMembershipInstance Methods
AddActiveDirectoryEntity Method
AddActiveDirectoryGroup Method
AddActiveDirectoryUser Method
AddDBUser Method
AddFederatedUser Method
AddWindowsAccount Method
ApproveUser Method
ChangePassword Method
ChangePasswordByAnswer Method
ChangePasswordQuestionAndAnswer Method
CreateActiveDirectoryUser Method
CreateCustomUser Method
CreateUser Method
CreateUserForCurrentApplication Method
DeleteUser Method
DeleteUserById Method
DeleteWindowsAccount Method
DisapproveUser Method
DuplicateDBUser Method
DuplicateVGUser Method
DuplicateWindowAccountUser Method
FindInactiveUsersByLastActivityDate Method
FindUsersByAuthenticationMode Method
FindUsersByEmail Method
FindUsersByFirstName Method
FindUsersByLastName Method
FindUsersByName Method
FindUsersByProfileAttributeValue Method
FindUsersByState Method
FindUsersInAdfsServer Method
FindUsersInApplication Method
FindUsersWithoutApplications Method
ForcePassword Method
GetAllAuthenticationModeUsed Method
GetAllIdentitiesModulesUsed Method
GetAllUsers Method
GetChangePasswordIdentifier Method
GetPassword Method
GetPasswordQuestion Method
GetPrincipalCount Method
GetRecentUsers Method
GetUser Method
GetUserByEmail Method
GetUserById Method
GetUserIdByEmail Method
GetUserNameByEmail Method
GetWindowsAccount Method
GrantMembershipPermission Method
LockUser Method
ResetPassword Method
RevokeMembershipPermission Method
UnlockUser Method
UpdateUser Method
ValidateUser Method
Click or drag to resize

VGMembershipInstanceDeleteUserById Method

Note: This API is now obsolete.

Deletes a user specified by its repository id from the repository.

Namespace:  Novalys.VisualGuard.Security.Membership
Assembly:  Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
Syntax
Copy
[ObsoleteAttribute("Use DeleteUser(VGMembershipUser user,bool forAllApplication) method")]
public bool DeleteUserById(
	string repositoryId,
	bool forAllApplications
)

Parameters

repositoryId
Type: SystemString
The repository id of the user to delete.
forAllApplications
Type: SystemBoolean
true if the user must be deleted even the user is a member of another application, false otherwise

Return Value

Type: Boolean
true if the user was deleted; otherwise, false.
Exceptions
ExceptionCondition
VGIsMemberOfAnotherApplicationExceptionThe user is a member of an another application and the forAllApplications not equal to true. -or- The user is a master administrator of the console.
ArgumentNullExceptionrepositoryId is null.
ArgumentExceptionrepositoryId is empty or is longer than 256 characters.
SecurityExceptionThe current user does not have enough privileges to use Membership API. The Membership access level of the application must be sufficient to allows this action or the 'Membership Manager' role must be granted to the user by using the Visual Guard console.
See Also