AddPrivilegesRoleRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to add a set of existing privileges to an existing role.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class AddPrivilegesRoleRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class AddPrivilegesRoleRequest : OrganizationRequest

Example

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. For the complete sample, see the link later in this topic.

// Add the prvReadAccount privilege to the example roles to assure the
// team can read accounts.
AddPrivilegesRoleRequest addPrivilegesRequest = new AddPrivilegesRoleRequest
{
    RoleId = _roleId,
    Privileges = new[] 
    {
        // Grant prvReadAccount privilege.
        new RolePrivilege
        { 
            PrivilegeId = readAccountPrivilege.Id 
        }
    }
};
_service.Execute(addPrivilegesRequest);

' Add the prvReadAccount privilege to the example roles to assure the
' team can read accounts.
Dim addPrivilegesRequest As AddPrivilegesRoleRequest = New AddPrivilegesRoleRequest With { _
    .RoleId = _roleId, .Privileges = {New RolePrivilege With {.PrivilegeId = readAccountPrivilege.Id}}}
        ' Grant prvReadAccount privilege.
_service.Execute(addPrivilegesRequest)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute 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 entity and access rights on the specified record in the RoleId property. For a complete list of the required privileges, see AddPrivilegesRole Privileges.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.AddPrivilegesRoleRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

AddPrivilegesRoleRequest Members
Microsoft.Crm.Sdk.Messages Namespace
AddPrivilegesRoleResponse

Other Resources

Privilege and Role Entities
Role Entity Messages and Methods
Privilege Entity Messages and Methods
Sample: Assign a Record to a Team
AddPrivilegesRole Privileges

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.