Skip to content

Commit 1182335

Browse files
authored
Merge branch 'live' into patch-1
2 parents bee15a0 + 76e0717 commit 1182335

36 files changed

+420
-105
lines changed

powerapps-docs/developer/common-data-service/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,8 @@
395395
href: authenticate-dot-net-framework.md
396396
- name: Use OAuth
397397
href: authenticate-oauth.md
398+
- name: Office365 authentication with WS-Trust
399+
href: authenticate-office365-deprecation.md
398400
- name: "Tutorial: Register an app with Azure Active Directory"
399401
href: walkthrough-register-app-azure-active-directory.md
400402
- name: Build web applications using Server-to-Server (S2S) authentication
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: "Use of Office365 authentication with the WS-Trust security protocol (Common Data Service) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
3+
description: "Describes deprecation of the WS-Trust security protocol and the authentication code changes required in applications."
4+
ms.custom: ""
5+
ms.date: 02/05/2020
6+
ms.reviewer: ""
7+
ms.service: powerapps
8+
ms.topic: "article"
9+
author: "phecke" # GitHub ID
10+
ms.author: "pehecke" # MSFT alias of Microsoft employees only
11+
manager: "kvivek" # MSFT alias of manager or PM counterpart
12+
search.audienceType:
13+
- developer
14+
search.app:
15+
- PowerApps
16+
- D365CE
17+
---
18+
19+
# Use of Office365 authentication with the WS-Trust security protocol
20+
21+
Use of the WS-Trust authentication security protocol when connecting to Common
22+
Data Service is no longer recommended and has been
23+
deprecated; see the [announcement](/power-platform/important-changes-coming#deprecation-of-office365-authentication-type-and-organizationserviceproxy-class-for-connecting-to-common-data-service).
24+
25+
This change
26+
impacts custom client applications that use “Office365” authentication and the
27+
[Microsoft.Xrm.Sdk.Client.OrganizationServiceProxy](/dotnet/api/microsoft.xrm.sdk.client.organizationserviceproxy)
28+
or
29+
[Microsoft.Xrm.Tooling.Connector.CrmServiceClient](/dotnet/api/microsoft.xrm.tooling.connector.crmserviceclient)
30+
classes. If your applications use this type of authentication protocol and API,
31+
continue reading below to learn more about the recommended authentication
32+
changes to be made to your application’s code.
33+
34+
## How do I know if my code or application is using WS-Trust?
35+
36+
First and most importantly, this change **only** impacts client applications that
37+
connect to the Common Data Service. It does not impact custom plug-ins,
38+
workflow activities, or on-premises/IFD service connections.
39+
40+
- If your code employs user account and password credentials for authentication with Common Data Service or an application, you are likely using the WS-Trust security protocol. Some examples are shown below, though this list is not fully inclusive.
41+
42+
- When using the [CrmServiceClient](/dotnet/api/microsoft.xrm.tooling.connector.crmserviceclient) class with a connection string:
43+
44+
`connectionString="AuthType=Office365; Username=jsmith\@contoso.onmicrosoft.com;Password=passcode;Url=https://contoso.crm.dynamics.com"`
45+
46+
- When using [OrganizationServiceProxy](/dotnet/api/microsoft.xrm.sdk.client.organizationserviceproxy) class constructors:
47+
48+
49+
```csharp
50+
using (OrganizationServiceProxy organizationServiceProxy =
51+
new OrganizationServiceProxy(serviceManagement, clientCredentials)
52+
{ ... }
53+
```
54+
55+
- If you are using the `OrganizationServiceProxy` class at all in your code, you are using WS-Trust.
56+
57+
- If you are using [CrmServiceClient](/dotnet/api/microsoft.xrm.tooling.connector.crmserviceclient).`OrganizationServiceProxy` in your code, you are using WS-Trust.
58+
59+
## What should I do to fix my application code if affected?
60+
61+
There are very straight forward ways to modify your applications code to use
62+
the recommended connection interface for authentication with Common Data
63+
Service.
64+
65+
- If your code uses an [Microsoft.Xrm.Sdk.Client.OrganizationServiceProxy](/dotnet/api/microsoft.xrm.sdk.client.organizationserviceproxy) instance:
66+
67+
If you are passing the `OrganizationServiceProxy` instance around to various methods, or returning the instance from a function, replace all occurrences of the type `OrganizationServiceProxy` with the [IOrganizationService](/dotnet/api/microsoft.xrm.sdk.iorganizationservice?view=dynamics-general-ce-9) interface. This interface exposes all the core methods used to communicate with Common Data Service.
68+
69+
When invoking the constructor, it is recommend you add the NuGet package [Microsoft.CrmSdk.XrmTooling.CoreAssembly](https://www.nuget.org/packages/Microsoft.CrmSdk.XrmTooling.CoreAssembly/) to your project and replace all use of `OrganizationServiceProxy` class constructors with [CrmServiceClient](/dotnet/api/microsoft.xrm.tooling.connector.crmserviceclient) class constructors. You will need to alter your coding pattern here, however, for simplicity `CrmServiceClient` supports connection strings in addition to complex constructors and the ability to provide external authentication handlers. `CrmServiceClient` implements `IOrganizationService`, therefore your new authentication code will be portable to the rest of your application code. You can find examples on the use of `CrmServiceClient` in the [PowerApps-Samples](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/orgsvc/C%23) repository.
70+
71+
- If your code is using [CrmServiceClient](/dotnet/api/microsoft.xrm.tooling.connector.crmserviceclient) with theOffice365authentication
72+
type:
73+
74+
An example of this is a connections string that looks like this:
75+
76+
`connectionString = "AuthType=Office365;Username=jsmith@contoso.onmicrosoft.com;Password=passcode;Url=https://contoso.crm.dynamics.com"`
77+
78+
Similarly, you could also use a `CrmServiceClient` constructor and pass in `AuthType.Office365`.
79+
80+
You have two options for dealing with this.<p/>
81+
82+
- Switch over to using an OAuth based connection string. Such connection string looks like this:
83+
84+
`connectionString = "AuthType=OAuth;Username=jsmith@contoso.onmicrosoft.com;
85+
Password=passcode;Url=https://contosotest.crm.dynamics.com;AppId=51f81489-12ee-4a9e-aaae-a2591f45987d;
86+
RedirectUri=app://58145B91-0C36-4500-8554-080854F2AC97;LoginPrompt=Auto"`
87+
88+
This will be your fastest way to update the code. Note that LoginPrompt can be set toneverto simulate the way that the Office 365 behavior worked.
89+
90+
The AppId and RedirectUri provided above are examples of working application registration values. These values work everywhere our online services are deployed. However, they are provided here as examples and you are encouraged to create your own application registration in Azure Active Directory (AAD) for applications running in your tenant.<p/>
91+
92+
- When we announce it, update to the latest [Microsoft.CrmSdk.XrmTooling.CoreAssembly](https://www.nuget.org/packages/Microsoft.CrmSdk.XrmTooling.CoreAssembly/) NuGet package that includes auto redirect support. This library will redirect an authentication type of Office365 to OAuth and use the example AppId and Redirect URI automatically. This capability is planned for the 9.2.x version of the Microsoft.CrmSdk.XrmTooling.CoreAssembly package.
93+
94+
- If you are accessing the [CrmServiceClient](/dotnet/api/microsoft.xrm.tooling.connector.crmserviceclient).`OrganizationServiceProxy` property:
95+
96+
Remove all use of that property in your code. `CrmServiceClient` implements `IOrganizationService` and exposes everything that is settable for the organization service proxy.
97+
98+
> [!IMPORTANT]
99+
> Regarding not being able to login using User ID/Password even if using OAuth: if your tenant and user is configured in Azure Active Directory for conditional access and/or Multi-Factor Authentication is required, you will not be able to use user ID/password flows in a non-interactive form at all. For those situations, you must use a Service Principal user to authenticate with Common Data Service.<p/>
100+
To do this, you must first register the application user (Service Principal) in Azure Active Directory. You can find out how to do this [here](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal). During application registration you will need to create that user in Common Data Service and grant permissions. Those permissions can either be granted directly or indirectly by adding the application user to a team which has been granted permissions in Common Data Service. You can find more information on how to set up an application user to authenticate with Common Data Service [here](/powerapps/developer/common-data-service/use-single-tenant-server-server-authentication).
101+
102+
## Need help?
103+
104+
We will be monitoring the Power Apps ALM and ProDev community [forums](https://powerusers.microsoft.com/t5/Power-Apps-Component-Framework/bd-p/pa_component_framework). Please take a look there to get help on how to solve various issues or post a
105+
question.

powerapps-docs/developer/common-data-service/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Office 365 authentication requires using the .NET Framework SDK assemblies with
4545

4646
Using Office 365 authentication does not require that your register your applications as OAuth does. You must simply provide a User Principal Name (UPN) and password for a valid user.
4747

48-
More information: [Authentication with .NET Framework applications](authenticate-dot-net-framework.md)
48+
More information: [Authentication with .NET Framework applications](authenticate-dot-net-framework.md), [Use of Office365 authentication with the WS-Trust security protocol](authenticate-office365-deprecation.md)
4949

5050
## All other software frameworks
5151

powerapps-docs/developer/common-data-service/configure-entity-relationship-cascading-behavior.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,12 @@ The `CascadeConfiguration` (<xref:Microsoft.Xrm.Sdk.Metadata.CascadeConfiguratio
5757
|Reparent|See [About the reparent action](#about-the-reparent-action) later.|Active<br />Cascade<br />NoCascade<br />UserOwned|
5858
|Share|When the referenced entity record is shared with another user.|Active<br />Cascade<br />NoCascade<br />UserOwned|
5959
|Unshare|When sharing is removed for the referenced entity record.|Active<br />Cascade<br />NoCascade<br />UserOwned|
60-
60+
61+
> [!NOTE]
62+
> When executing an assign, any workflows or business rules that are currently active on the records will automatically be
63+
> deactivated when the reassignment occurs. The new owner of the record will need to reactivate the workflow or business rule
64+
> if they want to continue using it.
65+
6166
<a name="BKMK_ReparentAction"></a>
6267
### About the reparent action
6368
The reparent action is very similar to the share action except that it deals with the inherited read access rights instead of explicit read access rights. The reparent action is when you change the value of the referencing attribute in a parental relationship. When a reparent action occurs, the desired scope of the inherited read access rights for related entities might change. The cascade actions related to the reparent action refer to changes to read access rights for the entity record and any entity records related to it.

powerapps-docs/developer/common-data-service/powerapps-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ This table lists some common commands used in the CLI:
4949
|Command|Description|Examples|
5050
|------|-----------|--------|
5151
|**pcf**|Commands for working with [Power Apps component framework](/powerapps/developer/component-framework/overview). It has the following parameters: <br/> - **init**: Initializes the code component project. It has the following parameters <br/> - *namespace*: Namespace of the code component. <br/> - *name*: Name of the code component. <br/> - *template*: Field or dataset <br/> - **push**: Pushes the code component to the Common Data Service instance with all the latest changes. It has the following parameter: <br/> - *publisher-prefix*: Publisher prefix of the organization.| `pac pcf init --namespace <specify your namespace here> --name <Name of the code component> --template <component type>` <br/> <br/> `pac pcf push --publisher-prefix <your publisher prefix>`|
52-
|**solution**|Commands for working with Common Data Service solution projects. It has the following parameters: <br/> - **init**: Initializes the solution project. It has the following parameters:<br/> - *publisher-name*: Publisher name of the organization. <br/> - *publisher-prefix*: Publisher prefix of the organization. <br/> - **add-reference**: Sets the reference path to the component project folder by passing the `path` parameter.<br/> - **clone**: Creates a solution project based up on the existing solution project by passing the following parameters `name`, `version`, and `include`|`pac solution init --publisher-name <enter your publisher name> --publisher-prefix <enter your publisher prefix>` <br/><br/> `pac solution add-reference --path <path to your Power Apps component framework project>`<br/><br/> `pac solution clone –name<name of the solution to be exported> --version <version of your solution> --include <settings that should be included>`|
53-
|**auth**|Commands to authenticate to Common Data Service. It has the following parameters: <br/> - **create**: Creates the authentication profile for your organization by passing the `url` parameter. You need to pass the organization url for the `url` parameter. <br/> - **list**: Provides the list of authentication profiles. <br/> - **select**: Provides a way to switch between previously created authentication profiles by passing the `index` parameter.<br/>**delete**: Deletes the authentication profile created by passing the `index` parameter.|`pac auth create --url <your Common Data Service org’s url>` <br/> <br/> `pac auth list` <br/><br/> `Pac auth select --index <index of the active profile>`|
52+
|**solution**|Commands for working with [Common Data Service solution projects](/powerapps/maker/common-data-service/solutions-overview). It has the following parameters: <br/> - **init**: Initializes the solution project. It has the following parameters:<br/> - *publisher-name*: Publisher name of the organization. <br/> - *publisher-prefix*: Publisher prefix of the organization. <br/> - **add-reference**: Sets the reference path to the component project folder by passing the `path` parameter.<br/> - **clone**: Creates a solution project based up on the existing solution project by passing the following parameters `name`, `version`, and `include`|`pac solution init --publisher-name <enter your publisher name> --publisher-prefix <enter your publisher prefix>` <br/><br/> `pac solution add-reference --path <path to your Power Apps component framework project>`<br/><br/> `pac solution clone –name<name of the solution to be exported> --version <version of your solution> --include <settings that should be included>`|
53+
|**auth**|Commands to [authenticate to Common Data Service](/powerapps/developer/component-framework/import-custom-controls#connecting-to-your-environment). It has the following parameters: <br/> - **create**: Creates the authentication profile for your organization by passing the `url` parameter. You need to pass the organization url for the `url` parameter. <br/> - **list**: Provides the list of authentication profiles. <br/> - **select**: Provides a way to switch between previously created authentication profiles by passing the `index` parameter.<br/>**delete**: Deletes the authentication profile created by passing the `index` parameter.|`pac auth create --url <your Common Data Service org’s url>` <br/> <br/> `pac auth list` <br/><br/> `Pac auth select --index <index of the active profile>`|
5454
|**telemetry**|Manages the telemetry settings. It has the following parameters: <br/>- *enable*: Enables the telemetry option.<br/> - *disable*: Disables the telemetry option.<br/> - *status*: Returns whether the telemetry is enabled or disabled.|`pac telemetry enable` <br/><br/> `pac telemetry disable`|
5555
|**org**|Command to work with Common Data Service.|`pac org who`|
5656
|**plugin**|Manages to create a [plug-in](/powerapps/developer/common-data-service/plug-ins) project|`pac plugin init`|

powerapps-docs/developer/common-data-service/query-hierarchical-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ You can take advantage of new query condition operators to query entities with e
3232
|`under`|`Under`|Returns all child records below the referenced record in the hierarchy|
3333
|`eq-or-under`|`UnderOrEqual`|Returns the referenced record and all child records below it in the hierarchy|
3434
|`not-under`|`NotUnder`|Returns all records not below the referenced record in the hierarchy|
35-
|`eq-owneduseroruserhierarchy`|`OwnedByMeOrMyReports`|When hierarchical security models are used, Equals current user or his reporting hierarchy|
36-
|`eq-useroruserhierarchyandteams`|`OwnedByMeOrMyReportsAndTeams`|When hierarchical security models are used, Equals current user and his or her teams, or his or her reporting hierarchy and their teams|
35+
|`eq-owneduseroruserhierarchy`|`OwnedByMeOrMyReports`|When hierarchical security models are used, Equals current user or user's reporting hierarchy|
36+
|`eq-useroruserhierarchyandteams`|`OwnedByMeOrMyReportsAndTeams`|When hierarchical security models are used, Equals current user and user's teams, or user's reporting hierarchy and their teams|
3737

3838
### Recursion limits when querying hierarchical data
3939
Because querying hierarchical data can be resource intensive, there is a default limit of 100 recursions allowed conditions for hierarchical queries using the `Above`, `AboveOrEqual`, `Under`, `UnderOrEqual`, and `NotUnder` condition operators.

powerapps-docs/developer/common-data-service/webapi/web-api-types-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ An ordinary intersect entity has only the four basic properties required to main
338338

339339
*Complex types* are keyless named structured types consisting of a set of properties. Complex types are commonly used as property values in model entities, or as parameters or return values for operations.
340340

341-
<xref:Microsoft.Dynamics.CRM.ComplexTypeIndex> lists all the system complex types. *Complex types* are keyless named structured types consisting of a set of properties. They’re commonly used as property values in model entities, or as parameters or return values for operations. The following is the <xref href="Microsoft.Dynamics.CRM.WhoAmIResponse?text=WhoAmIResponse ComplexType" /> from the $metadata.
341+
<xref:Microsoft.Dynamics.CRM.ComplexTypeIndex> lists all the system complex types. The following is the <xref href="Microsoft.Dynamics.CRM.WhoAmIResponse?text=WhoAmIResponse ComplexType" /> from the $metadata.
342342

343343
```xml
344344
<ComplexType Name="WhoAmIResponse">

0 commit comments

Comments
 (0)