Role (security role) entity messages and methods

 

Applies To: Dynamics CRM 2013

A role represents a grouping of security privileges. Users are assigned roles that authorize their access to Microsoft Dynamics CRM. The schema name for this entity is Role. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AddPrivilegesRoleRequest	Adds a set of existing privileges to an existing role.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see Role entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CreateRequest	Creates a role. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a role. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService. Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see Role entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
RemovePrivilegeRoleRequest	Removes a privilege from a role.
ReplacePrivilegesRoleRequest	Replaces the privilege set of an existing role. This effectively deletes all existing privileges from the role and adds the new specified privileges.
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves a role. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of roles. You can also call the IOrganizationService.RetrieveMultiple method.
RetrieveRolePrivilegesRoleRequest	Retrieves the privileges that are assigned to the specified role.
UpdateRequest	Updates a role. You can also call the IOrganizationService.Update method.

See Also

How role-based security can be used to control access to entities in Microsoft Dynamics CRM 2013
Privilege and role entities
Privilege entity messages and methods
Role (security role) entity privileges