GetDecryptionKeyRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

For internal use only. See RetrieveDataEncryptionKeyRequest.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class GetDecryptionKeyRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class GetDecryptionKeyRequest : OrganizationRequest

Remarks

Contains the data that is needed to obtain the key that is used to encrypt or decrypt a user's or queue's email credentials that are stored in the Microsoft Dynamics CRM database. This message was incorrectly marked as public in previous Microsoft Dynamics CRM SDK releases.

Message Availability

For this message to work, the caller must be connected to the server. This message is supported only for on-premises and Internet-facing deployments (IFDs).

Usage

Pass an instance of this class to the Execute method, which returns an instance of the GetDecryptionKeyResponse class.

Privileges and Access Rights

For a complete list of the required privileges, see GetDecryptionKey Privileges.

Notes for Callers

The caller must be a member of the Active DirectoryPrivUserGroup security group in on-premises installations or must be the root business-unit administrator in Services Provider License Agreement (SPLA) or Internet-facing deployments (IFDs). By default, this message enforces Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS). If you choose to enable HTTP for this communication, it is recommended that you enforce Internet Protocol security (IPsec) on the Microsoft Dynamics CRM server and on the email router.

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.GetDecryptionKeyRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),