組織IDプロバイダーの属性を更新

IDプロバイダーの属性マッピングを更新

curl --request PUT \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/update-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/update-attributes', 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}/update-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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}/update-attributes"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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.put("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/update-attributes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "access_level": "readonly",
  "assign_membership_on_login": false,
  "attributes": [
    {
      "description": "優先ユーザー名",
      "is_extra": false,
      "is_missing": false,
      "is_required": true,
      "label": "Preferred username",
      "sso_field": [
        "userName"
      ],
      "user_attribute": "preferred_username"
    },
    {
      "is_extra": true,
      "is_missing": false,
      "is_required": true,
      "sso_field": [
        "externalId"
      ],
      "user_attribute": "external_id"
    }
  ],
  "display_name": "OIDC IdP",
  "domains": [
    "mydomain.com"
  ],
  "id": "con_zW1UHutvkVWSWdCC",
  "is_enabled": true,
  "name": "oidcIdp",
  "options": {
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration",
    "type": "front_channel"
  },
  "show_as_button": true,
  "strategy": "oidc"
}

PUT

identity-providers

{idp_id}

update-attributes

IDプロバイダーの属性マッピングを更新

curl --request PUT \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/update-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/update-attributes', 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}/update-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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}/update-attributes"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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.put("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/update-attributes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "access_level": "readonly",
  "assign_membership_on_login": false,
  "attributes": [
    {
      "description": "優先ユーザー名",
      "is_extra": false,
      "is_missing": false,
      "is_required": true,
      "label": "Preferred username",
      "sso_field": [
        "userName"
      ],
      "user_attribute": "preferred_username"
    },
    {
      "is_extra": true,
      "is_missing": false,
      "is_required": true,
      "sso_field": [
        "externalId"
      ],
      "user_attribute": "external_id"
    }
  ],
  "display_name": "OIDC IdP",
  "domains": [
    "mydomain.com"
  ],
  "id": "con_zW1UHutvkVWSWdCC",
  "is_enabled": true,
  "name": "oidcIdp",
  "options": {
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration",
    "type": "front_channel"
  },
  "show_as_button": true,
  "strategy": "oidc"
}

承認

Authorization

string

header

必須

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

パスパラメータ

idp_id

string

必須

read-only

IDプロバイダーの識別子。

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

ボディ

application/json

The body is of type object.

レスポンス

アイデンティティプロバイダーが正常に取得されました。

IDプロバイダー固有のオプション。

strategy

enum<string>

必須

アイデンティティプロバイダーの種類

利用可能なオプション:

adfs,

google-apps,

oidc,

okta,

pingfederate,

samlp,

waad

Allowed value: "adfs"

options

adfs_server · object

必須

IDプロバイダー固有のオプション。

adfs_server
fedMetadataXml

Show child attributes

access_level

enum<string>

read-only

組織に許可されるアクセスレベル

利用可能なオプション:

none,

readonly,

limited,

full

true の場合、ユーザーはログイン時に組織のメンバーになります。

display_name

string

ログイン画面で使用されるIDプロバイダー名。

Required string length: 1 - 128

domains

string[]

ホームレルムディスカバリー（HRD）用ドメインの一覧

string

read-only

IDプロバイダーの識別子。

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

is_enabled

boolean

アイデンティティプロバイダーが組織に対して有効な場合は true。

name

string | null

アイデンティティプロバイダーの名前

Maximum string length: 128

show_as_button

boolean

ログインページにこの接続のボタンを表示できるようにします（新しいエクスペリエンスのみ）。false の場合は、ホームレルムディスカバリー（HRD）でのみ使用できます。