ModifyAccessRequest Class

 

Updated: November 29, 2016

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

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)

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

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

NameDescription
System_CAPS_pubmethodModifyAccessRequest()

Initializes a new instance of the ModifyAccessRequest class.

NameDescription
System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyItem(String)

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyParameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyPrincipalAccess

Gets or sets the team or user whose access to the specified record is modified. Required.

System_CAPS_pubpropertyRequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyTarget

Gets or sets the entity that is the target of the request to modify access. Required.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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 ModifyAccessResponse class.

Privileges and Access Rights

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

Notes for Callers

This action applies to all child records of the target entity record. For all child records, if the caller does not have share privileges for those entity types or share rights to the records, the child records are not shared. As a result, the owner of the entity record, or a user who shares the record that has share rights, automatically has share rights to all child records of the target entity record. In this case, only the lack of privileges to a particular entity type prevents the child records from being shared.

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)

Email

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)

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.




' Grant the first user delete access to the lead.
Dim modifyUser1AccessReq = New ModifyAccessRequest With
                           {
                               .PrincipalAccess =
                               New PrincipalAccess With
                               {
                                   .AccessMask = AccessRights.DeleteAccess,
                                   .Principal = systemUser1Ref
                               },
                               .Target = leadReference
                           }

Console.WriteLine("Granting delete access to {0} on the lead..." &amp; vbCrLf,
                  GetEntityReferenceString(systemUser1Ref))
_serviceProxy.Execute(modifyUser1AccessReq)

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: