BizUser.Disable Method
The Disable method disables a user. The user is not able to log on to the system after being disabled.
Syntax
[Visual Basic .NET]
Public Sub Disable(
ByVal Caller As CUserAuth,
ByVal UserId As String,
ByVal Reason As String
)
[C#]
public void Disable(
CUserAuth Caller,
string UserId,
string Reason
);
[C++]
public: void Disable(
CUserAuth* Caller,
String* UserId,
String* Reason
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvDisableUser privilege and access rights on the object to be disabled. See CUserAuth.
UserId
Specifies the ID of the user to be disabled. This ID is specified by the platform and obtained at creation time.
Reason
Specifies the reason for disabling the user.
Return Value
No return value.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
string strErrorMsg;
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Disable the user
bizUser.Disable(userAuth, strUserID, "A reason for being disabled");
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also