Share via

CRMContact.RevokeAccess Method

  • Article

The RevokeAccess method revokes access rights to the contact for the specified security principal. 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, access to the child objects is not revoked. 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 to a particular object type prevents access to the child objects from being revoked.

Syntax

[Visual Basic .NET]
Public Sub RevokeAccess(
  ByVal Caller As CUserAuth,
  ByVal ContactId As String,
  ByVal Revokee As CSecurityPrincipal
)
[C#]
public void RevokeAccess(
  CUserAuth  Caller,
  string  ContactId,
  CSecurityPrincipal  Revokee
);
[C++]
public: void RevokeAccess(
  CUserAuth*  Caller,
  String*  ContactId,
  CSecurityPrincipal*  Revokee
);

Parameters

Caller

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

ContactId

Specifies the ID of the contact.

Revokee

Specifies the team or user whose access will be revoked. 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";

// CRMContact proxy object
Microsoft.Crm.Platform.Proxy.CRMContact contact = new Microsoft.Crm.Platform.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.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;

   // Share the contact with the user
   contact.GrantAccess(userAuth, strContactId, rights, securityPrincipal);

   // Now revoke access
   contact.RevokeAccess(userAuth, strContactId, 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.