Use Connection strings in XRM tooling to connect to CRM

With Microsoft Dynamics CRM Online 2016 Update and Microsoft Dynamics CRM 2016 (on-premises), XRM tooling enables to connect to CRM instance by using connection strings. This is similar to the concept of connection strings used with Microsoft SQL Server. Connection strings have native support in configuration files, including the ability to encrypt the configuration sections for maximum security. This enables to configure CRM connections at deployment time, and not hard code in the application to connect to CRM instance.

Create a connection string

Specify the connection string in the app.config or web.config file for VS project, as shown in the following example.


<add name=”CRMServer” connectionString=”AuthType=AD;Url=http://amartestsrv:8080/Test;” /></connectionStrings>

After creating the connection string, use it to create a CrmServiceClient object.


//Use the connection string named “CRMServer” from the configuration fileCrmServiceClient crmSvc = new CrmServiceClient(ConfigurationManager.ConnectionStrings[“MyCRMServer”].ConnectionString);

After creating a CrmServiceClient object, we can use the object to perform actions in CRM.
Connection string parameters
The connection string contains a series of name=value pair separated by semi-colons. The following table lists supported parameters, which can be entered in any order.

Parameter Name Description
ServiceUri, Service Uri, Url, or Server Specifies the URL to the Microsoft Dynamics CRM Server. The URL can use http or https protocol, and the port is optional. The default port is 80 for the http protocol and 443 for the https protocol. The server URL is typically in the format of http://crm-server:port/organization-name for CRM on-premises and https://organization-name. for CRM Online.

The organization name is required. You can specify either the friendly or the unique name of the organization to connect to.

Example: http://amartestsrv/test, http://amartestsrv:5555/test, https://amartestsrv/test,

Domain Specifies the domain that will verify user credentials.
UserName, User Name, UserId, or User Id Specifies the user’s identification name associated with the credentials.
Password Specifies the password for the user name associated with the credentials.
HomeRealmUri or Home Realm Uri Specifies the Home Realm Uri.
AuthenticationType or AuthType Specifies the authentication type to connect to CRM instance. Valid values are: AD, IFD (AD FS enabled), OAuth, or Office365.

  • AD and IFD are permitted for CRM on-premises instances only.
  • OAuth is permitted for CRM Online and on-premises instances.

Office365 is permitted for CRM Online instances only.

RequireNewInstance Specifies whether to force the creation of a new instance when the connection is created. Possible values are True or False.
ClientId, AppId or ApplicationId Specifies the ClientID assigned when you registered your application in Microsoft Azure Active Directory or Active Directory Federation Services (AD FS).

This parameter is applicable only when the authentication type is specified as OAuth.

RedirectUri or ReplyUrl Specifies the redirect URI of the application you registered in Microsoft Azure Active Directory or Active Directory Federation Services (AD FS).

This parameter is applicable only when the authentication type is specified as OAuth.

TokenCacheStorePath Specifies the full path to the location where the user token cache should be stored. The running process should have access to the specified path. It is the processes responsibility to set and configure this path.

This parameter is applicable only when the authentication type is specified as OAuth.

LoginPrompt Specifies whether the user is prompted for credentials if the credentials are not supplied. Valid values are:

  • Always: Always prompts the user to specify credentials.
  • Auto: Allows the user to select in the login control interface whether to display the prompt or not.
  • Never: Does not prompt the user to specify credentials. If using a connection method does not have a user interface, you should use this value.

This parameter is applicable only when the authentication type is specified as OAuth.

Connection string examples
The following examples show how we can use connection strings for connecting to different deployments and authentication scenarios.

Integrated on-premises authentication
<add name=”CRMServer” connectionString=”AuthType=AD;Url=http://amartestsrv:8080/Test;” />

Named account using on-premises authentication
<add name=”CRMServer” connectionString=”AuthType=AD;Url=http://amartestsrv:8080/Test; Domain=crmhunt; Username=admin; Password=pass#123$” />

Named account using Office 365
<add name=”CRMServer” connectionString=”AuthType=Office365; Username=; Password=pass#123$;Url=”/>

OAuth using named account in Office 365 with UX to prompt for authentication
<add name=”CRMServer” connectionString=”AuthType=OAuth; Username=; Password=pass#123$; Url=; AppId=<GUID>;RedirectUri =app://<GUID>;TokenCacheStorePath =c:\MyTokenCache; LoginPrompt=Auto”/>

OAuth using named account in CRM on-premises with UX to prompt for authentication
<add name=”CRMServer” connectionString=”AuthType=OAuth;Username=; Password=pass#123$;Url=https://amartestsrv:8080/Test; AppId=<GUID>; RedirectUri=app://<GUID>;TokenCacheStorePath =c:\MyTokenCache; LoginPrompt=Auto”/>

IFD using a named account with delegation to a sub realm
<add name=”CRMServer” connectionString=”AuthType=IFD;Url=http://amartestsrv:8080/Test; HomeRealmUri=;Domain=crmhunt; Username=admin; Password=pass#123$” />

Determine your connection status
To determine if the connection request was successful, check the value of the CrmServiceClient.IsReady property. If true, the connection is successful, and you are ready to work. Otherwise, check the values of the CrmServiceClient.LastCrmError and CrmServiceClient.LastCrmException properties for the cause of the connection failure.

If you enjoyed this post, please consider leaving a comment or subscribing to the RSS feed to have future articles delivered to your feed reader.
This entry was posted in MS CRM 2016 and tagged , , . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *