この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

OauthTokenExchangeHandler

トークン交換ハンドラーを表します。トークン交換ハンドラーも Apex クラスで構成されています。OAuth 2.0 のトークン交換フローでは、トークン交換ハンドラーを使用して、外部の ID プロバイダからのトークンを検証してユーザーを Salesforce にマッピングします。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

OauthTokenExchangeHandler コンポーネントのサフィックスは .oauthtokenexchangehandler で、oauthtokenexchangehandlers フォルダーに保存されます。

バージョン

OauthTokenExchangeHandler コンポーネントは、API バージョン 60.0 以降で使用できます。

特別なアクセスルール

この種別に固有のアクセス要件は他にありません。

項目

項目名	説明
description	項目の型 string 説明必須。トークン交換ハンドラーの説明。
developerName	項目の型 string 説明必須。ハンドラーの API 名。
enablements	項目の型 OauthTokenExchHandlerApp[] 説明 Apex クラスを実行する実行ユーザー、有効になっている接続アプリケーションまたは外部クライアントアプリケーション、デフォルトのハンドラーかどうかなど、トークン交換ハンドラーのイネーブルメント設定。
isAccessTokenSupported	項目の型 boolean 説明必須。不透明アクセストークンや JSON Web トークン (JWT) ベースのアクセストークンを含む、ID プロバイダからの OAuth 2.0 アクセストークンをハンドラーがサポートしているかどうかを示します。
isEnabled	項目の型 boolean 説明必須。ハンドラーが有効かどうかを示します。イネーブルメントを完了するには、イネーブルメント設定を指定する `イネーブルメント`項目を追加します。
isIdTokenSupported	項目の型 boolean 説明必須。ハンドラーが ID プロバイダからの OpenID Connect ID トークンをサポートしているかどうかを示します。
isJwtSupported	項目の型 boolean 説明必須。JWT ベースのアクセストークンなど、JWT 形式の ID プロバイダからのトークンをハンドラーがサポートするかどうかを示します。
isProtected	項目の型 boolean 説明ハンドラーが登録者の組織で作成されたコンポーネントからリンクを設定されたり参照されたりできるかどうかを示します。「管理パッケージの保護コンポーネント」を参照してください。
isRefreshTokenSupported	項目の型 boolean 説明必須。ハンドラーが ID プロバイダからの OAuth 2.0 更新トークンをサポートしているかどうかを示します。
isSaml2Supported	項目の型 boolean 説明必須。ハンドラーが ID プロバイダからの SAML 2.0 アサーションをサポートしているかどうかを示します。
isUserCreationAllowed	項目の型 boolean 説明必須。ハンドラーが新規ユーザーを設定できるかどうかを示します。トークン交換フローでは、Apex ハンドラーが ID プロバイダから Salesforce にユーザーをマッピングします。isUserCreationAllowed 項目が `true`、`getUserForTokenSubject` メソッドの `canCreateUser` ブール値が `true` で、Salesforce にユーザーが存在しない場合、ハンドラーは新しいユーザーオブジェクトをセットアップします。Salesforce がユーザーオブジェクトを自動的に挿入してユーザーの作成を完了します。
masterLabel	項目の型 string 説明必須。トークン交換ハンドラーレコードのラベル。
tokenHandlerApex	項目の型 string 説明必須。トークン交換ハンドラーに関連付けられている Apex クラス。このクラスには、トークンを検証し、ユーザーを Salesforce にマッピングするメソッドが含まれています。`Oauth2TokenExchangeHandler` Apex クラスを拡張する必要があります。

OauthTokenExchHandlerApp

トークン交換ハンドラーが有効になっている、特定の Salesforce 接続アプリケーションまたは外部クライアントアプリケーションの設定を表します。ハンドラーは複数のアプリケーションに対して有効にできます。

項目名	説明
apexExecutionUser	項目の型 string 説明必須。Apex トークン交換ハン��ラーを実行するユーザー。インテグレーションユーザーを使用することをお勧めします。
connectedApp	項目の型 string 説明 Salesforce との統合に使用する接続アプリケーションの API 名。
externalClientApp	項目の型 string 説明 Salesforce との統合に使用する外部クライアントアプリケーションの API 名。
isDefault	項目の型 boolean 説明必須。トークン交換ハンドラーがこのアプリケーションのデフォルトハンドラーであるかどうかを示します。トークン交換フロー中、トークン要求の中で、特定のハンドラーの Apex クラスの名前を `token_handler` パラメーターに含めることもできます。このパラメーターを含めない場合、Salesforce はデフォルトのハンドラーを使用します。

宣言的なメタデータの定義のサンプル

OauthTokenExchangeHandler コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<OauthTokenExchangeHandler xmlns="http://soap.sforce.com/2006/04/metadata">
3    <developerName>MyTokenExchangeHandler</developerName>
4    <description>My token exchange handler</description>
5    <isAccessTokenSupported>true</isAccessTokenSupported>
6    <isEnabled>true</isEnabled>
7    <isIdTokenSupported>false</isIdTokenSupported>
8    <isJwtSupported>true</isJwtSupported>
9    <isProtected>false</isProtected>
10    <isRefreshTokenSupported>false</isRefreshTokenSupported>
11    <isSaml2Supported>false</isSaml2Supported>
12    <isUserCreationAllowed>true</isUserCreationAllowed>
13    <masterLabel>MyTokenExchangeHandler</masterLabel>
14    <tokenHandlerApex>MyOauthTokenExchangeHandler</tokenHandlerApex>
15    <enablements>
16        <apexExecutionUser>integrationuser@mycompany.com</apexExecutionUser>
17        <connectedApp>TokenExchangeApp1</conectedApp>
18        <isDefault>true</isDefault>
19    </enablements>
20</OauthTokenExchangeHandler>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>OauthTokenExchangeHandler</name>
6    </types>
7    <version>60.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド