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

親種別

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

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

ExtlClntAppGlobalOauthSettings コンポーネントは .ecaGlblOauth のサフィックスを持ち、extlClntAppGlobalOauthSets フォルダーに保存されます。

バージョン

ExtlClntAppGlobalOauthSettings コンポーネントは、API バージョン 59.0 以降で利用できます。

特別なアクセスルール

OAuth プラグインへアクセスするには、組織の [設定] で「Allow Access to OAuth Consumer Secrets via Metadata API (Metadata API を介して OAuth のコンシューマーの秘密へのアクセスを許可)」権限が有効になっている必要があります。開発者ロールを持つユーザーがグローバル OAuth 設定を指定するには、「メタデータの外部クライアントアプリケーションのコンシューマーの秘密を表示」ユーザー権限が必要です。

項目

項目名	説明
callbackUrl	項目の型 string 説明 Salesforce が OAuth 時に外部クライアントアプリケーションにコールバックするエンドポイントです。これは OAuth redirect_uri です。
certificate	項目の型 string 説明アプリが証明書を使用する場合は、PEM エンコード証明書文字列。提供されると、JWT ベアラーフローが有効になります。API バージョン 60.0 以降で利用できます。
consumerKey	項目の型 string 説明 Salesforce で識別するためのコンシューマーにより使用される値。OAuth 2.0 では client_id と呼ばれます。
consumerSecret	項目の型 string 説明 consumerKey と組み合わされ、コンシューマーによって Salesforce での識別に使用される値。OAuth 2.0 では client_secret として参照されます。
externalClientApplication	項目の型 string 説明必須。外部クライアントアプリケーションの名前。
idTokenConfig	項目の型 ExternalAppIdTokenConfig 説明 ID トークンの設定。
isClientCredentialsFlowEnabled	項目の型 boolean 説明 `true` に設定すると、OAuth 2.0 クライアントのログイン情報フローが有効になります。API バージョン 60.0 以降で利用できます。
isConsumerSecretOptional	項目の型 boolean 説明 `false` (デフォルト) に設定した場合、OAuth 2.0 Web サーバーフローでアクセストークンを交換する際に、外部アプリケーションのクライアントの秘密が要求されます。`true` に設定した場合、外部アプリケーションのクライアントの秘密は省略可能です。
isDeviceFlowEnabled	項目の型 boolean 説明 `true` に設定すると、外部クライアントアプリケーションは OAuth 2.0 のデバイスフローを使用できます。API バージョン 60.0 以降で利用できます。
isIntrospectAllTokens	項目の型 boolean 説明 `true` に設定した場合、外部アプリケーションは、すべてのアクセスを調査し、すべてのトークンを更新することが許可されます。`false` に設定した場合、外部クライアントアプリケーションで調査できるのは自身のトークンのみです。
isPkceRequired	項目の型 boolean 説明 `true` (デフォルト) に設定すると、OAuth インテグレーションに Proof Key for Code for Exchange (PKCE) が必要になります。`false` に設定した場合は、PKCE は省略可能です。
isRefreshTokenRotationEnabled	項目の型 boolean 説明 `true` に設定すると、更新トークンのローテーションが有効になります。API バージョン 60.0 以降で利用できます。
isSecretRequiredForRefreshToken	項目の型 boolean 説明 `true` (デフォルト) に設定した場合、更新トークンおよびハイブリッド更新トークンフローの認証要求でアプリケーションのクライアントの秘密が要求されます。`false` に設定した場合、アプリケーションが認証要求でクライアントの秘密を送信すると、Salesforce はクライアントの秘密を引き続き検証します。
isSecretRequiredForTokenExchange	項目の型 boolean 説明 `true` に設定すると、トークン交換にアプリのクライアントの秘密が必要になります。API バージョン 60.0 以降で利用できます。
isTokenExchangeEnabled	項目の型 boolean 説明 `true` に設定すると、トークン交換が有効になります。API バージョン 60.0 以降で利用できます。
label	項目の型 string 説明外部クライアントアプリケーショングローバル OAuth 設定の名前。
shouldRotateConsumerKey	項目の型 boolean 説明 `true` に設定すると、OAuth 外部クライアントアプリケーションのコンシューマーキーは、メタデータリリース時に新しく生成されたキーに置き換えられます。セキュリティ維持のために、この項目が `true` に設定されている場合は、deploy コマンドに警告無視属性を含める必要があります。デフォルトは `false` です。
shouldRotateConsumerSecret	項目の型 boolean 説明 `true` に設定すると、OAuth 外部クライアントアプリケーションのコンシューマーの秘密は、メタデータリリース時に新しく生成された秘密に置き換えられます。セキュリティ維持のために、この項目が `true` に設定されている場合は、deploy コマンドに警告無視属性を含める必要があります。デフォルトは `false` です。

ExternalAppIdTokenConfig

ID トークンの属性を決定する設定を表します。

項目名	説明
idTokenAudience	項目の型 string 説明この ID トークンの対象となる利用者。
idTokenIncludeAttributes	項目の型 boolean 説明 ID トークンに属性が含まれているか (`true`) 否か (`false`) を示します。
idTokenIncludeStandardClaims	項目の型 boolean 説明 ID トークンに認証イベントに関する標準要求が含まれているか (`true`)、否か (`false`) を示します。
idTokenValidityInMinutes	項目の型 int 説明 ID トークンの発行後、ID トークンが有効な期間。指定できる値は 1 ～ 720 分です。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<ExtlClntAppGlobalOauthSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <callbackUrl>https://www.example.com</callbackUrl>
4    <externalClientApplication>myeca</externalClientApplication>
5    <idTokenConfig>
6        <idTokenAudience>SalesforceAudience</idTokenAudience>
7        <idTokenIncludeStandardClaims>true</idTokenIncludeStandardClaims>
8        <idTokenValidityInMinutes>0</idTokenValidityInMinutes>
9    </idTokenConfig>
10    <isConsumerSecretOptional>false</isConsumerSecretOptional>
11    <isIntrospectAllTokens>false</isIntrospectAllTokens>
12    <isPkceRequired>true</isPkceRequired>
13    <isSecretRequiredForRefreshToken>false</isSecretRequiredForRefreshToken>
14    <label>myecaglobalset</label>
15    <shouldRotateConsumerKey>false</shouldRotateConsumerKey>
16    <shouldRotateConsumerSecret>false</shouldRotateConsumerSecret>
17</ExtlClntAppGlobalOauthSettings>

この例の 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>ExternalClientApplication</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>ExtlClntAppOauthSettings</name>
10    </types>
11    <types>
12        <members>*</members>
13        <name>ExtlClntAppGlobalOauthSettings</name>
14    </types>
15    <types>
16        <members>*</members>
17        <name>ExtlClntAppOauthConfigurablePolicies</name>
18    </types>
19    <types>
20        <members>*</members>
21        <name>ExtlClntAppConfigurablePolicies</name>
22    </types>
23    <version>60.0</version>
24</Package>

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

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