メタデータ API 開発者ガイド
jMyDomainSettings
組織の [私のドメイン] 設定を表します。[私のドメイン] は、独自のサブドメインを作成してログインと認証をより適切に管理できる Salesforce Identity 機能です。[私のドメイン] サブドメインを使用して、Salesforce によって割り当てられたインスタンス名 (https://na00/salesforce.com など) を独自に選択した名前 (https://yourcompany.my.salesforce.com など) に置き換えます。[私のドメイン] では、カスタムログインページとカスタムログインポリシーを作成して、ユーザの認証方法を制御できます。また、シングルサインオン (SSO) とソーシャルサインオンを設定し、複数の組織で同時に作業したりすることもできます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
MyDomainSettings の値は、settings ディレクトリの MyDomain.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
MyDomainSettings コンポーネントは、API バージョン 47.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| canOnlyLoginWithMyDomainUrl | boolean | true の場合、ユーザーログインに [私のドメイン] URL を使用する必要があります。false (デフォルト) の場合、ユーザはインスタンスの Salesforce URL https://instance.login.salesforce.com を使用して、ログインプールを介してログインすることもできます。 |
| doesApiLoginRequireOrgDomain | boolean | true の場合、ユーザは [私のドメイン] URL を使用して Salesforce API にアクセスする必要があります。false (デフォルト) の場合、ユーザは汎用 Salesforce ページ https://instance.login.salesforce.com を使用して Salesforce API にアクセスすることもできます。 |
| enableNativeBrowserForAuthOnAndroid | boolean | true の場合、Android モバイルアプリケーションの認証にネイティブブラウザを使用します。デフォルトは false です。 |
| enableNativeBrowserForAuthOnIos | boolean | true の場合、iOS モバイルアプリケーションの認証にネイティブブラウザを使用します。デフォルトは false です。 |
| useStabilizedMyDomainHostnames | boolean | Visualforce、エクスペリエンスビルダー、Site.com Studio、およびコンテンツファイルの [私のドメイン] URL でインスタンス名が非表示か (true)、否か (false) を示します。この項目のデフォルト値は false です。たとえば、この項目が true に設定されている場合、mydomain--c.na44.visual.force.com は mydomain--c.visualforce.com になります。 |
| useStabilizedSandboxMyDomainHostnames | boolean | Sandbox 組織の [私のドメイン] URL でインスタンス名が非表示か (true)、否か (false) を示します。この項目のデフォルト値は false です。たとえば、この項目が true に設定されている場合、mydomain--test.cs5.my.salesforce.com は mydomain--test.my.salesforce.com になります。 |
宣言的なメタデータの定義のサンプル
MyDomainSettings コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<MyDomainSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <canOnlyLoginWithMyDomainUrl>false</canOnlyLoginWithMyDomainUrl>
4 <doesApiLoginRequireOrgDomain>false</doesApiLoginRequireOrgDomain>
5 <enableNativeBrowserForAuthOnAndroid>false</enableNativeBrowserForAuthOnAndroid>
6 <enableNativeBrowserForAuthOnIos>false</enableNativeBrowserForAuthOnIos>
7 <useStabilizedMyDomainHostnames>true</useStabilizedMyDomainHostnames>
8 <useStabilizedSandboxMyDomainHostnames>false</useStabilizedSandboxMyDomainHostnames>
9</MyDomainSettings>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyDomain</members>
5 <name>Settings</name>
6 </types>
7 <version>47.0</version>
8</Package>