Edit

Share via

Security Role (Role) table/entity reference (Microsoft Dataverse)

Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.

Messages

The following table lists the messages for the Security Role (Role) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
AddPrivilegesRole
Event: True		 AddPrivilegesRole AddPrivilegesRoleRequest
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /roles
See Create		 Create records
Delete
Event: True		 DELETE /roles(roleid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
RemovePrivilegeRole
Event: True		 RemovePrivilegeRole RemovePrivilegeRoleRequest
ReplacePrivilegesRole
Event: True		 ReplacePrivilegesRole ReplacePrivilegesRoleRequest
Retrieve
Event: False		 GET /roles(roleid)
See Retrieve		 Retrieve records
RetrieveAadUserRoles
Event: False		 RetrieveAadUserRoles RetrieveAadUserRolesRequest
RetrieveMultiple
Event: False		 GET /roles
See Query data		 Query data
RetrieveRolePrivilegesRole
Event: False		 RetrieveRolePrivilegesRole RetrieveRolePrivilegesRoleRequest
Update
Event: True		 PATCH /roles(roleid)
See Update		 Update records
Upsert
Event: False		 PATCH /roles(roleid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Security Role (Role) table.

Property Value
DisplayName Security Role
DisplayCollectionName Security Roles
SchemaName Role
CollectionSchemaName Roles
EntitySetName roles
LogicalName role
LogicalCollectionName roles
PrimaryIdAttribute roleid
PrimaryNameAttribute name
TableType Standard
OwnershipType BusinessOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ApplicationId

Property Value
Description Application Id of user who created the role
DisplayName Application Id
IsValidForForm True
IsValidForRead True
LogicalName applicationid
RequiredLevel None
Type Uniqueidentifier

AppliesTo

Property Value
Description Personas/Licenses the security role applies to
DisplayName Applies To
IsValidForForm True
IsValidForRead True
LogicalName appliesto
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

BusinessUnitId

Property Value
Description Unique identifier of the business unit with which the role is associated.
DisplayName Business Unit
IsValidForForm False
IsValidForRead True
LogicalName businessunitid
RequiredLevel SystemRequired
Type Lookup
Targets businessunit

CanBeDeleted

Property Value
Description Tells whether the role can be deleted.
DisplayName Can Be Deleted
IsValidForForm False
IsValidForRead True
LogicalName canbedeleted
RequiredLevel SystemRequired
Type ManagedProperty

Description

Property Value
Description Description of the security role
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsAutoAssigned

Property Value
Description Value indicating whether security role is auto-assigned based on user license
DisplayName Is Auto Assigned
IsValidForForm True
IsValidForRead True
LogicalName isautoassigned
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue
GlobalChoiceName securityrole_isautoassigned

IsAutoAssigned Choices/Options

Value Label
0 No
1 Yes

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsInherited

Property Value
Description Role is inherited by users from team membership, if role associated with team.
DisplayName Is Inherited
IsValidForForm True
IsValidForRead True
LogicalName isinherited
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 1
GlobalChoiceName isinherited

IsInherited Choices/Options

Value Label
0 Team privileges only
1 Direct User (Basic) access level and Team privileges

IsSystemGenerated

Property Value
Description Is this role generated by the system
DisplayName Is System Generated
IsValidForForm True
IsValidForRead True
LogicalName issytemgenerated
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName role_issytemgenerated
DefaultValue False
True Label Yes
False Label No

Name

Property Value
Description Name of the role.
DisplayName Name
IsValidForForm False
IsValidForRead True
LogicalName name
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

RoleId

Property Value
Description Unique identifier of the role.
DisplayName Role
IsValidForForm False
IsValidForRead True
LogicalName roleid
RequiredLevel SystemRequired
Type Uniqueidentifier

SummaryofCoreTablePermissions

Property Value
Description Summary of Core Table Permissions of the Role
DisplayName Summary of Core Table Permissions
IsValidForForm True
IsValidForRead True
LogicalName summaryofcoretablepermissions
RequiredLevel ApplicationRequired
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 2000

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the role.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the role was created.
DisplayName Created On
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the role.
DisplayName Created By Impersonator
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName State
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the role.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the role was last modified.
DisplayName Modified On
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the role.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OrganizationId

Property Value
Description Unique identifier of the organization associated with the role.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Type Uniqueidentifier

OrganizationIdName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

ParentRoleId

Property Value
Description Unique identifier of the parent role.
DisplayName Parent Role
IsValidForForm False
IsValidForRead True
LogicalName parentroleid
RequiredLevel None
Type Lookup
Targets role

ParentRootRoleId

Property Value
Description Unique identifier of the parent root role.
DisplayName Parent Root Role
IsValidForForm False
IsValidForRead True
LogicalName parentrootroleid
RequiredLevel SystemRequired
Type Lookup
Targets role

RoleIdUnique

Property Value
Description For internal use only.
DisplayName Unique Id
IsValidForForm False
IsValidForRead True
LogicalName roleidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

RoleTemplateId

Property Value
Description Unique identifier of the role template that is associated with the role.
DisplayName Role Template
IsValidForForm False
IsValidForRead True
LogicalName roletemplateid
RequiredLevel None
Type Lookup
Targets roletemplate

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Version number of the role.
DisplayName Version number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_roles

One-To-Many Relationship: businessunit business_unit_roles

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute businessunitid
ReferencingEntityNavigationPropertyName businessunitid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_role_createdonbehalfby

One-To-Many Relationship: systemuser lk_role_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_role_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_role_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_rolebase_createdby

One-To-Many Relationship: systemuser lk_rolebase_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_rolebase_modifiedby

One-To-Many Relationship: systemuser lk_rolebase_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_roles

One-To-Many Relationship: organization organization_roles

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid_organization
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

role_parent_role

One-To-Many Relationship: role role_parent_role

Property Value
ReferencedEntity role
ReferencedAttribute roleid
ReferencingAttribute parentroleid
ReferencingEntityNavigationPropertyName parentroleid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

role_parent_root_role

One-To-Many Relationship: role role_parent_root_role

Property Value
ReferencedEntity role
ReferencedAttribute roleid
ReferencingAttribute parentrootroleid
ReferencingEntityNavigationPropertyName parentrootroleid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

role_template_roles

One-To-Many Relationship: roletemplate role_template_roles

Property Value
ReferencedEntity roletemplate
ReferencedAttribute roletemplateid
ReferencingAttribute roletemplateid
ReferencingEntityNavigationPropertyName roletemplateid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

solution_role

One-To-Many Relationship: solution solution_role

Property Value
ReferencedEntity solution
ReferencedAttribute solutionid
ReferencingAttribute solutionid
ReferencingEntityNavigationPropertyName solution_role
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

Role_AsyncOperations

Many-To-One Relationship: asyncoperation Role_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Role_AsyncOperations
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Role_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure Role_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Role_BulkDeleteFailures
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

role_parent_role

Many-To-One Relationship: role role_parent_role

Property Value
ReferencingEntity role
ReferencingAttribute parentroleid
ReferencedEntityNavigationPropertyName role_parent_role
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

role_parent_root_role

Many-To-One Relationship: role role_parent_root_role

Property Value
ReferencingEntity role
ReferencingAttribute parentrootroleid
ReferencedEntityNavigationPropertyName role_parent_root_role
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Role_SyncErrors

Many-To-One Relationship: syncerror Role_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Role_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Many-to-Many relationships

These relationships are many-to-many. Listed by SchemaName.

application_role

See application application_role Many-To-Many Relationship

Property Value
IntersectEntityName applicationroles
IsCustomizable False
SchemaName application_role
IntersectAttribute roleid
NavigationPropertyName application_role
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

applicationuserrole

See applicationuser applicationuserrole Many-To-Many Relationship

Property Value
IntersectEntityName applicationuserrole
IsCustomizable False
SchemaName applicationuserrole
IntersectAttribute roleid
NavigationPropertyName applicationuserrole
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

appmoduleroles_association

See appmodule appmoduleroles_association Many-To-Many Relationship

Property Value
IntersectEntityName appmoduleroles
IsCustomizable False
SchemaName appmoduleroles_association
IntersectAttribute roleid
NavigationPropertyName appmoduleroles_association
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

roleprivileges_association

See privilege roleprivileges_association Many-To-Many Relationship

Property Value
IntersectEntityName roleprivileges
IsCustomizable False
SchemaName roleprivileges_association
IntersectAttribute roleid
NavigationPropertyName roleprivileges_association
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

systemuserroles_association

See systemuser systemuserroles_association Many-To-Many Relationship

Property Value
IntersectEntityName systemuserroles
IsCustomizable False
SchemaName systemuserroles_association
IntersectAttribute roleid
NavigationPropertyName systemuserroles_association
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

teamroles_association

See team teamroles_association Many-To-Many Relationship

Property Value
IntersectEntityName teamroles
IsCustomizable False
SchemaName teamroles_association
IntersectAttribute roleid
NavigationPropertyName teamroles_association
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
role