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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Connections.DirectoryProvisioning.Synchronizations.CreateAsync(
            "id"
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.connections().directoryProvisioning().synchronizations().create("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->directoryProvisioning->synchronizations->create(
    'id',
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.connections.directory_provisioning.synchronizations.create(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.connections.directory_provisioning.synchronizations.create(id: "id")

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

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));

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))

}

201

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

The id of the connection to trigger synchronization for

Response

201

application/json

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

connection_id · string · required

The connection's identifier

synchronization_id · string · required

The synchronization's identifier

status · string · required

The synchronization status