GetDecryptionKeyRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

For internal use only. See RetrieveDataEncryptionKeyRequest.

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

Inheritance Hierarchy

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

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type GetDecryptionKeyRequest = 
    class
        inherit OrganizationRequest
    end

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

Constructors

	Name	Description
	GetDecryptionKeyRequest()	Initializes a new instance of the GetDecryptionKeyRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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 message privileges.

Notes for Callers

The caller must be a member of the Active Directory PrivUserGroup 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.

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.

Share via