Request an on-demand synchronization of the directory

Request an on-demand synchronization of the directory.

POST https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations

Request an on-demand synchronization of the directory

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning/synchronizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

201

{
  "connection_id": "<string>",
  "synchronization_id": "<string>",
  "status": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

The id of the connection to trigger synchronization for

Réponse

201

application/json

The directory synchronization was triggered. See Response Schemas for schema.

connection_id · string · requis

The connection's identifier

synchronization_id · string · requis

The synchronization's identifier

status · string · requis

The synchronization status