Voorbeeld: Een gebruiker uitschakelen
Gepubliceerd: november 2016
Is van toepassing op: Dynamics CRM 2015
Deze voorbeeldcode is voor Microsoft Dynamics CRM 2015 en Microsoft Dynamics CRM Online 2015 Update.Download het Microsoft Dynamics CRM SDK-pakket. U vindt deze op de volgende locatie in het download-pakket:
SampleCode\CS\BusinessDataModel\UsersAndRoles\DisableOREnableUser.cs
Vereisten
Voor meer informatie over de vereisten voor het uitvoeren van de voorbeeldcode in deze SDK, zie Het voorbeeld en de helpercode gebruiken.
Demonstreert
Dit voorbeeld toont hoe u een gebruiker in een Active Directory-omgeving maakt met het bericht SetStateRequest. Een stukje dat de belangrijkste secties van het voorbeeld toont, wordt eerst weergegeven, gevolgd door de Volledige voorbeeldcode. Houd er rekening mee dat dit voorbeeld alleen in een on-premises omgeving kan worden uitgevoerd omdat het een gebruiker maakt. Het deel van het voorbeeld dat het uitschakelen van de gebruiker toont, werkt echter in alle omgevingen.
Voorbeeld
// Connect to the Organization service.
// The using statement assures that the service proxy is properly disposed.
using (_serviceProxy = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri,serverConfig.Credentials, serverConfig.DeviceCredentials))
{
_serviceProxy.EnableProxyTypes();
CreateRequiredRecords();
// Retrieve a user.
SystemUser user = _serviceProxy.Retrieve(SystemUser.EntityLogicalName,
_userId, new ColumnSet(new String [] {"systemuserid", "firstname", "lastname"})).ToEntity<SystemUser>();
if (user != null)
{
Console.WriteLine("{1} {0} user account is retrieved.", user.LastName, user.FirstName);
SetStateRequest request = new SetStateRequest() {
EntityMoniker = user.ToEntityReference(),
// Sets the user to disabled.
State = new OptionSetValue(1),
// Required by request but always valued at -1 in this context.
Status = new OptionSetValue(-1)
/*
//Sets the user to enabled.
State = new OptionSetValue(0),
// Required by request but always valued at -1 in this context.
Status = new OptionSetValue(-1)
*/
};
_serviceProxy.Execute(request);
Console.WriteLine("User account is disabled.");
}
DeleteRequiredRecords(promptforDelete);
}
Volledige voorbeeldcode
using System;
using System.ServiceModel;
using System.ServiceModel.Description;
// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
// located in the SDK\bin folder of the SDK download.
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using Microsoft.Xrm.Sdk.Client;
using Microsoft.Crm.Sdk.Messages;
namespace Microsoft.Crm.Sdk.Samples
{
/// <summary>
/// Demonstrates how to do disable/enable a system user account.
/// </summary>
/// <remarks>
/// At run-time, you will be given the option to revert the role
/// association created by this program.</remarks>
public class DisableOrEnableUser
{
#region Class Level Members
// Define the IDs needed for this sample.
private Guid _userId;
private OrganizationServiceProxy _serviceProxy;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// This method first connects to the Organization service. Afterwards, it
/// creates/retrieves a system user, and
/// updates the system user to disable/enable the user account.
/// Note: Creating a user is only supported
/// in an on-premises/active directory environment.
/// </summary>
/// <param name="serverConfig">Contains server connection information.</param>
/// <param name="promptforDelete">When True, the user will be prompted to delete all
/// created entities.</param>
public void Run(ServerConnection.Configuration serverConfig, bool promptforDelete)
{
try
{
// Connect to the Organization service.
// The using statement assures that the service proxy is properly disposed.
using (_serviceProxy = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri,serverConfig.Credentials, serverConfig.DeviceCredentials))
{
_serviceProxy.EnableProxyTypes();
CreateRequiredRecords();
// Retrieve a user.
SystemUser user = _serviceProxy.Retrieve(SystemUser.EntityLogicalName,
_userId, new ColumnSet(new String [] {"systemuserid", "firstname", "lastname"})).ToEntity<SystemUser>();
if (user != null)
{
Console.WriteLine("{1} {0} user account is retrieved.", user.LastName, user.FirstName);
SetStateRequest request = new SetStateRequest() {
EntityMoniker = user.ToEntityReference(),
// Sets the user to disabled.
State = new OptionSetValue(1),
// Required by request but always valued at -1 in this context.
Status = new OptionSetValue(-1)
/*
//Sets the user to enabled.
State = new OptionSetValue(0),
// Required by request but always valued at -1 in this context.
Status = new OptionSetValue(-1)
*/
};
_serviceProxy.Execute(request);
Console.WriteLine("User account is disabled.");
}
DeleteRequiredRecords(promptforDelete);
}
}
// Catch any service fault exceptions that Microsoft Dynamics CRM throws.
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)
{
// You can handle an exception here or pass it back to the calling method.
throw;
}
}
/// <summary>
/// Creates any entity records that this sample requires.
/// </summary>
public void CreateRequiredRecords()
{
// For this sample, all required entities are created in the Run() method.
// Retrieve a user.
_userId = SystemUserProvider.RetrieveAUserWithoutAnyRoleAssigned(_serviceProxy);
}
/// <summary>
/// Deletes/reverts any entity records that were created for this sample.
/// <param name="prompt">Indicates whether to prompt the user
/// to delete/revert the records created in this sample.</param>
/// </summary>
public void DeleteRequiredRecords(bool prompt)
{
bool deleteRecords = true;
if (prompt)
{
Console.Write("\nDo you want these entity records deleted/reverted? (y/n) [y]: ");
String answer = Console.ReadLine();
deleteRecords = (answer.StartsWith("y") || answer.StartsWith("Y") || answer == String.Empty);
}
if (deleteRecords)
{
SetStateRequest request = new SetStateRequest()
{
EntityMoniker = new EntityReference(SystemUser.EntityLogicalName,
_userId),
//sets the user to enabled
State = new OptionSetValue(0),
// required by request but always valued at -1 in this context
Status = new OptionSetValue(-1)
};
_serviceProxy.Execute(request);
Console.WriteLine("User account is enabled back again.");
}
}
#endregion How To Sample Code
#region Main method
/// <summary>
/// Standard Main() method used by most SDK samples.
/// </summary>
/// <param name="args"></param>
static public void Main(string[] args)
{
try
{
// Obtain the target organization's web address and client logon
// credentials from the user.
ServerConnection serverConnect = new ServerConnection();
ServerConnection.Configuration config = serverConnect.GetServerConfiguration();
DisableOrEnableUser app = new DisableOrEnableUser();
app.Run( config, true );
}
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp);
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode);
Console.WriteLine("Message: {0}", ex.Detail.Message);
Console.WriteLine("Trace: {0}", ex.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == ex.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
catch (System.TimeoutException ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Message: {0}", ex.Message);
Console.WriteLine("Stack Trace: {0}", ex.StackTrace);
Console.WriteLine("Inner Fault: {0}",
null == ex.InnerException.Message ? "No Inner Fault" : ex.InnerException.Message);
}
catch (System.Exception ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine(ex.Message);
// Display the details of the inner exception.
if (ex.InnerException != null)
{
Console.WriteLine(ex.InnerException.Message);
FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> fe = ex.InnerException
as FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>;
if (fe != null)
{
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp);
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode);
Console.WriteLine("Message: {0}", fe.Detail.Message);
Console.WriteLine("Trace: {0}", fe.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == fe.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
}
}
// Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
// SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
finally
{
Console.WriteLine("Press <Enter> to exit.");
Console.ReadLine();
}
}
#endregion Main method
}
}
Zie ook
SetStateRequest
Gebruiker- en teamentiteiten
Helpercode: klasse ServerConnection
Gesynchroniseerde gebruikers in Microsoft Dynamics CRM Online en Office 365
© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht