RevokeAccessRequest Class
Applies To: Dynamics CRM 2015
Contains the data that is needed to replace the access rights on the target record for the specified security principal (user or team).
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.RevokeAccessRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RevokeAccessRequest : OrganizationRequest
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class RevokeAccessRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type RevokeAccessRequest =
class
inherit OrganizationRequest
end
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RevokeAccessRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RevokeAccessRequest() | Initializes a new instance of the RevokeAccessRequest 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.) |
|
Revokee | Gets or sets a security principal (team or user) whose access you want to revoke. Required. |
|
Target | Gets or sets the target record for which you want to revoke access. Required. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
Remarks
Message Availability
For this message to work, the caller must be connected to the server.
Usage
Pass an instance of this class to the Execute method, which returns an instance of the RevokeAccessResponse class.
Privileges and Access Rights
To perform this action, the caller must have privileges on the specified entity in the Target property and access rights on the specified record in the Target property. For a list of the required privileges, see RevokeAccess message privileges.
Notes for Callers
This action also applies to all child records of the target record. However for all child records, access rights are only modified if the caller has share privileges for those entity types and share access rights to the records. As a result, the owner of the target record, or a user who shares the target record, automatically has share rights to all child records of the target record.
For a description of how actions on a parent record affect child records, see Cascading behavior.
Supported Entities
The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available.
Entity |
Availability |
Account |
0 (Server) |
Annotation |
0 (Server) |
Appointment |
0 (Server) |
Campaign |
0 (Server) |
CampaignActivity |
0 (Server) |
CampaignResponse |
0 (Server) |
Connection |
0 (Server) |
Contact |
0 (Server) |
Contract |
0 (Server) |
ConvertRule |
0 (Server) |
CustomerOpportunityRole |
0 (Server) |
CustomerRelationship |
0 (Server) |
DuplicateRule |
0 (Server) |
0 (Server) |
|
EmailServerProfile |
0 (Server) |
Entitlement |
0 (Server) |
Fax |
0 (Server) |
Goal |
0 (Server) |
GoalRollupQuery |
0 (Server) |
Import |
0 (Server) |
ImportFile |
0 (Server) |
ImportMap |
0 (Server) |
Incident |
0 (Server) |
IncidentResolution |
0 (Server) |
Invoice |
0 (Server) |
Lead |
0 (Server) |
Letter |
0 (Server) |
List |
0 (Server) |
Mailbox |
0 (Server) |
MailMergeTemplate |
0 (Server) |
msdyn_PostAlbum |
0 (Server) |
msdyn_wallsavedqueryusersettings |
0 (Server) |
Opportunity |
0 (Server) |
OpportunityClose |
0 (Server) |
OrderClose |
0 (Server) |
PhoneCall |
0 (Server) |
ProcessSession |
0 (Server) |
Queue |
0 (Server) |
Quote |
0 (Server) |
QuoteClose |
0 (Server) |
RecurringAppointmentMaster |
0 (Server) |
Report |
0 (Server) |
RoutingRule |
0 (Server) |
SalesOrder |
0 (Server) |
ServiceAppointment |
0 (Server) |
SharePointDocumentLocation |
0 (Server) |
SharePointSite |
0 (Server) |
SLA |
0 (Server) |
SLAKPIInstance |
0 (Server) |
SocialActivity |
0 (Server) |
SocialProfile |
0 (Server) |
Task |
0 (Server) |
Template |
0 (Server) |
UserForm |
0 (Server) |
UserQuery |
0 (Server) |
UserQueryVisualization |
0 (Server) |
Workflow |
0 (Server) |
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.
// Revoke access to the lead for the second user.
var revokeUser2AccessReq = new RevokeAccessRequest
{
Revokee = systemUser2Ref,
Target = leadReference
};
Console.WriteLine("Revoking access to the lead for {0}...\r\n",
GetEntityReferenceString(systemUser2Ref));
_serviceProxy.Execute(revokeUser2AccessReq);
' Revoke access to the lead for the second user.
Dim revokeUser2AccessReq = New RevokeAccessRequest With
{
.Revokee = systemUser2Ref,
.Target = leadReference
}
Console.WriteLine("Revoking access to the lead for {0}..." & vbCrLf,
GetEntityReferenceString(systemUser2Ref))
_serviceProxy.Execute(revokeUser2AccessReq)
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.
See Also
RevokeAccessResponse
Microsoft.Crm.Sdk.Messages Namespace
How record-based security can be used to control access to records in Microsoft Dynamics CRM
Actions on entity records
Sample: Share records using GrantAccess, ModifyAccess and RevokeAccess messages
Return to top
© 2016 Microsoft. All rights reserved. Copyright