トークン交換プロファイルを作成

テナント内に新しいトークン交換プロファイルを作成します。

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

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

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.TokenExchangeProfiles.CreateAsync(
            new CreateTokenExchangeProfileRequestContent {
                Name = "name",
                SubjectTokenType = "subject_token_type",
                ActionId = "action_id",
                Type = TokenExchangeProfileTypeEnum.CustomAuthentication
            }
        );
    }

}

201

{
  "action_id": "<string>",
  "created_at": "2024-01-01T00:00:00.000Z",
  "id": "<string>",
  "name": "Token Exchange Profile 1",
  "subject_token_type": "<string>",
  "type": "custom_authentication",
  "updated_at": "2024-01-01T00:00:00.000Z"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

action_id · string · 必須

subject_tokenを検証するために、このプロファイルに対して実行するカスタムトークン交換ActionのID。Actionはcustom-token-exchangeトリガーを使用する必要があります。

Required string length: 1 - 36

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

type · enum<string> · 必須

このプロファイルの種別。トークン交換リクエストを受信した際に、プロファイルをどのように実行するかを制御します。

利用可能なオプション: custom_authentication

Required string length: 1 - 21

レスポンス

201

application/json

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

action_id · string

subject_tokenを検証するために、このプロファイルに対して実行するカスタムトークン交換ActionのID。Actionはcustom-token-exchangeトリガーを使用する必要があります。

Required string length: 1 - 36

created_at · string<date-time> · デフォルト: 2024-01-01T00:00:00.000Z

このプロファイルが作成された日時。

id · string<token-exchange-profile-id>

トークン交換プロファイルの一意のID。

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

type · enum<string>

このプロファイルの種別。トークン交換リクエストを受信した際に、プロファイルをどのように実行するかを制御します。

利用可能なオプション: custom_authentication

Required string length: 1 - 21

updated_at · string<date-time> · デフォルト: 2024-01-01T00:00:00.000Z

このプロファイルが更新された日時。