Share via

CRMAccount.RevokeAccess Method

  • Article

The RevokeAccess method revokes access rights to the account for the specified security principal. This method also applies to all child objects of the account. 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 account. 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 AccountId As String,
  ByVal Revokee As CSecurityPrincipal
)
[C#]
public void RevokeAccess(
  CUserAuth  Caller,
  string  AccountId,
  CSecurityPrincipal  Revokee
);
[C++]
public: void RevokeAccess(
  CUserAuth*  Caller,
  String*  AccountId,
  CSecurityPrincipal*  Revokee
);

Parameters

Caller

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

AccountId

Specifies the ID of the account.

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";

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

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

string strErrorMsg;
string strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";

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

   // Intialize the 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;

   // Set the rights
   uint rights = Microsoft.Crm.Platform.Types.AccessRights.CRM_ACCESS_READ;

   // Grant access
   account.GrantAccess(userAuth, strAccountId, rights, securityPrincipal);

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