extensionProperty resource type

Important

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

Represents a directory extension that can be used to add a custom property to directory objects without requiring an external data store. For example, if an organization has a line of business (LOB) application that requires a Skype ID for each user in the directory, Microsoft Graph can be used to register a new property named skypeId on the directory’s User object, and then write a value to the new property for a specific user.

Extensions can be added to user, group, organization, device, application resources.

Important

Azure AD schema extensions described here are available in Microsoft Graph for backwards compatibility reasons only. It allows you to use Microsoft Graph to continue to manage extension properties added through Azure AD Graph or Azure AD Connect. For new custom extensions, we recommend that you use Microsoft Graph schema extensions for adding custom data to resources.

Methods

Method Return Type Description
List extensions extensionProperty collection List extension properties on an application object.
Create extension extensionProperty Create an extension property on an application object.
Delete extension None Delete an extension property from an application object.

Properties

Property Type Description
appDisplayName String Display name of the application object on which this extension property is defined. Read-only.
dataType String Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable.
  • Binary - 256 bytes maximum
  • Boolean
  • DateTime - Must be specified in ISO 8601 format. Will be stored in UTC.
  • Integer - 32-bit value.
  • LargeInteger - 64-bit value.
  • String - 256 characters maximum
isSyncedFromOnPremises Boolean Indicates if this extension property was sycned from onpremises directory using Azure AD Connect. Read-only.
name String Name of the extension property. Not nullable.
targetObjects String collection Following values are supported. Not nullable.
  • User
  • Group
  • Organization
  • Device
  • Application

Relationships

None

JSON representation

The following is a JSON representation of the resource.

{
  "appDisplayName": "String",
  "dataType": "String",
  "isSyncedFromOnPremises": true,
  "name": "String",
  "targetObjects": ["String"]
}