Update a Directory Provisioning Configuration

curl --request PATCH \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapping": [
    {
      "auth0": "email",
      "idp": "primaryEmail"
    },
    {
      "auth0": "given_name",
      "idp": "name.givenName"
    },
    {
      "auth0": "family_name",
      "idp": "name.familyName"
    }
  ],
  "synchronize_automatically": true
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning"

payload = {
    "mapping": [
        {
            "auth0": "email",
            "idp": "primaryEmail"
        },
        {
            "auth0": "given_name",
            "idp": "name.givenName"
        },
        {
            "auth0": "family_name",
            "idp": "name.familyName"
        }
    ],
    "synchronize_automatically": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mapping: [
      {auth0: 'email', idp: 'primaryEmail'},
      {auth0: 'given_name', idp: 'name.givenName'},
      {auth0: 'family_name', idp: 'name.familyName'}
    ],
    synchronize_automatically: true
  })
};

fetch('https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning', 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}/my-org/v1/identity-providers/{idp_id}/directory-provisioning",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'mapping' => [
        [
                'auth0' => 'email',
                'idp' => 'primaryEmail'
        ],
        [
                'auth0' => 'given_name',
                'idp' => 'name.givenName'
        ],
        [
                'auth0' => 'family_name',
                'idp' => 'name.familyName'
        ]
    ],
    'synchronize_automatically' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning"

	payload := strings.NewReader("{\n  \"mapping\": [\n    {\n      \"auth0\": \"email\",\n      \"idp\": \"primaryEmail\"\n    },\n    {\n      \"auth0\": \"given_name\",\n      \"idp\": \"name.givenName\"\n    },\n    {\n      \"auth0\": \"family_name\",\n      \"idp\": \"name.familyName\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mapping\": [\n    {\n      \"auth0\": \"email\",\n      \"idp\": \"primaryEmail\"\n    },\n    {\n      \"auth0\": \"given_name\",\n      \"idp\": \"name.givenName\"\n    },\n    {\n      \"auth0\": \"family_name\",\n      \"idp\": \"name.familyName\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mapping\": [\n    {\n      \"auth0\": \"email\",\n      \"idp\": \"primaryEmail\"\n    },\n    {\n      \"auth0\": \"given_name\",\n      \"idp\": \"name.givenName\"\n    },\n    {\n      \"auth0\": \"family_name\",\n      \"idp\": \"name.familyName\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}"

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

{
  "connection_id": "con_a1B2c3D4e5F6g7H8",
  "connection_name": "google-workspace-acme",
  "strategy": "google-apps",
  "mapping": [
    {
      "auth0": "email",
      "idp": "primaryEmail"
    },
    {
      "auth0": "given_name",
      "idp": "name.givenName"
    },
    {
      "auth0": "family_name",
      "idp": "name.familyName"
    }
  ],
  "synchronize_automatically": true,
  "synchronize_groups": "selected",
  "status": "complete",
  "created_at": "2026-08-01T10:15:30.000Z",
  "updated_at": "2026-09-08T09:10:00.000Z",
  "last_synchronization_at": "2026-09-07T02:00:00.000Z",
  "last_synchronization_status": "completed"
}

PATCH

identity-providers

{idp_id}

directory-provisioning

Update a Directory Provisioning Configuration

curl --request PATCH \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapping": [
    {
      "auth0": "email",
      "idp": "primaryEmail"
    },
    {
      "auth0": "given_name",
      "idp": "name.givenName"
    },
    {
      "auth0": "family_name",
      "idp": "name.familyName"
    }
  ],
  "synchronize_automatically": true
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning"

payload = {
    "mapping": [
        {
            "auth0": "email",
            "idp": "primaryEmail"
        },
        {
            "auth0": "given_name",
            "idp": "name.givenName"
        },
        {
            "auth0": "family_name",
            "idp": "name.familyName"
        }
    ],
    "synchronize_automatically": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mapping: [
      {auth0: 'email', idp: 'primaryEmail'},
      {auth0: 'given_name', idp: 'name.givenName'},
      {auth0: 'family_name', idp: 'name.familyName'}
    ],
    synchronize_automatically: true
  })
};

fetch('https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning', 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}/my-org/v1/identity-providers/{idp_id}/directory-provisioning",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'mapping' => [
        [
                'auth0' => 'email',
                'idp' => 'primaryEmail'
        ],
        [
                'auth0' => 'given_name',
                'idp' => 'name.givenName'
        ],
        [
                'auth0' => 'family_name',
                'idp' => 'name.familyName'
        ]
    ],
    'synchronize_automatically' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning"

	payload := strings.NewReader("{\n  \"mapping\": [\n    {\n      \"auth0\": \"email\",\n      \"idp\": \"primaryEmail\"\n    },\n    {\n      \"auth0\": \"given_name\",\n      \"idp\": \"name.givenName\"\n    },\n    {\n      \"auth0\": \"family_name\",\n      \"idp\": \"name.familyName\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mapping\": [\n    {\n      \"auth0\": \"email\",\n      \"idp\": \"primaryEmail\"\n    },\n    {\n      \"auth0\": \"given_name\",\n      \"idp\": \"name.givenName\"\n    },\n    {\n      \"auth0\": \"family_name\",\n      \"idp\": \"name.familyName\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/directory-provisioning")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mapping\": [\n    {\n      \"auth0\": \"email\",\n      \"idp\": \"primaryEmail\"\n    },\n    {\n      \"auth0\": \"given_name\",\n      \"idp\": \"name.givenName\"\n    },\n    {\n      \"auth0\": \"family_name\",\n      \"idp\": \"name.familyName\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}"

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

{
  "connection_id": "con_a1B2c3D4e5F6g7H8",
  "connection_name": "google-workspace-acme",
  "strategy": "google-apps",
  "mapping": [
    {
      "auth0": "email",
      "idp": "primaryEmail"
    },
    {
      "auth0": "given_name",
      "idp": "name.givenName"
    },
    {
      "auth0": "family_name",
      "idp": "name.familyName"
    }
  ],
  "synchronize_automatically": true,
  "synchronize_groups": "selected",
  "status": "complete",
  "created_at": "2026-08-01T10:15:30.000Z",
  "updated_at": "2026-09-08T09:10:00.000Z",
  "last_synchronization_at": "2026-09-07T02:00:00.000Z",
  "last_synchronization_status": "completed"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

idp_id

string

required

read-only

Identity provider identifier.

Pattern: ^con_[A-Za-z0-9]{16}$

Body

application/json

Fields to update on the Directory Provisioning Configuration. All fields are optional; the body may also be null.

mapping

object[]

The Auth0 ↔ IdP attribute mapping used for provisioning.

Required array length: 1 - 100 elements

Show child attributes

synchronize_automatically

boolean

Enable or disable periodic automatic synchronization.

Response

Directory provisioning configuration successfully updated.

connection_id

string

required

Identifier of the connection backing this Identity Provider.

connection_name

string

required

Name of the connection backing this Identity Provider.

strategy

enum<string>

required

The type of the identity provider

Available options:

adfs,

google-apps,

oidc,

okta,

pingfederate,

samlp,

waad

mapping

object[]

required

The Auth0 ↔ IdP attribute mapping used for provisioning.

Required array length: 1 - 100 elements

Show child attributes

synchronize_automatically

boolean

required

Whether periodic automatic synchronization is enabled.

status

enum<string>

required

Whether directory provisioning is fully active. incomplete: the configuration exists but automatic synchronization is disabled. complete: the configuration exists and automatic synchronization is enabled.

Available options:

incomplete,

complete

created_at

string<date-time>

required

When the configuration was created.

updated_at

string<date-time>

required

When the configuration was last updated.

synchronize_groups

enum<string>

Group synchronization mode. all: synchronize all groups. off: do not synchronize groups. selected: synchronize only selected groups.

Available options:

all,

off,

selected

last_synchronization_at

string<date-time>

When the last synchronization ran.

last_synchronization_status

string

The status of the most recent synchronization, passed through from the provisioning service. Currently reported as completed (last sync finished successfully) or failed (see last_synchronization_error). Omitted when the directory has never been synchronized.

last_synchronization_error

string

Error from the last synchronization, if any.