CRMContract.GrantAccess Method

  • Article

The GrantAccess method grants a security principal access to the specified contract. This method also applies to all child objects of the contract. 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 contract. In this case, only the lack of privileges for a particular object type prevents the child objects from being shared.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must be the owner of the contract and have the prvShareContract privilege and access rights on the object to be modified. See CUserAuth.

ContractId

Specifies the ID of the contract.

Rights

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

Grantee

Specifies the team or user to be granted access to the contract. 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 = "https://" + strServer + "/" + virtualDirectory + "/";

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

// CRMContract proxy object
Microsoft.Crm.Platform.Proxy.CRMContract contract = new Microsoft.Crm.Platform.Proxy.CRMContract ();
contract.Credentials = System.Net.CredentialCache.DefaultCredentials;
contract.Url = strDir + "CRMContract.srf";

string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}"; 
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";

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

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

   uint rights = Microsoft.Crm.Platform.Types.AccessRights.CRM_ACCESS_READ;

   contract.GrantAccess(userAuth, strContractId, 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.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.