role EntityType
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.
Entity Set path:[organization URI]/api/data/v8.2/roles
Base Type: crmbaseentity EntityType
Display Name: Security Role
Primary Key: roleid
Primary Name Attribute: name
Single-valued navigation properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name | Type | Details |
|---|---|---|
componentstate | Edm.Int32 | Description: For internal use only. Default Options: 0 : Published Display Name: Component State Read-only property |
createdon | Edm.DateTimeOffset | Description: Date and time when the role was created. Display Name: Created On Read-only property |
importsequencenumber | Edm.Int32 | Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
iscustomizable | Description: Information that specifies whether this component can be customized. Display Name: Customizable | |
ismanaged | Edm.Boolean | Description: Indicates whether the solution component is part of a managed solution. Default Options: 1 : Managed Display Name: State Read-only property |
modifiedon | Edm.DateTimeOffset | Description: Date and time when the role was last modified. Display Name: Modified On Read-only property |
name | Edm.String | Description: Name of the role. Display Name: Name |
organizationid | Edm.Guid | Description: Unique identifier of the organization associated with the role. Display Name: Organization Read-only property |
overriddencreatedon | Edm.DateTimeOffset | Description: Date and time that the record was migrated. Display Name: Record Created On |
overwritetime | Edm.DateTimeOffset | Description: For internal use only. Display Name: Record Overwrite Time Read-only property |
roleid | Edm.Guid | Description: Unique identifier of the role. Display Name: Role |
roleidunique | Edm.Guid | Description: For internal use only. Display Name: Unique Id Read-only property |
solutionid | Edm.Guid | Description: Unique identifier of the associated solution. Display Name: Solution Read-only property |
versionnumber | Edm.Int64 | Description: Version number of the role. Display Name: Version number Read-only property |
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties
Name | Single-valued navigation property | Description |
|---|---|---|
_businessunitid_value | businessunitid | Unique identifier of the business unit with which the role is associated. |
_createdby_value | createdby | Unique identifier of the user who created the role. |
_createdonbehalfby_value | createdonbehalfby | Unique identifier of the delegate user who created the role. |
_modifiedby_value | modifiedby | Unique identifier of the user who last modified the role. |
_modifiedonbehalfby_value | modifiedonbehalfby | Unique identifier of the delegate user who last modified the role. |
_parentroleid_value | parentroleid | Unique identifier of the parent role. |
_parentrootroleid_value | parentrootroleid | Unique identifier of the parent root role. |
_roletemplateid_value | roletemplateid | Unique identifier of the role template that is associated with the role. |
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
Name | Type | Partner |
|---|---|---|
businessunitid | business_unit_roles | |
createdby | lk_rolebase_createdby | |
createdonbehalfby | lk_role_createdonbehalfby | |
modifiedby | lk_rolebase_modifiedby | |
modifiedonbehalfby | lk_role_modifiedonbehalfby | |
organizationid_organization | organization_roles | |
parentroleid | role_parent_role | |
parentrootroleid | role_parent_root_role | |
roletemplateid | role_template_roles |
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
Name | Type | Partner |
|---|---|---|
Role_AsyncOperations | regardingobjectid_role | |
Role_BulkDeleteFailures | regardingobjectid_role | |
role_parent_role | parentroleid | |
role_parent_root_role | parentrootroleid | |
Role_SyncErrors | regardingobjectid_role_syncerror | |
roleprivileges_association | roleprivileges_association | |
systemuserroles_association | systemuserroles_association | |
teamroles_association | teamroles_association |
The following operations are bound to the role entity type.
Name | Bound to |
|---|---|
Entity | |
Entity | |
Entity |
The following operations use the role entity type in a parameter or return type.
Name | How used | Description |
|---|---|---|
entity Parameter | Adds a set of existing privileges to an existing role. | |
entity Parameter | Removes a privilege from an existing role. | |
entity Parameter | Replaces the privilege set of an existing role. |
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright