synchronization 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. To determine whether an API is available in v1.0, use the Version selector.

Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. Identity synchronization (also called provisioning) allows you to automate the provisioning (creation, maintenance) and de-provisioning (removal) of user identities and roles from Microsoft Entra ID to supported cloud applications. For more information, see How Application Provisioning works in Microsoft Entra ID

Methods

Method	Return type	Description
acquireAccessToken	None	Acquire an OAuth Access token to authorize the Microsoft Entra provisioning service to provision users into an application.
Add secrets	None	Provide credentials for establishing connectivity with the target system.

Properties

Property	Type	Description
secrets	synchronizationSecretKeyStringValuePair collection	Represents a collection of credentials to access provisioned cloud applications.

Relationships

Relationship	Type	Description
jobs	synchronizationJob collection	Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
templates	synchronizationTemplate collection	Pre-configured synchronization settings for a particular application.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.synchronization",
  "version": "String",
  "secrets": [
    {
      "@odata.type": "microsoft.graph.synchronizationSecretKeyStringValuePair"
    }
  ]
}