Skip to main content

Entity Type Mapping

An entity type mapping links a given Entity Type's properties with the source columns of the corresponding managed system. The entity type mapping specifies the related Connector and the path to the CSV source file which contains, or will contain, the data exported from the managed system. Each of its Entity Type Mapping properties will define the corresponding source column and specific options.

An entity type mapping shares the same identifier as its related entity type.

See the example of a whole Connector containing an entity type mapping.

Properties

PropertyDetails
C0 optionalType String Description In a Microsoft Entra ID connector (formerly Microsoft Azure AD), generic column used to map the entities to be exported. By default, Identity Manager exports: user; group; directoryRole; servicePrincipal.
ConnectionTable optionalType String Description Name of the CSV file which contains, or will contain, the exported data from the corresponding entity type.
Connector optionalType Int64 Description Identifier of the related connector.
MaximumDeletedLines default value: 0Type Int32 Description Deleted lines threshold. Sets the maximum number of resources that can be removed from the entity type when running the synchronization job.
MaximumInsertedLines default value: 0Type Int32 Description Inserted lines threshold. Sets the maximum number of resources that can be added into the entity type when running the synchronization job.
MaximumUpdatedLines default value: 0Type Int32 Description Updated lines threshold. Sets the maximum number of resources that can be modified within the entity type when running the synchronization job.
MaxPercentageDeletedLines default value: 0Type Int32 Description Deleted lines threshold in percent.
MaxPercentageInsertedLines default value: 0Type Int32 Description Inserted lines threshold in percent.
MaxPercentageUpdatedLines default value: 0Type Int32 Description Updated lines threshold in percent.

Child Element: Property

Contains all the Entity Type properties that can be synchronized into Identity Manager physical model. Each mapping share the same id as its corresponding property in the entity type.

Properties

PropertyDetails
ConnectionColumn optionalType String Description Specifies the corresponding column in the entity type data source.
Format optionalType String Description The format of the attribute in the external system. Ex: 1601date for LDAP Date.
IsPrimaryKey default value: falseType Boolean Description true if the property is designated to be the unique and immutable key that uniquely identifies any resource from the entity type, during synchronization. Each entity type mapping must have a primary key. It prevents duplicates and null resources.
IsUniqueKey default value: falseType Boolean Description true if the property is designated to be one of the unique keys that uniquely identify any resource from the entity type in an association/navigation, during synchronization. Each entity type mapping can have up to three unique keys, in addition to the mapping key that already acts as such. Note: AD synchronization requires the dn property to have either IsUniqueKey or EntityType > Property > IsKey set to true (key property in the UI).