Client.UserChangeStatus Method (String, String, String)

ClientUserChangeStatus Method (String, String, String)

Changes the status of the specified user.

Namespace: MOVEit.DMZ.API
Assembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0

Syntax

public bool UserChangeStatus(
	string Username,
	string Status,
	string StatusNote
)

Public Function UserChangeStatus ( 
	Username As String,
	Status As String,
	StatusNote As String
) As Boolean

public:
bool UserChangeStatus(
	String^ Username, 
	String^ Status, 
	String^ StatusNote
)

Parameters

Username: Type: SystemString
Username to change status of.
Status: Type: SystemString
Either "active" or "suspended".
StatusNote: Type: SystemString
Any notes to be added to the user's status.

Return Value

Type: Boolean
true if successful; otherwise, false.

Remarks

The value of Status must be either "active" or "suspended". The StatusNote argument allows the user to provide a reason why the user was locked or unlocked.

Reference

Client Class

UserChangeStatus Overload

MOVEit.DMZ.API Namespace