fieldpermission EntityType

Group of privileges used to categorize users to provide appropriate access to secured columns.

Entity Set Path
[organization URI]/api/data/v9.2/fieldpermissions
Base Type
crmbaseentity
Display Name
Field Permission
Primary Key
fieldpermissionid
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
attributelogicalname Edm.String

Attribute Name.

Display Name: Name of the attribute for which this privilege is defined

cancreate Edm.Int32

Can this Profile create the attribute

Display Name: Can create the attribute

Default Options
Values Label
0 Not Allowed
4 Allowed
canread Edm.Int32

Can this Profile read the attribute

Display Name: Can Read the attribute

Default Options
Values Label
0 Not Allowed
4 Allowed
canreadunmasked Edm.Int32

Display Name: Can this profile read unmasked value of attribute

Default Options
Values Label
0 Not Allowed
1 One Record
3 All Records
canupdate Edm.Int32

Can this Profile update the attribute

Display Name: Can Update the attribute

Default Options
Values Label
0 Not Allowed
4 Allowed
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
entityname Edm.String

Entity name.

Display Name: Name of the Entity for which this privilege is defined

fieldpermissionid Edm.Guid

Unique identifier of the Field Permission.

Display Name: Field Permission

fieldpermissionidunique Edm.Guid

For internal use only.

Display Name: Field Permission

Read Only
ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
versionnumber Edm.Int64
Read Only

Lookup Properties

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 Lookup property data.

Name Single-valued navigation property Description
_fieldsecurityprofileid_value fieldsecurityprofileid

Unique identifier of profile to which this privilege belongs.

Single-valued navigation properties

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
fieldsecurityprofileid fieldsecurityprofile lk_fieldpermission_fieldsecurityprofileid
solution_fieldpermission solution solution_fieldpermission

Collection-valued navigation properties

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
FieldPermission_SyncErrors syncerror regardingobjectid_fieldpermission_syncerror

See also