CRMContact.GrantAccess Method
The GrantAccess method grants a user or team access to the specified contact. This method also applies to all child objects of the contact. 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 contact. 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 ContactId As String,
ByVal Rights As UInt32,
ByVal Grantee As CSecurityPrincipal
)
[C#]
public void GrantAccess(
CUserAuth Caller,
string ContactId,
uint Rights,
CSecurityPrincipal Grantee
);
[C++]
public: void GrantAccess(
CUserAuth* Caller,
String* ContactId,
unsigned long Rights,
CSecurityPrincipal* Grantee
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvShareContact privilege to perform this action. See CUserAuth.
ContactId
Specifies the ID of the contact.
Rights
Specifies the set of rights to be granted. See ACCESSRIGHTS.
Grantee
Specifies the team or user that is to be granted access to the contact. 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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMContact proxy object
Microsoft.CRM.Proxy.CRMContact contact = new Microsoft.CRM.Proxy.CRMContact ();
contact.Credentials = System.Net.CredentialCache.DefaultCredentials;
contact.Url = strDir + "CRMContact.srf";
string strErrorMsg;
string strContactId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
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;
// Share the contact with the user
contact.GrantAccess(userAuth, strContactId, 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