ID を指定してユーザー属性プロファイルを部分更新

name、user_id、user_attributes など、特定のユーザー属性プロファイルの詳細を更新します。

PATCH https://{tenantDomain}/api/v2/user-attribute-profiles/{id}

ユーザー属性プロファイルを更新

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/user-attribute-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "user_attributes": {},
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/user-attribute-profiles/{id}"

payload = {
    "name": "<string>",
    "user_attributes": {},
    "user_id": {
        "oidc_mapping": "sub",
        "saml_mapping": ["<string>"],
        "scim_mapping": "<string>",
        "strategy_overrides": {
            "ad": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "adfs": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "google-apps": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "oidc": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "okta": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "pingfederate": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "samlp": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            },
            "waad": {
                "saml_mapping": ["<string>"],
                "scim_mapping": "<string>"
            }
        }
    }
}
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({
    name: '<string>',
    user_attributes: {},
    user_id: {
      oidc_mapping: 'sub',
      saml_mapping: ['<string>'],
      scim_mapping: '<string>',
      strategy_overrides: {
        ad: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        adfs: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        'google-apps': {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        oidc: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        okta: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        pingfederate: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        samlp: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        waad: {saml_mapping: ['<string>'], scim_mapping: '<string>'}
      }
    }
  })
};

fetch('https://{tenantDomain}/api/v2/user-attribute-profiles/{id}', 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/user-attribute-profiles/{id}",
  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([
    'name' => '<string>',
    'user_attributes' => [
        
    ],
    'user_id' => [
        'oidc_mapping' => 'sub',
        'saml_mapping' => [
                '<string>'
        ],
        'scim_mapping' => '<string>',
        'strategy_overrides' => [
                'ad' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'adfs' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'google-apps' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'oidc' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'okta' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'pingfederate' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'samlp' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ],
                'waad' => [
                                'saml_mapping' => [
                                                                '<string>'
                                ],
                                'scim_mapping' => '<string>'
                ]
        ]
    ]
  ]),
  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/user-attribute-profiles/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"user_attributes\": {},\n  \"user_id\": {\n    \"oidc_mapping\": \"sub\",\n    \"saml_mapping\": [\n      \"<string>\"\n    ],\n    \"scim_mapping\": \"<string>\",\n    \"strategy_overrides\": {\n      \"ad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"adfs\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"google-apps\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"oidc\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"okta\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"pingfederate\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"samlp\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"waad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      }\n    }\n  }\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/user-attribute-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"user_attributes\": {},\n  \"user_id\": {\n    \"oidc_mapping\": \"sub\",\n    \"saml_mapping\": [\n      \"<string>\"\n    ],\n    \"scim_mapping\": \"<string>\",\n    \"strategy_overrides\": {\n      \"ad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"adfs\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"google-apps\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"oidc\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"okta\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"pingfederate\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"samlp\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"waad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/user-attribute-profiles/{id}")

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  \"name\": \"<string>\",\n  \"user_attributes\": {},\n  \"user_id\": {\n    \"oidc_mapping\": \"sub\",\n    \"saml_mapping\": [\n      \"<string>\"\n    ],\n    \"scim_mapping\": \"<string>\",\n    \"strategy_overrides\": {\n      \"ad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"adfs\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"google-apps\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"oidc\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"okta\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"pingfederate\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"samlp\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"waad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      }\n    }\n  }\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "user_attributes": {},
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<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

name · string

ユーザー属性プロファイルの名前。

Required string length: 1 - 128

user_attributes · object

ユーザー属性の設定マップ。キーは属性名、値は各属性のマッピング設定です。

Show child attributes

user_id · object | null

ユーザー ID のマッピング設定

Show child attributes

レスポンス

200

application/json

ユーザー属性プロファイルが正常に更新されました。

id · string<user-attribute-profile-id>

ユーザー属性プロファイルの識別子。

name · string

ユーザー属性プロファイルの名前。

Required string length: 1 - 128

user_attributes · object

ユーザー属性の設定マップ。キーは属性名、値は各属性のマッピング設定です。

Show child attributes

user_id · object

ユーザー ID のマッピング設定

Show child attributes