ディレクトリ プロビジョニングを更新

接続のディレクトリプロビジョニング設定を更新します。

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

ディレクトリのプロビジョニング設定を部分更新する

cURL

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
}
'

import requests

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

payload = {
    "mapping": [
        {
            "auth0": "<string>",
            "idp": "<string>"
        }
    ],
    "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: '<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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/connections/{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' => '<string>',
                'idp' => '<string>'
        ]
    ],
    '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}/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))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mapping\": [\n    {\n      \"auth0\": \"<string>\",\n      \"idp\": \"<string>\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/connections/{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\": \"<string>\",\n      \"idp\": \"<string>\"\n    }\n  ],\n  \"synchronize_automatically\": true\n}"

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

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

ディレクトリプロビジョニング設定を作成する接続の id

ボディ

application/jsonapplication/x-www-form-urlencoded

mapping · object[]

Auth0 と IdP のユーザー属性のマッピング

Minimum array length: 1

Show child attributes

synchronize_automatically · boolean

定期的な自動同期が有効かどうか

synchronize_groups · enum<string> · GA

グループ同期設定

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

レスポンス

200

application/json

接続のディレクトリプロビジョニング設定が更新されました。スキーマについては Response Schemas を参照してください。

connection_id · string · 必須

接続の識別子

connection_name · string · 必須

接続の名前

created_at · string<date-time> · 必須

ディレクトリのプロビジョニング構成が作成されたタイムスタンプ

mapping · object[] · 必須

Auth0 と IdP のユーザー属性のマッピング

Minimum array length: 1

Show child attributes

strategy · string · 必須

接続のストラテジー

synchronize_automatically · boolean · 必須

定期的な自動同期が有効かどうか

updated_at · string<date-time> · 必須

ディレクトリのプロビジョニング構成が最後に更新されたタイムスタンプ

last_synchronization_at · string<date-time>

接続が最後に同期されたタイムスタンプ

last_synchronization_error · string

最後の同期のエラーメッセージ（存在する場合）

last_synchronization_status · string

最後の同期のステータス

synchronize_groups · enum<string> · GA

グループ同期設定

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