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

親種別

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

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

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

バージョン

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

特別なアクセスルール

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

項目

項目名	説明
commaSeparatedOauthScopes	項目の型 string 説明外部クライアントアプリケーションの OAuth 範囲を示すカンマ区切りのリスト。
customAttributes	項目の型 ExtlClntAppOauthSettingsAttribute[] 説明開発者のデフォルトとして組み込まれる一意の属性。許容される最大数は 128 です。各カスタム属性では、一意のキーを保持し、有効な項目を使用する必要があります。
externalClientApplication	項目の型 string 説明必須。この OAuth プラグインに関連付けられた外部クライアントアプリケーション。
label	項目の型 string 説明外部クライアントアプリケーションの表示ラベル。
oauthLink	項目の型 string 説明組織 ID と OAuth コンシューマー ID を組み合わせた自動生成値。
singleLogoutUrl	項目の型 string 説明ユーザーが Salesforce からログアウトするときに Salesforce からログアウト要求が送信される URL。
trustedIpRanges	項目の型 ExtlClntAppOauthIpRange[] 説明外部クライアントアプリケーションでのユーザーの認証を必要とせずにアプリケーションにアクセス可能な IP アドレスの範囲を指定します。IP 範囲の最大数は 128 です。

ExtlClntAppOauthSettingsAttribute

外部クライアントアプリケーションに追加情報を含めるために使用する開発者定義の属性を表します。開発者はこの属性を使用することで、特定の使用事例向けにアプリケーションをカスタマイズできます。

項目名	説明
formula	項目の型 string 説明必須。必要な情報を含む既存の項目。例、`Organization.Country`。
key	項目の型 string 説明必須。属性の一意の名前。例、`country`。

ExtlClntAppOauthIpRange

外部クライアントアプリケーションで信頼された IP アドレスの範囲を表します。

項目名	説明
description	項目の型 string 説明この範囲に対応するネットワークの部分など、範囲の目的を示します。
endIpAddress	項目の型 string 説明必須。 IP 範囲の最後のアドレス (指定した値を含む)。開始アドレスと共に使用する必要があります。
startIpAddress	項目の型 string 説明必須。 IP 範囲の最初のアドレス (指定した値を含む)。終了アドレスと共に使用する必要があります。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<ExtlClntAppOauthSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <externalClientApplication>myeca</externalClientApplication>
4    <label>My Oauth Settings</label>
5    <trustedIpRanges>
6        <startIpAddress>10.55.2.0</startIpAddress>
7        <endIpAddress>10.55.2.255</endIpAddress>
8        <description>Building 6</description>
9    </trustedIpRanges>
10    <trustedIpRanges>
11        <startIpAddress>10.55.12.0</startIpAddress>
12        <endIpAddress>10.55.12.255</endIpAddress>
13    </trustedIpRanges>
14    <customAttributes>
15        <key>userattribute</key>
16        <formula>User.Country</formula>
17    </customAttributes>
18    <commaSeparatedOauthScopes>Basic, Web</commaSeparatedOauthScopes>
19</ExtlClntAppOauthSettings>

前の定義を参照する 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    <version>59.0</version>
20</Package>

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

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