RetrievePrincipalAccessRequest Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains the data that is needed to retrieve the access rights of the specified security principal (user, team, or organization) to the specified record.
public ref class RetrievePrincipalAccessRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrievePrincipalAccessRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrievePrincipalAccessRequest = class
inherit OrganizationRequest
Public NotInheritable Class RetrievePrincipalAccessRequest
Inherits OrganizationRequest
- Inheritance
- Attributes
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 instance. For the complete sample, see the link later in this topic.
Remarks
For the Web API use the RetrievePrincipalAccess function.
Usage
Pass an instance of this class to the Execute(OrganizationRequest) 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 Tables
See Message support for tables for an example query you can use to get the list of tables you can use with the RetrievePrincipalAccess
message.
Constructors
RetrievePrincipalAccessRequest() |
Initializes a new instance of the RetrievePrincipalAccessRequest class. |
Properties
ExtensionData |
Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest) |
Item[String] |
Gets or sets the indexer for the |
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 (user, team, or organization) for which to return the access rights to the specified record. |
RequestId |
Gets or sets the ID of the request. 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. |