Patch a directory provisioning configuration

Update the directory provisioning configuration of a connection.

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

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.UpdateAsync(
            id: "id",
            request: new UpdateDirectoryProvisioningRequestContent()
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import java.util.Optional;

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

        client.connections().directoryProvisioning().update(
            "id",
            Optional.empty()
        );
    }
}

<?php

namespace Example;

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

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->directoryProvisioning->update(
    'id',
    new UpdateDirectoryProvisioningRequestContent([]),
);

from auth0.management import ManagementClient, UpdateDirectoryProvisioningRequestContent

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

client.connections.directory_provisioning.update(
    id="id",
    request=UpdateDirectoryProvisioningRequestContent(),
)

require "auth0"

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

client.connections.directory_provisioning.update(
  id: "id",
  request: {}
)

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapping": [
    {
      "auth0": "<string>",
      "idp": "<string>"
    }
  ],
  "synchronize_automatically": true
}
'

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

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"mapping\": [\n    {\n      \"auth0\": \"<string>\",\n      \"idp\": \"<string>\"\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))

}

200

{
  "connection_id": "<string>",
  "connection_name": "<string>",
  "strategy": "<string>",
  "mapping": [
    {
      "auth0": "<string>",
      "idp": "<string>"
    }
  ],
  "synchronize_automatically": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_synchronization_at": "2023-11-07T05:31:56Z",
  "last_synchronization_status": "<string>",
  "last_synchronization_error": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

The id of the connection to create its directory provisioning configuration

ボディ

application/jsonapplication/x-www-form-urlencoded

mapping · object[]

The mapping between Auth0 and IDP user attributes

Minimum array length: 1

Show child attributes

synchronize_automatically · boolean

Whether periodic automatic synchronization is enabled

synchronize_groups · enum<string> · GA

Group synchronization configuration

利用可能なオプション: all, off, selected

レスポンス

200

application/json

The connection's directory provisioning configuration was updated. See Response Schemas for schema.

connection_id · string · 必須

The connection's identifier

connection_name · string · 必須

The connection's name

strategy · string · 必須

The connection's strategy

mapping · object[] · 必須

The mapping between Auth0 and IDP user attributes

Minimum array length: 1

Show child attributes

synchronize_automatically · boolean · 必須

Whether periodic automatic synchronization is enabled

created_at · string<date-time> · 必須

The timestamp at which the directory provisioning configuration was created

updated_at · string<date-time> · 必須

The timestamp at which the directory provisioning configuration was last updated

synchronize_groups · enum<string> · GA

Group synchronization configuration

利用可能なオプション: all, off, selected

last_synchronization_at · string<date-time>

The timestamp at which the connection was last synchronized

last_synchronization_status · string

The status of the last synchronization

last_synchronization_error · string

The error message of the last synchronization, if any