Share via

SecRole.ReplacePrivileges Method

  • Article

The ReplacePrivileges method replaces the privilege set of an existing role.

Syntax

[Visual Basic .NET]
Public Sub ReplacePrivileges(
  ByVal Caller As CUserAuth,
  ByVal RoleId As String,
  ByVal Privileges As CRolePrivilege()
)
[C#]
public void ReplacePrivileges(
  CUserAuth  Caller,
  string  RoleId,
  CRolePrivilege[]  Privileges
);
[C++]
public: void ReplacePrivileges(
  CUserAuth*  Caller,
  String*  RoleId,
  CRolePrivilege*  Privileges __gc[]
);

Parameters

Caller

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

RoleId

Specifies the ID of the role to which the privilege is to be added. This ID is specified by the platform and is obtained at creation time or by a bulk retrieve.

Privileges

Specifies an array containing the IDs and depths of the privileges that are to be added. Each CRolePrivilege structure should contain one string privilege ID. Privilege IDs can be obtained by a call to the BizPrivilege::RetrievePrivilegeSet method. See CRolePrivilege.

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

// strVirtualDirectory should be set with the name of the Microsoft CRM 
// virtual directory on the platform Web server
string strVirtualDirectory = "mscrmservices";

// Create the URL to the SRF files for platform objects
string strDir = "https://" + strServer + "/" + strVirtualDirectory + "/";

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

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

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

// Declare the caller
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = null;

string strSecRoleXML = "";
string strErrorMsg = "";

try
{
   // Get the UserAuth of the current logged-on user
   userAuth = user.WhoAmI();
   
   // Retrieve the desired role
   string strRoleId = secRole.RetrieveIdFromName(userAuth, userAuth.MerchantId, "My Role Name");

   // Retrieve all the privileges
   string strPrivilegeSet = privilege.RetrievePrivilegeSet(userAuth);

   // Create an array of privileges to add to the desired role
   Microsoft.Crm.Platform.Proxy.CRolePrivilege[] rolePrivileges = new Microsoft.Crm.Platform.Proxy.CRolePrivilege[2];
   for (int i=0;i<2;i++)
   {
      rolePrivileges[i] = new Microsoft.Crm.Platform.Proxy.CRolePrivilege();
   }

   // prvCreateAccount
   rolePrivileges[0].Depth = Microsoft.Crm.Platform.Proxy.PRIVILEGE_DEPTH.BASIC;
   rolePrivileges[0].PrivilegeId = "{D26FE964-230B-42DD-AD93-5CC879DE411E}";

   // prvReadAccount
   rolePrivileges[1].Depth = Microsoft.Crm.Platform.Proxy.PRIVILEGE_DEPTH.DEEP;
   rolePrivileges[1].PrivilegeId = "{886B280C-6396-4D56-A0A3-2C1B0A50CEB0}";

   // prvWriteAccount
   rolePrivileges[2].Depth = Microsoft.Crm.Platform.Proxy.PRIVILEGE_DEPTH.GLOBAL;
   rolePrivileges[2].PrivilegeId = "{7863E80F-0AB2-4D67-A641-37D9F342C7E3}";

   // Replace the privileges for the role
   secRole.ReplacePrivileges(userAuth, strRoleId, rolePrivileges);
}
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 + "Source: " + err.Source );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.