Field Permission (FieldPermission) table/entity reference
Group of privileges used to categorize users to provide appropriate access to secured columns.
Messages
The following table lists the messages for the Field Permission (FieldPermission) 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 |
---|---|---|
Create Event: True |
POST /fieldpermissionsSee Create |
Create records |
Delete Event: True |
DELETE /fieldpermissions(fieldpermissionid)See Delete |
Delete records |
Retrieve Event: False |
GET /fieldpermissions(fieldpermissionid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: False |
GET /fieldpermissionsSee Query data |
Query data |
Update Event: True |
PATCH /fieldpermissions(fieldpermissionid)See Update |
Update records |
Upsert Event: False |
PATCH /fieldpermissions(fieldpermissionid)See Upsert a table row |
UpsertRequest |
Properties
The following table lists selected properties for the Field Permission (FieldPermission) table.
Property | Value |
---|---|
DisplayName | Field Permission |
DisplayCollectionName | Field Permissions |
SchemaName | FieldPermission |
CollectionSchemaName | FieldPermissions |
EntitySetName | fieldpermissions |
LogicalName | fieldpermission |
LogicalCollectionName | fieldpermissions |
PrimaryIdAttribute | fieldpermissionid |
TableType | Standard |
OwnershipType | None |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AttributeLogicalName
- CanCreate
- CanRead
- CanReadUnMasked
- CanUpdate
- EntityName
- FieldPermissionId
- FieldSecurityProfileId
AttributeLogicalName
Property | Value |
---|---|
Description | Attribute Name. |
DisplayName | Name of the attribute for which this privilege is defined |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | attributelogicalname |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 128 |
CanCreate
Property | Value |
---|---|
Description | Can this Profile create the attribute |
DisplayName | Can create the attribute |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | cancreate |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | 0 |
GlobalChoiceName | field_security_permission_type |
CanCreate Choices/Options
Value | Label |
---|---|
0 | Not Allowed |
4 | Allowed |
CanRead
Property | Value |
---|---|
Description | Can this Profile read the attribute |
DisplayName | Can Read the attribute |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | canread |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | 0 |
GlobalChoiceName | field_security_permission_type |
CanRead Choices/Options
Value | Label |
---|---|
0 | Not Allowed |
4 | Allowed |
CanReadUnMasked
Property | Value |
---|---|
Description | |
DisplayName | Can this profile read unmasked value of attribute |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | canreadunmasked |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | 0 |
GlobalChoiceName | field_security_permission_readunmasked |
CanReadUnMasked Choices/Options
Value | Label |
---|---|
0 | Not Allowed |
1 | One Record |
3 | All Records |
CanUpdate
Property | Value |
---|---|
Description | Can this Profile update the attribute |
DisplayName | Can Update the attribute |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | canupdate |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | 0 |
GlobalChoiceName | field_security_permission_type |
CanUpdate Choices/Options
Value | Label |
---|---|
0 | Not Allowed |
4 | Allowed |
EntityName
Property | Value |
---|---|
Description | Entity name. |
DisplayName | Name of the Entity for which this privilege is defined |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | entityname |
RequiredLevel | SystemRequired |
Type | EntityName |
FieldPermissionId
Property | Value |
---|---|
Description | Unique identifier of the Field Permission. |
DisplayName | Field Permission |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | fieldpermissionid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
FieldSecurityProfileId
Property | Value |
---|---|
Description | Unique identifier of profile to which this privilege belongs. |
DisplayName | Profile |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | fieldsecurityprofileid |
RequiredLevel | SystemRequired |
Type | Lookup |
Targets | fieldsecurityprofile |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- ComponentState
- FieldPermissionIdUnique
- IsManaged
- OrganizationId
- 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 |
DefaultFormValue | -1 |
GlobalChoiceName | componentstate |
ComponentState Choices/Options
Value | Label |
---|---|
0 | Published |
1 | Unpublished |
2 | Deleted |
3 | Deleted Unpublished |
FieldPermissionIdUnique
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Field Permission |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | fieldpermissionidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
IsManaged
Property | Value |
---|---|
Description | Indicates whether the solution component is part of a managed solution. |
DisplayName | Is Managed |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | ismanaged |
RequiredLevel | SystemRequired |
Type | Boolean |
GlobalChoiceName | ismanaged |
DefaultValue | False |
True Label | Managed |
False Label | Unmanaged |
OrganizationId
Property | Value |
---|---|
Description | Unique identifier for the organization |
DisplayName | Organization Id |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationid |
RequiredLevel | None |
Type | Lookup |
Targets |
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 |
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 |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
lk_fieldpermission_fieldsecurityprofileid
One-To-Many Relationship: fieldsecurityprofile lk_fieldpermission_fieldsecurityprofileid
Property | Value |
---|---|
ReferencedEntity | fieldsecurityprofile |
ReferencedAttribute | fieldsecurityprofileid |
ReferencingAttribute | fieldsecurityprofileid |
ReferencingEntityNavigationPropertyName | fieldsecurityprofileid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
solution_fieldpermission
One-To-Many Relationship: solution solution_fieldpermission
Property | Value |
---|---|
ReferencedEntity | solution |
ReferencedAttribute | solutionid |
ReferencingAttribute | solutionid |
ReferencingEntityNavigationPropertyName | solution_fieldpermission |
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.
FieldPermission_SyncErrors
Many-To-One Relationship: syncerror FieldPermission_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | FieldPermission_SyncErrors |
IsCustomizable | True |
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
fieldpermission