メタデータ API 開発者ガイド
jSecuritySettings
組織のセキュリティ設定を表します。セキュリティ設定は、ネットワークアクセス用の信頼できる IP 範囲、パスワードとログインの要件、およびセッション終了とセキュリティ設定を定義します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
SecuritySettings の値は、settings ディレクトリの Security.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
セキュリティ設定は、API バージョン 27.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| networkAccess | NetworkAccess | 信頼済み IP アドレスの範囲は、ユーザがコンピュータの有効化を要求せずに常にログインできる IP 範囲です。 |
| passwordPolicies | PasswordPolicies | パスワードとログインの要件、および忘れたパスワードの取得をサポートする情報です。 |
| sessionSettings | SessionSettings | セッションの有効期限とセキュリティの設定。 |
NetworkAccess
ネットワークアクセスのための組織の信頼済み IP アドレス範囲を表します。
| 項目 | データ型 | 説明 |
|---|---|---|
| ipRanges | IpRange[] | 信頼済み IP アドレスの範囲は、ユーザがコンピュータの有効化を要求せずに常にログインできる IP 範囲です。 |
PasswordPolicies
組織のパスワードとログインポリシーを表します。
| 項目 | データ型 | 説明 |
|---|---|---|
| apiOnlyUserHomePageURL | string | 「API 限定ユーザ」権限を持つユーザがログインページの代わりにリダイレクトされる URL。 |
| complexity | Complexity (string 型の列挙) |
必須。ユーザのパスワードとして使用できる文字の種別の要件。有効な値は、次のとおりです。
|
| expiration | Expiration (string 型の列挙) | |
| minimumPasswordLifetime | boolean | パスワードの最小有効期限 (1 日) が必要か (true)、否か (false) を示します。 この項目は、API バージョン 31.0 以降で使用できます。 |
| historyRestriction | string | 必須。新しく再設定されるパスワードが常に一意のパスワードになるように、保存されるユーザの過去のパスワードの数。保存されるパスワード数の有効な値は、0 から 24 です。最大値 24 は、API バージョン 31.0 以降に適用されます。以前のバージョンの最大値は 16 です。デフォルト値は、3 です。 |
| lockoutInterval | LockoutInterval (string 型の列挙) | |
| maxLoginAttempts | MaxLoginAttempts (string 型の列挙) | |
| minimumPasswordLength | string |
必須。パスワードに必要な最小限の文字数。有効な値は 5 ～ 50 です。デフォルト値は 8 です。この項目は、API バージョン 35.0 以降で使用できます。 API バージョン 35.0 より前の場合は、有効な値 FiveCharacters、EightCharacters (デフォルト)、TenCharacters、TwelveCharacters (API バージョン 31.0 以降)、FifteenCharacters (API バージョン 34.0 以降) を含む列挙 minPasswordLength を使用して、最小パスワード長を指定します。 |
| obscureSecretAnswer | boolean | パスワードに関連付けられた秘密の答えを非表示にするか (true)、否か (false) を示します。 |
| passwordAssistanceMessage | string | パスワードをリセットするユーザに対して、「アカウントロックアウト」メールと [ID を確認] 画面の下部に表示されるテキスト。 |
| passwordAssistanceURL | string | ユーザがクリックして忘れたパスワードを取得できる URL。 |
| questionRestriction | QuestionRestriction (string 型の列挙) |
SessionSettings
組織のセッションの有効期限とセキュリティ設定を表します。
| 項目 | データ型 | 説明 |
|---|---|---|
| disableTimeoutWarning | boolean | セッションタイムアウトの警告ポップアップが無効化されるか (true)、有効化されるか (false) を示します。 |
| enableCSPOnEmail | boolean | メールテンプレートに対してコンテンツセキュリティポリシーを有効にするかどうかを示します。コンテンツセキュリティポリシーを使用すると、画像やその他のコンテンツのソースをホワイトリストに登録して、クロスサイトスクリプティング攻撃を阻止できます。 |
| enableCSRFOnGet | boolean | 設定以外のページの GET 要求のクロスサイトリクエストフォージェリ (CSRF) 保護が有効化されているか (true)、否か (false) を示します。 |
| enableCSRFOnPost | boolean | 設定以外のページの POST 要求のクロスサイトリクエストフォージェリ (CSRF) 保護が有効化されているか (true)、否か (false) を示します。 |
| enableCacheAndAutocomplete | boolean | ユーザのブラウザにユーザ名を保存して、ログインページの [ユーザ名] 項目に自動入力できるようにするか (true)、否か (false) を示します。 |
| enableClickjackNonsetupSFDC | boolean | 設定以外の Salesforce ページでクリックジャック保護が有効化されるか (true)、無効化されるか (false) を示します。 |
| enableClickjackNonsetupUser | boolean | 標準ヘッダーが有効なカスタマー Visualforce ページでクリックジャック保護が有効化されるか (true)、否か (false) を示します。 |
| enableClickjackNonsetupUserHeaderless | boolean | 標準ヘッダーが無効なカスタマー Visualforce ページでクリックジャック保護が有効化されるか (true)、否か (false) を示します。API バージョン 34.0 以降で使用できます。 |
| enableClickjackSetup | boolean | 設定ページでクリックジャック保護が有効化されるか (true)、無効化されるか (false) を示します。 |
| enablePostForSessions | boolean | ユーザが Visualforce ページを使用している場合などに、クロスドメインセッション情報が GET 要求ではなく POST 要求を使用して交換されるかどうかを示します。このコンテキストでは、POST 要求は GET 要求よりもセキュアです。API バージョン 31.0 以降で使用できます。 |
| enableSMSIdentity | boolean | ユーザが SMS 経由で 1 回限りの PIN を取得できるか (true)、否か (false) を示します。 |
| enforceIpRangesEveryRequest | boolean | true の場合、ユーザが Salesforce にアクセスすると (クライアントアプリケーションからのアクセスを含む)、ページ要求のたびにログイン IP 範囲の IP アドレスが適用されます。false の場合、ユーザがログインするときのみ、ログイン IP 範囲の IP アドレスが適用されます。この項目は、ログイン IP アドレスが制限されたすべてのユーザプロファイルに影響します。API バージョン 34.0 以降で使用できます。 |
| forceLogoutOnSessionTimeout | boolean | 無効なユーザのセッションがタイムアウトすると、現在のセッションが無効になることを示します。ブラウザが更新され、ログインページに戻ります。組織にアクセスするには、再ログインする必要があります。有効化 (true)、または無効化 (false) します。API バージョン 31.0 以降で使用できます。 |
| forceRelogin | boolean | true の場合、別のユーザとしてログインしているシステム管理者が、セカンダリユーザとしてログアウトしてから元のセッションに再度ログインする必要があります。false の場合、システム管理者が再度ログインする必要はありません。 |
| hstsOnForcecomSites | boolean | Visualforce、Force.com サイト、またはコミュニティで HTTPS を使用するかどうかを示します。この項目は、API バージョン 41.0 以降で使用できます。 |
| lockSessionsToDomain | boolean | コミュニティユーザなどのユーザの現在の UI セッションが特定のドメインに関連付けられているかどうかを示します。このチェックは、別のドメインでのセッション ID の不正使用防止に役立ちます。この値は、Spring '15 リリース以降に作成された組織ではデフォルトで true になっています。API バージョン 33.0 以降で使用できます。 |
| lockSessionsToIp | boolean | ユーザセッションが、ユーザがログインした IP アドレスにロックされるか (true)、否か (false) を示します。 |
| logoutURL | string | Salesforce からユーザがログアウトした後のリダイレクト先 URL。値を指定しない場合、[私のドメイン] が有効でなければ https://login.salesforce.com がデフォルトになります。[私のドメイン] が有効な場合のデフォルトは https://customdomain.my.salesforce.com です。API バージョン 34.0 以降で使用できます。 |
| requireHttpOnly | boolean | セッションの Cookie に対して HttpOnly 属性を設定すると、その Cookie に JavaScript を使用してアクセスできなくなります。true の場合、セッション ID Cookie のアクセスが制限されます。false の場合、アクセスは制限されません。 この項目は、API バージョン 40.0 以降で使用できます。 |
| requireHttps | boolean |
Salesforce へのログインまたはアクセスに HTTPS が必要かどうかを決定します。セキュリティ上の理由により、このオプションはデフォルトで有効になっています。HTTP に変更するには、Salesforce カスタマーサポートにお問い合わせください。 この項目は、API バージョン 40.0 以降で使用できます。 |
| sessionTimeout | SessionTimeout (string 型の列挙) |
宣言的なメタデータの定義のサンプル
security.settings メタデータファイルのサンプルを次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<SecuritySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <networkAccess>
4 <ipRanges>
5 <end>127.0.0.1</end>
6 <start>127.0.0.1</start>
7 </ipRanges>
8 </networkAccess>
9 <passwordPolicies>
10 <apiOnlyUserHomePageURL>http://www.altPage.com</apiOnlyUserHomePageURL>
11 <complexity>SpecialCharacters</complexity>
12 <expiration>OneYear</expiration>
13 <passwordAssistanceURL>http://www.acme.com/forgotpassword</passwordAssistanceURL>
14 <passwordAssistanceMessage>Forgot your password? Reset it here.</passwordAssistanceMessage>
15 <historyRestriction>3</historyRestriction>
16 <lockoutInterval>ThirtyMinutes</lockoutInterval>
17 <maxLoginAttempts>ThreeAttempts</maxLoginAttempts>
18 <minimumPasswordLength>10</minPasswordLength>
19 <questionRestriction>None</questionRestriction>
20 </passwordPolicies>
21 <sessionSettings>
22 <disableTimeoutWarning>true</disableTimeoutWarning>
23 <enableCSRFOnGet>false</enableCSRFOnGet>
24 <enableCSRFOnPost>false</enableCSRFOnPost>
25 <enableCacheAndAutocomplete>false</enableCacheAndAutocomplete>
26 <enableClickjackNonsetupSFDC>true</enableClickjackNonsetupSFDC>
27 <enableClickjackNonsetupUser>true</enableClickjackNonsetupUser>
28 <enableClickjackSetup>true</enableClickjackSetup>
29 <enableSMSIdentity>true</enableSMSIdentity>
30 <forceRelogin>true</forceRelogin>
31 <lockSessionsToIp>true</lockSessionsToIp>
32 <sessionTimeout>TwelveHours</sessionTimeout>
33 </sessionSettings>
34</SecuritySettings>