CRMLead.GrantAccess Method
The GrantAccess method grants a security principal access to the specified lead. This method also applies to all child objects of the lead. 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 lead. 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 LeadId As String,
ByVal Rights As UInt32,
ByVal Grantee As CSecurityPrincipal
)
[C#]
public void GrantAccess(
CUserAuth Caller,
string LeadId,
uint Rights,
CSecurityPrincipal Grantee
);
[C++]
public: void GrantAccess(
CUserAuth* Caller,
String* LeadId,
unsigned long Rights,
CSecurityPrincipal* Grantee
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvShareLead privilege and access rights on the object to be shared. See CUserAuth.
LeadId
Specifies the ID of the lead to be shared.
Rights
Specifies the rights that are to be granted. See ACCESSRIGHTS.
Grantee
Specifies the security principal (user or team) with whom the lead is to be shared. 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";
// CRMLead proxy object
Microsoft.Crm.Platform.Proxy.CRMLead lead = new Microsoft.Crm.Platform.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";
string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
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;
// Grant the user access to the lead
lead.GrantAccess(userAuth, strLeadId, 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