CRMOpportunity.ModifyAccess Method

The ModifyAccess method replaces the access rights on the opportunity for the specified security principal. This method also applies to all child objects of the opportunity. For all child objects, if the caller does not have share privileges for those object types or share rights to the objects, the child objects are not shared. As a result, the owner of the object or a user who shares the object with share rights automatically has share rights to all child objects of the opportunity. In this case, only the lack of privileges to a particular object type prevents the child objects from being shared.

Syntax

[Visual Basic .NET]
Public Sub ModifyAccess(
  ByVal Caller As CUserAuth,
  ByVal OpportunityId As String,
  ByVal Rights As UInt32,
  ByVal Grantee As CSecurityPrincipal
)
[C#]
public void ModifyAccess(
  CUserAuth  Caller,
  string  OpportunityId,
  uint  Rights,
  CSecurityPrincipal  Grantee
);
[C++]
public: void ModifyAccess(
  CUserAuth*  Caller,
  String*  OpportunityId,
  unsigned long  Rights,
  CSecurityPrincipal*  Grantee
);

Parameters

Caller

Specifies the identity of the caller. The caller must be the object owner and have the prvShareOpportunity privilege to perform this action. See CUserAuth.

OpportunityId

Specifies the ID of the opportunity.

Rights

Specifies the set of rights that are to be granted. See ACCESSRIGHTS.

Grantee

Specifies the team or user for whom access is to be granted. See CSecurityPrincipal.

Return Value

No return value.

Remarks

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "http://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMOpportunity proxy object
Microsoft.CRM.Proxy.CRMOpportunity opportunity = new Microsoft.CRM.Proxy.CRMOpportunity();
opportunity.Credentials = System.Net.CredentialCache.DefaultCredentials;
opportunity.Url = strDir + "CRMOpportunity.srf";

string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Create a new security principal
   Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = strUserId;
   securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;

   uint rights = Microsoft.CRM.Flags.AccessRights.CRM_ACCESS_READ;

   // Grant access for the security principal
   opportunity.ModifyAccess(userAuth, strOpportunityId, rights, securityPrincipal);
}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.CRM.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.