ConnectedApp
接続アプリケーション設定を表します。接続アプリケーションは、API を使用して Salesforce と統合します。接続アプリケーションは、標準の SAML および OAuth プロトコルを使用して認証し、シングルサインオンと Salesforce API で使用するトークンを提供します。接続アプリケーションでは、標準の OAuth 機能に加え、Salesforce システム管理者がさまざまなセキュリティポリシーを設定したり、対応するアプリケーションを使用できるユーザを明示的に制御したりすることができます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ConnectedApp コンポーネントのサフィックスは .connectedapp で、connectedapps フォルダに保存されます。
バージョン
ConnectedApp コンポーネントは、API バージョン 29.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| attributes | ConnectedAppAttribute | 接続アプリケーションのカスタム属性。 |
| canvasConfig | ConnectedAppCanvasConfig | キャンバスアプリケーションとして公開されている場合の接続アプリケーションの設定オプション。 |
| contactEmail | string | Salesforce がアプリケーション提供者またはそのサポートチームへの連絡に使用するメールアドレス。 |
| contactPhone | string | Salesforce から連絡する必要がある場合に使用する電話番号。 |
| description | string | アプリケーションの説明 (省略可能)。 |
| iconUrl | string | 将来の使用のために予約されています。 |
| infoUrl | string | アプリケーションについての詳細が記載された Web ページの URL (省略可能)。 |
| ipRanges | ConnectedAppIpRange | 接続アプリケーションでのユーザの認証を必要とせずにアプリケーションにアクセス可能な IP アドレスの範囲を指定します。 |
| label | string | アプリケーションの名前。 |
| logoUrl | string | アプリケーションのロゴ (省略可能)。このロゴは、認証時にユーザに表示されるアプリケーションリストおよび同意ページのアプリケーションのエントリに表示されます。URL には HTTPS を使用し、ロゴは 125×200 ピクセル (高さ×幅) 以下にする必要があります。デフォルトは雲のロゴです。 |
| mobileStartUrl | string | モバイルデバイスからアプリケーションにアクセスするときに、認証後、ユーザはこの URL に転送されます。URL を指定しない場合、ユーザは認証完了後アプリケーションのデフォルトのスタートページに転送されます。作成中の接続アプリケーションがキャンバスアプリケーションである場合は、この項目に値を入力する必要はありません。[キャンバスアプリケーションの URL] 項目には、接続アプリケーションからコールされる URL が含まれます。 |
| oauthConfig | ConnectedAppOauthConfig | アプリケーションが Salesforce と通信する方法を指定します。 |
| plugin | string | Auth.ConnectedAppPlugin を拡張してアプリケーションの動作をカスタマイズするカスタム Apex クラスの名前。 |
| samlConfig | ConnectedAppSamlConfig | アプリケーションによるシングルサインオンの使用方法を制御します。 |
| startUrl | string | モバイルデバイスからのアクセスでない場合、認証後、ユーザはこの URL に転送されます。URL を指定しない場合、ユーザは認証完了後アプリケーションのデフォルトのスタートページに転送されます。モバイルデバイスからアプリケーションにアクセスする場合、mobileStartUrl を参照してください。作成中の接続アプリケーションがキャンバスアプリケーションである場合は、この項目に値を入力する必要はありません。[キャンバスアプリケーションの URL] 項目には、接続アプリケーションからコールされる URL が含まれます。 |
ConnectedAppAttribute
SAML と ConnectedApp を併用する場合にカスタム属性を構成する項目名を表します。これらの値は、特定のサービスプロバイダに合わせて調整する必要があります。
| 項目名 | データ型 | 説明 |
|---|---|---|
| formula | string | 属性の値。 |
| key | string | 属性の識別子。 |
ConnectedAppCanvasConfig
キャンバスアプリケーションとして公開されている場合の接続アプリケーションの設定オプション。
| 項目名 | データ型 | 説明 |
|---|---|---|
| accessMethod | AccessMethod (string 型の列挙) | キャンバスアプリケーションで OAuth 認証フローを開始する方法を示します。有効な値は、次のとおりです。
|
| canvasUrl | string | キャンバスアプリケーションとして公開されたサードパーティアプリケーションの URL。 |
| lifecycleClass | string |
Canvas.CanvasLifecycleHandler Apex クラスの名前 (カスタムパラメータの制御にこのクラスを実装している場合)。 この項目は API バージョン 31.0 以降で使用できます。 |
| locations | CanvasLocationOptions (string 型の列挙) | キャンバスアプリケーションを表示できる場所を示します。有効な値は、次のとおりです。
|
| options | CanvasOptions (string 型の列挙) | キャンバスアプリケーションのパブリッシャーで [共有] ボタンとヘッダーを非表示にするかどうか、およびアプリケーションがキャンバス個人用アプリケーションかどうかを示します。有効な値は、次のとおりです。
|
| samlInitiationMethod | SamlInitiationMethod (string 型の列挙) |
SAML シングルサインオン (SSO) を使用している場合、SSO フローを開始するプロバイダを示します。
この項目は API バージョン 31.0 以降で使用できます。 |
ConnectedAppIpRange
ユーザの認証を必要とせずにアプリケーションにアクセス可能な IP アドレスのリスト。
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | この項目は、この範囲に対応するネットワークの部分など、範囲の目的を識別するために使用します。この項目は API バージョン 31.0 以降で使用できます。 |
| startAddress | string | IP 範囲の最初のアドレス (指定した値を含む)。 |
| endAddress | string | IP 範囲の最後のアドレス (指定した値を含む)。 |
ConnectedAppSamlConfig
アプリケーションによるシングルサインオンの使用方法を指定します。
宣言的なメタデータの定義のサンプル
組織の ConnectedApp メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>PortalTestApp</members>
5 <name>ConnectedApp</name>
6 </types>
7 <version>29.0</version>
8</Package>ConnectedApp コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata">
3 <fullName>AConnectedApp</fullName>
4 <attributes>
5 <formula>$User.CompanyName</formula>
6 <key>companyName</key>
7 </attributes>
8 <contactEmail>joe@company.com</contactEmail>
9 <mobileStartUrl>https://m.connectedapp.company.com</mobileStartUrl>
10 <label>A ConnectedApp</label>
11 <oauthConfig>
12 <callbackUrl>https://callback.company.com</callbackUrl>
13 <scopes>Basic</scopes>
14 <scopes>Chatter</scopes>
15 </oauthConfig>
16 <samlConfig>
17 <acsUrl>http://acs.company.com</acsUrl>
18 <entityUrl>http://samlentityId.company.com</entityUrl>
19 <samlSubjectType>Username</samlSubjectType>
20 </samlConfig>
21 <startUrl>https://connectedapp.company.com</startUrl>
22 <ipRanges>
23 <endAddress>10.0.0.46</endAddress>
24 <startAddress>10.0.0.42</startAddress>
25 </ipRanges>
26 <ipRanges>
27 <endAddress>10.0.0.32</endAddress>
28 <startAddress>10.0.0.25</startAddress>
29 </ipRanges>
30</ConnectedApp>使用方法
メタデータ API を使用して SAML が有効な接続アプリケーションを作成し、サービスプロバイダに [Idp-init のログイン URL] を設定する必要がある場合、次の 2 つのオプションがあります。
app パラメータにサービスプロバイダアプリケーション ID を次の形式で使用できます。この値は、Salesforce ユーザインターフェースに表示されます。[設定] から、[クイック検索] ボックスに「接続アプリケーション」と入力し、[接続アプリケーション] を選択してから、接続アプリケーションの名前をクリックして、その詳細ページを表示します。
1https://<Salesforce_base_URL>/idp/login?app=<app_id>または、メタデータ API のみを使用して接続アプリケーションを設定する場合、サービスプロバイダアプリケーションの apiName パラメータを次の形式で使用できます。apiName パラメータは、メタデータ型から継承された fullName です。
1https://<Salesforce_base_URL>/idp/login?apiName=<fullName>