| title | synchronization resource type |
|---|---|
| description | Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. |
| author | ArvindHarinder1 |
| ms.localizationpriority | medium |
| ms.subservice | entra-applications |
| doc_type | resourcePageType |
| ms.date | 07/22/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
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
| Method | Return type | Description |
|---|---|---|
| Acquire access token | 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. |
| Property | Type | Description |
|---|---|---|
| secrets | synchronizationSecretKeyStringValuePair collection | Represents a collection of credentials to access provisioned cloud applications. |
| 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. |
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.synchronization",
"secrets": [
{
"@odata.type": "microsoft.graph.synchronizationSecretKeyStringValuePair"
}
]
}