directoryDefinition resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Provides the synchronization engine information about a directory and its objects. This resource tells the synchronization engine, for example, that the directory has objects named user and group, which attributes are supported for those objects, and the types for those attributes. In order for the object and attribute to participate in synchronization rules and object mappings, they must be defined as part of the directory definition.

In general, the default synchronization schema provided as part of the synchronization template will define most commonly used objects and attributes for that directory. However, if the directory supports the addition of custom attributes, you might want to expand the default definition with your own custom objects or attributes. For more information, see Configure synchronization with custom attributes and Configure synchronization with directory extension attributes.

Directory definitions are updated as part of the synchronization schema.

Methods

Method Return Type Description
Discover directoryDefinition directoryDefinition Discover the schema and supported properties of the directory.

Properties

Property Type Description
id String Directory identifier. Not nullable.
metadata metadataEntry collection Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
name String Name of the directory. Must be unique within the synchronization schema. Not nullable.
objects objectDefinition collection Collection of objects supported by the directory.
version String Read only value that indicates version discovered. Null if discovery has not yet occurred.
discoveryDateTime DateTimeOffset Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
discoverabilities string Read only value indicating what type of discovery the app supports. Possible values are: AttributeDataTypes, AttributeNames, AttributeReadOnly, None, ReferenceAttributes, UnknownFutureValue.

JSON representation

The following is a JSON representation of the resource.

{
  "discoverabilities": "String",
  "discoveryDateTime": "DateTimeOffset",
  "id": "String",
  "metadata": [{"@odata.type": "microsoft.graph.stringKeyStringValuePair"}],
  "name": "String",
  "objects": [{"@odata.type": "microsoft.graph.objectDefinition"}],
  "version": "String"
}