Sample: Create an On-Premises User
Dynamics CRM 2011
[Applies to: Microsoft Dynamics CRM 2011]
This sample code is for Microsoft Dynamics CRM 2011, and can be found in the following location in the SDK download:
SampleCode\CS\BusinessDataModel\UsersAndRoles\CreateAUser.cs
SampleCode\VB\BusinessDataModel\UsersAndRoles\CreateAUser.vb
Requirements
For more information about the requirements for running the sample code provided in this SDK, see Use the Sample and Helper Code.
Demonstrates
This sample shows how to create a user in an Active Directory environment using the IOrganizationService.Create method. A snippet showing just the key sections of the sample is shown first, followed by the Complete Sample Code.
Example
// Connect to the Organization service. // The using statement assures that the service proxy is properly disposed. using (_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig)) { _serviceProxy.EnableProxyTypes(); CreateRequiredRecords(); // Retrieve the default business unit needed to create the user. QueryExpression businessUnitQuery = new QueryExpression { EntityName = BusinessUnit.EntityLogicalName, ColumnSet = new ColumnSet("businessunitid"), Criteria = { Conditions = { new ConditionExpression("parentbusinessunitid", ConditionOperator.Null) } } }; BusinessUnit defaultBusinessUnit = _serviceProxy.RetrieveMultiple( businessUnitQuery).Entities[0].ToEntity<BusinessUnit>(); //Create a new system user. SystemUser user = new SystemUser { DomainName = _domain + _userName, FirstName = _firstName, LastName = _lastName, BusinessUnitId = new EntityReference { LogicalName = BusinessUnit.EntityLogicalName, Name = BusinessUnit.EntityLogicalName, Id = defaultBusinessUnit.Id } }; Guid userId = _serviceProxy.Create(user); Console.WriteLine("Created a system user {0} for '{1}, {2}'", userId, _lastName, _firstName); }
Complete Sample Code
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 basic entity operations like create /// a system user account.</summary> /// <remarks> /// At run-time, you will be given the option to delete all the /// database records created by this program.</remarks> public class CreateAUser { #region Class Level Members // Define the IDs needed for this sample. private String _domain = String.Empty; private String _userName = "dparker"; private String _firstName = "Darren"; private String _lastName = "Parker"; private OrganizationServiceProxy _serviceProxy; #endregion Class Level Members #region How To Sample Code /// <summary> /// This method first connects to the Organization service. Afterwards, /// it creates a system user account with a given active directory 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 = ServerConnection.GetOrganizationProxy(serverConfig)) { _serviceProxy.EnableProxyTypes(); CreateRequiredRecords(); // Retrieve the default business unit needed to create the user. QueryExpression businessUnitQuery = new QueryExpression { EntityName = BusinessUnit.EntityLogicalName, ColumnSet = new ColumnSet("businessunitid"), Criteria = { Conditions = { new ConditionExpression("parentbusinessunitid", ConditionOperator.Null) } } }; BusinessUnit defaultBusinessUnit = _serviceProxy.RetrieveMultiple( businessUnitQuery).Entities[0].ToEntity<BusinessUnit>(); //Create a new system user. SystemUser user = new SystemUser { DomainName = _domain + _userName, FirstName = _firstName, LastName = _lastName, BusinessUnitId = new EntityReference { LogicalName = BusinessUnit.EntityLogicalName, Name = BusinessUnit.EntityLogicalName, Id = defaultBusinessUnit.Id } }; Guid userId = _serviceProxy.Create(user); Console.WriteLine("Created a system user {0} for '{1}, {2}'", userId, _lastName, _firstName); } } // 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. // Obtain the current user's information. WhoAmIRequest who = new WhoAmIRequest(); WhoAmIResponse whoResp = (WhoAmIResponse)_serviceProxy.Execute(who); Guid currentUserId = whoResp.UserId; SystemUser currentUser = _serviceProxy.Retrieve(SystemUser.EntityLogicalName, currentUserId, new ColumnSet("domainname")).ToEntity<SystemUser>(); // Extract the domain and create the LDAP object. String[] userPath = currentUser.DomainName.Split(new char[] { '\\' }); if (userPath.Length > 1) _domain = userPath[0] + "\\"; else _domain = String.Empty; SystemUser existingUser = SystemUserProvider.GetUserIdIfExist(_serviceProxy, _domain, _userName, _firstName, _lastName); if(existingUser != null) throw new Exception("User already exist!"); // Set up an Active Directory account in the current domain for this sample. String ldapPath = String.Empty; Boolean accountSetup = SystemUserProvider.CreateADAccount(_userName, _firstName, _lastName, _serviceProxy, ref ldapPath); if (accountSetup) Console.WriteLine("An AD account created for '{0}, {1}'", _lastName, _firstName); else Console.WriteLine("AD account already exist for '{0}, {1}'", _lastName, _firstName); } #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(); CreateAUser app = new CreateAUser(); 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 } }
Imports System.ServiceModel Imports System.ServiceModel.Description ' These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly ' located in the SDK\bin folder of the SDK download. Imports Microsoft.Xrm.Sdk Imports Microsoft.Xrm.Sdk.Query Imports Microsoft.Xrm.Sdk.Client Imports Microsoft.Crm.Sdk.Messages Namespace Microsoft.Crm.Sdk.Samples ''' <summary> ''' Demonstrates how to do basic entity operations like create ''' a system user account.</summary> ''' <remarks> ''' At run-time, you will be given the option to delete all the ''' database records created by this program.</remarks> Public Class CreateAUser #Region "Class Level Members" ' Define the IDs needed for this sample. Private _domain As String = String.Empty Private _userName As String = "dparker" Private _firstName As String = "Darren" Private _lastName As String = "Parker" Private _serviceProxy As OrganizationServiceProxy #End Region ' Class Level Members #Region "How To Sample Code" ''' <summary> ''' This method first connects to the Organization service. Afterwards, ''' it creates a system user account with a given active directory 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 is prompted to delete all ''' created entities.</param> Public Sub Run(ByVal serverConfig As ServerConnection.Configuration, ByVal promptforDelete As Boolean) Try ' Connect to the Organization service. ' The using statement assures that the service proxy is properly disposed. _serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig) Using _serviceProxy _serviceProxy.EnableProxyTypes() CreateRequiredRecords() ' Retrieve the default business unit needed to create the user. Dim businessUnitQuery As QueryExpression = New QueryExpression With { .EntityName = BusinessUnit.EntityLogicalName, .ColumnSet = New ColumnSet("businessunitid") } businessUnitQuery.Criteria = New FilterExpression() businessUnitQuery.Criteria.AddCondition( New ConditionExpression("parentbusinessunitid", ConditionOperator.Null)) Dim defaultBusinessUnit As BusinessUnit = _serviceProxy.RetrieveMultiple(businessUnitQuery).Entities(0).ToEntity(Of BusinessUnit)() 'Create a new system user. Dim user As SystemUser = New SystemUser With { .DomainName = _domain & _userName, .FirstName = _firstName, .LastName = _lastName, .BusinessUnitId = New EntityReference With { .LogicalName = BusinessUnit.EntityLogicalName, .Name = BusinessUnit.EntityLogicalName, .Id = defaultBusinessUnit.Id } } Dim userId As Guid = _serviceProxy.Create(user) Console.WriteLine("Created a system user {0} for '{1}, {2}'", userId, _lastName, _firstName) End Using ' Catch any service fault exceptions that Microsoft Dynamics CRM throws. Catch fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault) ' You can handle an exception here or pass it back to the calling method. Throw End Try End Sub ''' <summary> ''' Creates any entity records that this sample requires. ''' </summary> Public Sub CreateRequiredRecords() ' For this sample, all required entities are created in the Run() method. ' Obtain the current user's information. Dim who As New WhoAmIRequest() Dim whoResp As WhoAmIResponse = CType(_serviceProxy.Execute(who), WhoAmIResponse) Dim currentUserId As Guid = whoResp.UserId Dim currentUser As SystemUser = _serviceProxy.Retrieve(SystemUser.EntityLogicalName, currentUserId, New ColumnSet("domainname")).ToEntity(Of SystemUser)() ' Extract the domain and create the LDAP object. Dim userPath() As String = currentUser.DomainName.Split(New Char() { "\"c }) If userPath.Length > 1 Then _domain = userPath(0) & "\" Else _domain = String.Empty End If Dim existingUser As SystemUser = SystemUserProvider.GetUserIdIfExist(_serviceProxy, _domain, _userName, _firstName, _lastName) If existingUser IsNot Nothing Then Throw New Exception("User already exist!") End If ' Setup an Active Directory account in the current domain for this sample. Dim ldapPath As String = String.Empty Dim accountSetup As Boolean = SystemUserProvider.CreateADAccount(_userName, _firstName, _lastName, _serviceProxy, ldapPath) If accountSetup Then Console.WriteLine("An AD account created for '{0}, {1}'", _lastName, _firstName) Else Console.WriteLine("AD account already exist for '{0}, {1}'", _lastName, _firstName) End If End Sub #End Region ' How To Sample Code #Region "Main method" ''' <summary> ''' Standard Main() method used by most SDK samples. ''' </summary> ''' <param name="args"></param> Public Shared Sub Main(ByVal args() As String) Try ' Obtain the target organization's Web address and client logon ' credentials from the user. Dim serverConnect As New ServerConnection() Dim config As ServerConnection.Configuration = serverConnect.GetServerConfiguration() Dim app As New CreateAUser() app.Run(config, True) Catch ex As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault) 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}", If(Nothing Is ex.Detail.InnerFault, "No Inner Fault", "Has Inner Fault")) Catch ex As TimeoutException 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}", If(Nothing Is ex.InnerException.Message, "No Inner Fault", ex.InnerException.Message)) Catch ex As Exception Console.WriteLine("The application terminated with an error.") Console.WriteLine(ex.Message) ' Display the details of the inner exception. If ex.InnerException IsNot Nothing Then Console.WriteLine(ex.InnerException.Message) Dim fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault) = TryCast(ex.InnerException, FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)) If fe IsNot Nothing Then 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}", If(Nothing Is fe.Detail.InnerFault, "No Inner Fault", "Has Inner Fault")) End If End If ' Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException, ' SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException. Finally Console.WriteLine("Press <Enter> to exit.") Console.ReadLine() End Try End Sub #End Region ' Main method End Class End Namespace
See Also
Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.
Community Additions
ADD
Show: