VGMembershipDeleteUser Method (String, Boolean)
|
Deletes a user from the repository.
Namespace:
Novalys.VisualGuard.Security.Membership
Assembly:
Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.0.101.19 (2019.0.0101.19)
Syntax public static bool DeleteUser(
string username,
bool forAllApplications
)
Public Shared Function DeleteUser (
username As String,
forAllApplications As Boolean
) As Boolean
Parameters
- username
- Type: SystemString
The name 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:
Booleantrue if the user was deleted; otherwise, false.
Exceptions Exception | Condition |
---|
VGIsMemberOfAnotherApplicationException | The 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. |
ArgumentNullException | username is null. |
ArgumentException | username is empty or is longer than 64 characters or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ','). |
SecurityException | The current user has not 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