Create synchronizationTemplate

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.

Create a new synchronization template for a given application.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Directory.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Application.ReadWrite.OwnedBy, Directory.ReadWrite.All

HTTP Request

POST /applications/{id}/synchronization/templates/

Request headers

Name Type Description
Authorization string Bearer {token}. Required.

Request body

In the request body, supply the synchronizationTemplate object to be created. The id, applicationId and factoryTag properties are required. When no schema is provided with the template, the default schema associated with the factoryTag property will be used.

Response

If successful, this method returns a 201 Created response code and a synchronizationTemplate object in the response body.

Example

Request

The following is an example of a request.

POST https://graph.microsoft.com/beta/applications/{id}/synchronization/templates
Content-type: application/json

{ 
    "id": "SCIM-Test1",
    "applicationId": "{id}",
    "factoryTag": "CustomSCIM"
}
Response

The following is an example of a response.

Note: The response object shown here might be shortened for readability. All the properties will be returned in an actual call.

HTTP/1.1 201 Created

{
    "id": "SCIM-Test1",
    "applicationId": "{id}",
    "factoryTag": "CustomSCIM",
    "schema": {
        "directories": [],
        "synchronizationRules": []
    }
}