Privilege entity reference
Permission to perform an action in Microsoft CRM. The platform checks for the privilege and rejects the attempt if the user does not hold the privilege.
Messages
| Message | SDK class or method |
|---|---|
| Retrieve | RetrieveRequest or Retrieve |
| RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | Privileges |
| DisplayCollectionName | Privileges |
| DisplayName | Privilege |
| EntitySetName | privileges |
| IsBPFEntity | False |
| LogicalCollectionName | privileges |
| LogicalName | privilege |
| OwnershipType | None |
| PrimaryIdAttribute | privilegeid |
| PrimaryNameAttribute | name |
| SchemaName | Privilege |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AccessRight
- CanBeBasic
- CanBeDeep
- CanBeEntityReference
- CanBeGlobal
- CanBeLocal
- CanBeParentEntityReference
- IntroducedVersion
- Name
- PrivilegeId
- PrivilegeRowId
AccessRight
| Property | Value |
|---|---|
| Description | Rights a user has to an instance of an entity. |
| DisplayName | |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | accessright |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
CanBeBasic
| Property | Value |
|---|---|
| Description | Information that specifies whether the privilege applies to the user, the user's team, or objects shared by the user. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbebasic |
| RequiredLevel | None |
| Type | Boolean |
CanBeBasic Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
CanBeDeep
| Property | Value |
|---|---|
| Description | Information that specifies whether the privilege applies to child business units of the business unit associated with the user. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbedeep |
| RequiredLevel | None |
| Type | Boolean |
CanBeDeep Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
CanBeEntityReference
| Property | Value |
|---|---|
| Description | Information that specifies whether the privilege applies to the local reference of an external party. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbeentityreference |
| RequiredLevel | None |
| Type | Boolean |
CanBeEntityReference Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
CanBeGlobal
| Property | Value |
|---|---|
| Description | Information that specifies whether the privilege applies to the entire organization. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbeglobal |
| RequiredLevel | None |
| Type | Boolean |
CanBeGlobal Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
CanBeLocal
| Property | Value |
|---|---|
| Description | Information that specifies whether the privilege applies to the user's business unit. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbelocal |
| RequiredLevel | None |
| Type | Boolean |
CanBeLocal Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
CanBeParentEntityReference
| Property | Value |
|---|---|
| Description | Information that specifies whether the privilege applies to parent reference of the external party. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbeparententityreference |
| RequiredLevel | None |
| Type | Boolean |
CanBeParentEntityReference Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
IntroducedVersion
| Property | Value |
|---|---|
| Description | Version in which the component is introduced. |
| DisplayName | Introduced Version |
| FormatName | VersionNumber |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | introducedversion |
| MaxLength | 48 |
| RequiredLevel | None |
| Type | String |
Name
| Property | Value |
|---|---|
| Description | Name of the privilege. |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
PrivilegeId
| Property | Value |
|---|---|
| Description | Unique identifier of the privilege. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | privilegeid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
PrivilegeRowId
| Property | Value |
|---|---|
| Description | Unique identifier of the Privilege used when synchronizing customizations for the Microsoft Dynamics CRM client for Outlook |
| DisplayName | App Module Unique Id |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | privilegerowid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentState
- IsDisabledWhenIntegrated
- IsManaged
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
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 |
IsDisabledWhenIntegrated
| Property | Value |
|---|---|
| Description | Specifies whether the privilege is disabled. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | isdisabledwhenintegrated |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsDisabledWhenIntegrated Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
IsManaged
| Property | Value |
|---|---|
| Description | Information that specifies whether this component is managed. |
| DisplayName | State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsManaged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Managed | |
| 0 | Unmanaged |
DefaultValue: 0
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 |
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 | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
Privilege_AsyncOperations
Same as the Privilege_AsyncOperations many-to-one relationship for the asyncoperation entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Privilege_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Privilege_BulkDeleteFailures
Same as the Privilege_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Privilege_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-Many Relationships
Relationship details provided where the Privilege entity is the first entity in the relationship. Listed by SchemaName.
roleprivileges_association
IntersectEntityName: roleprivileges
Table 1
| Property | Value |
|---|---|
| IntersectAttribute | privilegeid |
| IsCustomizable | False |
| LogicalName | privilege |
| NavigationPropertyName | roleprivileges_association |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
Table 2
| Property | Value |
|---|---|
| LogicalName | role |
| IntersectAttribute | roleid |
| NavigationPropertyName | roleprivileges_association |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for