id によるトークン交換プロファイルの部分更新

テナント内のトークン交換プロファイルを更新します。

この機能を使用すると、Okta’s Master Subscription Agreement の該当する Free Trial 条項に同意したものとみなされます。ユーザーの subject_token を安全に検証する責任はお客様にあります。詳細については、User Guide を参照してください。

PATCH https://{tenantDomain}/api/v2/token-exchange-profiles/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateTokenExchangeProfileRequestContent{}
    client.TokenExchangeProfiles.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.tokenExchangeProfiles.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.tokenExchangeProfiles.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/token-exchange-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Token Exchange Profile 1",
  "subject_token_type": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/token-exchange-profiles/{id}"

payload = {
    "name": "Token Exchange Profile 1",
    "subject_token_type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/token-exchange-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' => 'Token Exchange Profile 1',
    'subject_token_type' => '<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;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/token-exchange-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Token Exchange Profile 1\",\n  \"subject_token_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/token-exchange-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\": \"Token Exchange Profile 1\",\n  \"subject_token_type\": \"<string>\"\n}"

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

承認

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 · デフォルト: Token Exchange Profile 1

このプロファイルのフレンドリ名。

Required string length: 3 - 50

subject_token_type · string<url>

このプロファイルのサブジェクトトークンタイプ。Authentication API でトークン交換リクエストを受信すると、一致する subject_token_type を持つ対応するトークン交換プロファイルが実行されます。これは URI である必要があります。

Required string length: 8 - 100

レスポンス

200

トークン交換プロファイルが正常に更新されました。