Share via

CRMInvoice.RevokeAccess Method

  • Article

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

Parameters

Caller

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

InvoiceId

Specifies the ID of the invoice.

Principal

Specifies the security principal (user or team) whose access is to 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";

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

string strErrorMsg;
string strInvoiceId = "{A9920C07-EE2A-3434-A7EC-9J9D240CF535}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
uint rights = Microsoft.Crm.Platform.Types.AccessRights.CRM_ACCESS_READ;

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;

   // Grant access to the security principal
   invoice.GrantAccess(userAuth, strInvoiceId, rights, securityPrincipal);

   // Modify the access for the security principal
   invoice.ModifyAccess(userAuth, strInvoiceId, Microsoft.Crm.Platform.Types.AccessRights.CRM_ACCESS_READ, securityPrincipal);

   // Revoke access for the security principal
   invoice.RevokeAccess(userAuth, strInvoiceId, 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.