attributeMapping resource type

Namespace: microsoft.graph

Defines how values for the given target attribute should flow during synchronization.

Properties

Property Type Description
defaultValue String Default value to be used in case the source property was evaluated to null. Optional.
exportMissingReferences Boolean For internal use only.
flowBehavior attributeFlowBehavior Defines when this attribute should be exported to the target directory. Possible values are: FlowWhenChanged and FlowAlways. Default is FlowWhenChanged.
flowType attributeFlowType Defines when this attribute should be updated in the target directory. Possible values are:
  • Always (default)
  • ObjectAddOnly - only when new object is created
  • MultiValueAddOnly - only when the change is adding new values to a multi-valued attribute
  • ValueAddOnly - If there is a current value, only flows "Add" operations; will not flow "Remove" operations
  • AttributeAddOnly - Only propagates changes if no current value exists at all
  • matchingPriority Int32 If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories. The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first. If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left. Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
    source attributeMappingSource Defines how a value should be extracted (or transformed) from the source object.
    targetAttributeName String Name of the attribute on the target object.

    JSON representation

    The following is a JSON representation of the resource.

    {
      "@odata.type": "#microsoft.graph.attributeMapping",
      "defaultValue": "String",
      "exportMissingReferences": "Boolean",
      "flowBehavior": "String",
      "flowType": "String",
      "matchingPriority": "Integer",
      "source": {
        "@odata.type": "microsoft.graph.attributeMappingSource"
      },
      "targetAttributeName": "String"
    }