Microsoft Graph · Schema

objectMapping

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
attributeMappings array Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the origi
enabled boolean When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped.
flowTypes object
metadata array Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
name string Human-friendly name of the object mapping.
scope object Defines a filter to be used when deciding whether a given object should be provisioned. For example, you might want to only provision users that are located in the US.
sourceObjectName string Name of the object in the source directory. Must match the object name from the source directory definition.
targetObjectName string Name of the object in target directory. Must match the object name from the target directory definition.
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphobjectmapping-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.objectMapping",
  "title": "objectMapping",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "attributeMappings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.attributeMapping"
      },
      "description": "Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values."
    },
    "enabled": {
      "type": "boolean",
      "description": "When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped."
    },
    "flowTypes": {
      "$ref": "#/components/schemas/microsoft.graph.objectFlowTypes"
    },
    "metadata": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.objectMappingMetadataEntry"
      },
      "description": "Additional extension properties. Unless mentioned explicitly, metadata values should not be changed."
    },
    "name": {
      "type": "string",
      "description": "Human-friendly name of the object mapping.",
      "nullable": true
    },
    "scope": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.filter"
        },
        {
          "type": "object",
          "nullable": true
        }
      ],
      "description": "Defines a filter to be used when deciding whether a given object should be provisioned. For example, you might want to only provision users that are located in the US."
    },
    "sourceObjectName": {
      "type": "string",
      "description": "Name of the object in the source directory. Must match the object name from the source directory definition.",
      "nullable": true
    },
    "targetObjectName": {
      "type": "string",
      "description": "Name of the object in target directory. Must match the object name from the target directory definition.",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}