RetrievePrincipalAccessRequest Class

Artikel
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to retrieve the access rights of the specified security principal (team or user) to the specified record.

For the Web API use the RetrievePrincipalAccess Function.

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.RetrievePrincipalAccessRequest

Syntax

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

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

Constructors

	Name	Description
	RetrievePrincipalAccessRequest()	Initializes a new instance of the RetrievePrincipalAccessRequest 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.)
	Principal	Gets or sets the security principal (team or user) for which to return the access rights to the specified record.
	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.)
	Target	Gets or sets the target record for which to retrieve access rights.

Methods

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

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see Supported Entities later in this topic.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the entity that is specified by the Target property and access rights on the specified record in the Target property. For a complete list of the required privileges, see RetrievePrincipalAccess message privileges.

Supported Entities

The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.

Entity	Availability
Account	2 (Both)
Annotation	2 (Both)
Appointment	2 (Both)
AsyncOperation	2 (Both)
BulkOperation	2 (Both)
Campaign	2 (Both)
CampaignActivity	2 (Both)
CampaignResponse	2 (Both)
Connection	2 (Both)
Contact	2 (Both)
Contract	2 (Both)
ConvertRule	2 (Both)
CustomerOpportunityRole	2 (Both)
CustomerRelationship	2 (Both)
DuplicateRule	2 (Both)
Email	2 (Both)
EmailServerProfile	2 (Both)
Entitlement	2 (Both)
Fax	2 (Both)
Goal	2 (Both)
GoalRollupQuery	2 (Both)
Import	2 (Both)
ImportFile	2 (Both)
ImportMap	2 (Both)
Incident	2 (Both)
IncidentResolution	2 (Both)
Invoice	2 (Both)
Lead	2 (Both)
Letter	2 (Both)
List	2 (Both)
Mailbox	2 (Both)
MailMergeTemplate	2 (Both)
msdyn_PostAlbum	2 (Both)
msdyn_wallsavedqueryusersettings	2 (Both)
Opportunity	2 (Both)
OpportunityClose	2 (Both)
OrderClose	2 (Both)
PhoneCall	2 (Both)
ProcessSession	2 (Both)
Queue	2 (Both)
Quote	2 (Both)
QuoteClose	2 (Both)
RecurringAppointmentMaster	2 (Both)
Report	2 (Both)
RoutingRule	2 (Both)
SalesOrder	2 (Both)
ServiceAppointment	2 (Both)
SharePointDocumentLocation	2 (Both)
SharePointSite	2 (Both)
SLA	2 (Both)
SLAKPIInstance	2 (Both)
SocialActivity	2 (Both)
SocialProfile	2 (Both)
Task	2 (Both)
Template	2 (Both)
UserForm	2 (Both)
UserQuery	2 (Both)
UserQueryVisualization	2 (Both)
Workflow	2 (Both)

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


var principalAccessReq = new RetrievePrincipalAccessRequest
{
    Principal = principal,
    Target = leadReference
};
var principalAccessRes = (RetrievePrincipalAccessResponse)
    _serviceProxy.Execute(principalAccessReq);
Console.WriteLine("Access rights of {0} ({1}) on the lead: {2}\r\n",
    GetEntityReferenceString(principal),
    additionalIdentifier,
    principalAccessRes.AccessRights);


Dim principalAccessReq = New RetrievePrincipalAccessRequest With
                         {
                             .Principal = principal,
                             .Target = leadReference
                         }
Dim principalAccessRes = CType(_serviceProxy.Execute(principalAccessReq), 
    RetrievePrincipalAccessResponse)
Console.WriteLine("Access rights of {0} ({1}) on the lead: {2}" &amp; vbCrLf,
                  GetEntityReferenceString(principal),
                  additionalIdentifier,
                  principalAccessRes.AccessRights)

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.

Dela via