Coveo, Microsoft Dynamics 365, and Security
In December 2020, the Coveo for Microsoft Dynamics 365 integration will reach its end-of-life and will no longer be supported by Coveo. See Coveo for Microsoft Dynamics 365 End-of-Life for details.
Coveo Cloud uses a permission model capable of replicating any flexible security model to make sure that your data is at least as secure in your Coveo index as it’s in Microsoft Dynamics 365 (see Coveo Cloud Management of Security Identities and Item Permissions). Whether they’re browsing content directly in Microsoft Dynamics 365 or searching it with Coveo, your users have access to the same items, as items not matching a user’s permissions aren’t included in their search results. Therefore, they can’t use Coveo to access sensitive information that they’re not supposed to see, such as coworkers’ expense accounts or confidential information handled by other teams.
Item Permission Model
Shared: groups or users with whom the item is shared.
Roles: groups or users who typically have access to the items due to their role.
Each of these levels includes two permission sets of allowed groups or users:
[Level] Set: groups or users who have access to the item.
Entity Type Set: groups or users who typically have access to this entity type.
In Microsoft Dynamics 365, the concept of denied user, i.e., a user that’s explicitly forbidden to access an item, doesn’t exist. Users are either allowed to access an item or unknown to the item permission model.
To resolve the permission model of an item and determine whether it can appear in the search results for a specific user, Coveo Cloud analyzes the item permissions as follows:
For each permission level, Coveo Cloud goes through each permission set:
If the user is allowed to access the item in all sets, the user can see the item. Other permission levels are ignored.
If the user is unknown in some or all sets, the next permission level is checked.
If the user is unknown in all permission levels, the user can’t see the item.
In order for Coveo to recognize users from Microsoft Dynamics 365, each group and user must be associated to a security identity represented by their primary email, which is then used to determine whether a user can access an item. These identities are stored in the Coveo security identity cache. At query time, the item permissions are compared to the identity in the cache to determine whether the user is allowed to access the item (see Security Identities).
Once a day, Coveo Cloud refers to the Microsoft Dynamics 365 security provider to update the association of groups and users to their emails. Therefore, any change made to the security groups or users in Dynamics 365 will be effective in Coveo for Microsoft Dynamics 365 at most 24 hours later. If you want your changes to be effective immediately, you can manually launch a security identity refresh (see Refresh Tab).
They API key is a basic authentication method used to secure interactions between Coveo for Microsoft Dynamics 365 and the Coveo Search API (see API Key Authentication). The key is included in each query and it identifies the API calls as legitimate.
The API key appears in the
CoveoConfiguration Microsoft Dynamics 365 entity, so it’s available for Coveo for Microsoft Dynamics 365 to use. However, for your Dynamics 365 content to remain secured, this key shouldn’t be shared with anyone, and the permission to read the
CoveoConfiguration entity should only be given to administrators.