Freigeben über


AddPrivilegesRoleRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the AddPrivilegesRole Action.

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

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddPrivilegesRoleRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class AddPrivilegesRoleRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod AddPrivilegesRoleRequest()

Initializes a new instance of the AddPrivilegesRoleRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Privileges

Gets or sets the IDs and depths of the privileges you want to add. Required.

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RoleId

Gets or sets the ID of the role for which you want to add the privileges. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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 message privileges.

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. 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)

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.

See Also

AddPrivilegesRoleResponse
Microsoft.Crm.Sdk.Messages Namespace
Privilege and role entities
Role (security role) entity messages and methods
Privilege entity messages and methods
Sample: Assign a record to a team
AddPrivilegesRole message privileges

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright