AddPrivilegesRoleRequest Class

Definition

public ref class AddPrivilegesRoleRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddPrivilegesRoleRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type AddPrivilegesRoleRequest = class
    inherit OrganizationRequest

Public NotInheritable Class AddPrivilegesRoleRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

AddPrivilegesRoleRequest

Attributes

DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationServiceinterface.

/// <summary>
/// Demonstrates how to add privileges to a role
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
static void AddPrivilegesRoleExample(IOrganizationService service)
{

      // The ID of the role without the privileges
      Guid RoleId = new("<Add roleid here>");

      // The privileges to add to the role
      string[] privileges = { "prvReadAccount","prvWriteAccount"};

      // Retrieve the privileges
      var query = new QueryExpression
      {
         EntityName = "privilege",
         ColumnSet = new ColumnSet("privilegeid", "name")
      };
      query.Criteria.AddCondition("name", ConditionOperator.In, privileges);

      DataCollection<Entity> privilegeRecords =
         service.RetrieveMultiple(query).Entities;

      // Define a list to hold the RolePrivileges we'll need to add
      List<RolePrivilege> rolePrivileges = new();

      //Populate the RolePrivileges parameter
      foreach (Entity privilege in privilegeRecords)
      {
         RolePrivilege rolePrivilege = new(
            (int)PrivilegeDepth.Local, //Local depth
            privilege.GetAttributeValue<Guid>("privilegeid"));

         rolePrivileges.Add(rolePrivilege);
      }


      // Prepart the request
      AddPrivilegesRoleRequest request = new()
      {
         Privileges = rolePrivileges.ToArray(),
         RoleId = RoleId
      };
      // Send the request
      service.Execute(request);
}

Remarks

For the Web API use the AddPrivilegesRole action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the AddPrivilegesRoleResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Role table and access rights on the specified record in the RoleId property.

Constructors

Properties

Applies to

See also

• AddPrivilegesRoleResponse