Click or drag to resize

VGMembershipInstanceCreateUser Method (String, String, String, String, String, Boolean, String, String, String, Boolean, Guid, VGMembershipCreateStatus)

Adds a new user to the Visual Guard 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
public VGMembershipUser CreateUser(
	string username,
	string password,
	string email,
	string passwordQuestion,
	string passwordAnswer,
	bool isApproved,
	string comment,
	string firstName,
	string lastName,
	bool mustChangePasswordAtNextLogon,
	Guid groupId,
	out VGMembershipCreateStatus status
)

Parameters

username
Type: SystemString
The user name for the new user.
password
Type: SystemString
The password for the new user.
email
Type: SystemString
The e-mail address for the new user.
passwordQuestion
Type: SystemString
The password-question value for the membership user.
passwordAnswer
Type: SystemString
The password-answer value for the membership user.
isApproved
Type: SystemBoolean
A Boolean value that indicates whether the new user is approved to log on.
comment
Type: SystemString
Specific information for the user.
firstName
Type: SystemString
The first name of the user.
lastName
Type: SystemString
The last name of the user.
mustChangePasswordAtNextLogon
Type: SystemBoolean
A Boolean value that indicates whether the new user must change the password at next logon.
groupId
Type: SystemGuid
A group of the user .
status
Type: Novalys.VisualGuard.Security.MembershipVGMembershipCreateStatus
A VGMembershipCreateStatus indicating that the user was created successfully or the reason creation failed.

Return Value

Type: VGMembershipUser
A VGMembershipUser object for the newly created user. null value when the creation fails.
Exceptions
ExceptionCondition
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.
Remarks
When a default role is defined for your application, the default role is automatically granted to the user. You can define a default role to your application in the Visual Guard console.
See Also