Security Role (Role) entity reference
Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.
Messages
Message | SDK class or method |
---|---|
AddPrivilegesRole | AddPrivilegesRoleRequest |
Create | CreateRequest or Create |
Delete | DeleteRequest or Delete |
RemovePrivilegeRole | RemovePrivilegeRoleRequest |
ReplacePrivilegesRole | ReplacePrivilegesRoleRequest |
Retrieve | RetrieveRequest or Retrieve |
RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
RetrieveRolePrivilegesRole | RetrieveRolePrivilegesRoleRequest |
Update | UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | Roles |
DisplayCollectionName | Security Roles |
DisplayName | Security Role |
EntitySetName | roles |
IsBPFEntity | False |
LogicalCollectionName | roles |
LogicalName | role |
OwnershipType | BusinessOwned |
PrimaryIdAttribute | roleid |
PrimaryNameAttribute | name |
SchemaName | Role |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
BusinessUnitId
Property | Value |
---|---|
Description | Unique identifier of the business unit with which the role is associated. |
DisplayName | Business Unit |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | businessunitid |
RequiredLevel | SystemRequired |
Targets | businessunit |
Type | Lookup |
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 |
ImportSequenceNumber
Property | Value |
---|---|
Description | Unique identifier of the data import or data migration that created this record. |
DisplayName | Import Sequence Number |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | importsequencenumber |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
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 |
Name
Property | Value |
---|---|
Description | Name of the role. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | name |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
OverriddenCreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
RoleId
Property | Value |
---|---|
Description | Unique identifier of the role. |
DisplayName | Role |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | roleid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- BusinessUnitIdName
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- OverwriteTime
- ParentRoleId
- ParentRoleIdName
- ParentRootRoleId
- ParentRootRoleIdName
- RoleIdUnique
- RoleTemplateId
- SolutionId
- SupportingSolutionId
- VersionNumber
BusinessUnitIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | businessunitidname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
ComponentState
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
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 |
Targets | systemuser |
Type | Lookup |
CreatedByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the role was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
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 |
Targets | systemuser |
Type | Lookup |
CreatedOnBehalfByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOnBehalfByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
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 |
IsManaged Choices/Options
Value | Label | Description |
---|---|---|
1 | Managed | |
0 | Unmanaged |
DefaultValue: 0
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 |
Targets | systemuser |
Type | Lookup |
ModifiedByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the role was last modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
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 |
Targets | systemuser |
Type | Lookup |
ModifiedOnBehalfByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOnBehalfByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
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 | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationidname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
OverwriteTime
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | For internal use only. |
DisplayName | Record Overwrite Time |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
ParentRoleId
Property | Value |
---|---|
Description | Unique identifier of the parent role. |
DisplayName | Parent Role |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentroleid |
RequiredLevel | None |
Targets | role |
Type | Lookup |
ParentRoleIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentroleidname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
ParentRootRoleId
Property | Value |
---|---|
Description | Unique identifier of the parent root role. |
DisplayName | Parent Root Role |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentrootroleid |
RequiredLevel | SystemRequired |
Targets | role |
Type | Lookup |
ParentRootRoleIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentrootroleidname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
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 |
Targets | roletemplate |
Type | Lookup |
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 |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
role_parent_role
Same as the role_parent_role many-to-one relationship for the role entity.
Property | Value |
---|---|
ReferencingEntity | role |
ReferencingAttribute | parentroleid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | role_parent_role |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Role_AsyncOperations
Same as the Role_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | Role_AsyncOperations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
role_parent_root_role
Same as the role_parent_root_role many-to-one relationship for the role entity.
Property | Value |
---|---|
ReferencingEntity | role |
ReferencingAttribute | parentrootroleid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | role_parent_root_role |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Role_BulkDeleteFailures
Same as the Role_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | Role_BulkDeleteFailures |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Role_SyncErrors
Same as the Role_SyncErrors many-to-one relationship for the syncerror entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | Role_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_rolebase_modifiedby
- role_parent_role
- organization_roles
- business_unit_roles
- lk_role_createdonbehalfby
- lk_role_modifiedonbehalfby
- role_parent_root_role
- lk_rolebase_createdby
lk_rolebase_modifiedby
See the lk_rolebase_modifiedby one-to-many relationship for the systemuser entity.
role_parent_role
See the role_parent_role one-to-many relationship for the role entity.
organization_roles
See the organization_roles one-to-many relationship for the organization entity.
business_unit_roles
See the business_unit_roles one-to-many relationship for the businessunit entity.
lk_role_createdonbehalfby
See the lk_role_createdonbehalfby one-to-many relationship for the systemuser entity.
lk_role_modifiedonbehalfby
See the lk_role_modifiedonbehalfby one-to-many relationship for the systemuser entity.
role_parent_root_role
See the role_parent_root_role one-to-many relationship for the role entity.
lk_rolebase_createdby
See the lk_rolebase_createdby one-to-many relationship for the systemuser entity.
Many-To-Many Relationships
Relationship details provided where the Role entity is the first entity in the relationship. Listed by SchemaName.
- systemuserroles_association
- roleprivileges_association
- appmoduleroles_association
- teamroles_association
systemuserroles_association
See the systemuserroles_association many-to-many relationship for the systemuser entity.
roleprivileges_association
See the roleprivileges_association many-to-many relationship for the privilege entity.
appmoduleroles_association
See the appmoduleroles_association many-to-many relationship for the appmodule entity.
teamroles_association
See the teamroles_association many-to-many relationship for the team entity.
See also
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour