ClientUserAdd Method (String, String, String, String, ClientUserPermission, String, Boolean, String) |
Adds a new user with the provided attributes.
Namespace: MOVEit.DMZ.APIAssembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0
Syntax public bool UserAdd(
string Username,
string Password,
string RealName,
string Email,
ClientUserPermission Permission,
string Notes,
bool ForceChangePassword,
string OrgID
)
Public Function UserAdd (
Username As String,
Password As String,
RealName As String,
Email As String,
Permission As ClientUserPermission,
Notes As String,
ForceChangePassword As Boolean,
OrgID As String
) As Boolean
public:
bool UserAdd(
String^ Username,
String^ Password,
String^ RealName,
String^ Email,
ClientUserPermission Permission,
String^ Notes,
bool ForceChangePassword,
String^ OrgID
)
Parameters
- Username
- Type: SystemString
Username of the new user. - Password
- Type: SystemString
Password of the new user. - RealName
- Type: SystemString
Display name of the new user. - Email
- Type: SystemString
Email address of the new user. - Permission
- Type: MOVEit.DMZ.APIClientUserPermission
Permission code of the new user. - Notes
- Type: SystemString
Any notes to be added with the new user. - ForceChangePassword
- Type: SystemBoolean
When true, the user will be required to change their password on their first login. - OrgID
- Type: SystemString
ID of the organization to add the user to.
Return Value
Type:
Booleantrue if successful; otherwise,
false.
Remarks
The OrgID field is only used if the currently authenticated user is a SysAdmin.
See Also