CspTrustedSite
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
CspTrustedSite コンポーネントは、対応するパッケージディレクトリの cspTrustedSites ディレクトリに保存されます。ファイル名は信頼済みサイトの一意の名前に一致し、拡張子は .cspTrustedSite です。
バージョン
CspTrustedSite コンポーネントは、API バージョン 39.0 以降で利用できます。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| canAccessCamera | boolean | この CspTrustedSite がユーザのカメラにアクセスできるか (true)、否か (false) を示します。デフォルト値は false です。 この項目は、SecuritySettings メタデータ API の型の enablePermissionsPolicy 項目が true で、grantCameraAccess 項目が TrustedUrls の場合にのみ有効になります。 この項目は、API バージョン 59.0 以降で利用できます。 |
| canAccessMicrophone | boolean | この CspTrustedSite がユーザのマイクにアクセスできるか (true)、否か (false) を示します。デフォルト値は false です。 この項目は、SecuritySettings メタデータ API の型の enablePermissionsPolicy 項目が true で、grantMicrophoneAccess 項目が TrustedUrls の場合にのみ有効になります。 この項目は、API バージョン 59.0 以降で利用できます。 |
| context | CspTrustedSiteContext (string 型の列挙) | この信頼済み URL の CSP ディレクティブの範囲を宣言します。
カスタム Visualforce ページでは、ページの cspHeader 属性が true に設定されている場合に、コンテンツが信頼済み URL のみに制限されます。 この項目は、API バージョン 44.0 以降で使用できます。 |
| description | string | この信頼済み URL の説明。 |
| endpointUrl | string | 必須。この CspTrustedSite の URL。 この項目にはドメイン名を含める必要があります。また、ポートを含めることもできます。例、https://example.com または https://example.com:8080。 繰り返しを減らすために、ワイルドカード文字 * (アスタリスク) を使用できます。例、*.example.com。サードパーティ API の場合、URL は https:// で始まる必要があります。例、https://example.com。WebSocket 接続の場合、URL は wss:// で始まる必要があります。例、wss://example.com。 |
| isActive | boolean | 必須。この CspTrustedSite が有効か (true)、否か (false) を示します。デフォルト値は true です。 |
| isApplicableToConnectSrc | boolean | Lightning コンポーネント、サードパーティ API、WebSocket 接続で、この信頼済み URL からのスクリプトインターフェースを使用して URL を読み込むことができるか (true)、否か (false) を示します。この項目のデフォルト値は false です。 この項目は、API バージョン 48.0 以降で利用できます。 |
| isApplicableToFontSrc | boolean | Lightning コンポーネント、サードパーティ API、WebSocket 接続で、この信頼済み URL のフォントを読み込むことができるか (true)、否か (false) を示します。この項目のデフォルト値は false です。 この項目は、API バージョン 48.0 以降で利用できます。 |
| isApplicableToFrameSrc | boolean | Lightning コンポーネント、サードパーティ API、WebSocket 接続で、この信頼済み URL の <iframe> 要素に含まれているリソースを読み込むことができるか (true)、否か (false) を示します。この項目のデフォルト値は false です。この項目は、API バージョン 48.0 以降で利用できます。 |
| isApplicableToImgSrc | boolean | Lightning コンポーネント、サードパーティ API、WebSocket 接続で、この信頼済み URL の画像を読み込むことができるか (true)、否か (false) を示します。この項目のデフォルト値は false です。この項目は、API バージョン 48.0 以降で使用できます。 |
| isApplicableToMediaSrc | boolean | Lightning コンポーネント、サードパーティ API、WebSocket 接続で、この信頼済み URL の音声と動画読み込むことができるか (true)、否か (false) を示します。この項目のデフォルト値は false です。 API バージョン 59.0 以降の場合、各信頼済み URL に対して、isApplicable または canAccess で始まる少なくとも 1 つの CSPTrustedSite を true に設定する必要があります。 API バージョン 50.0 ~ 58.0 では、すべての isApplicable 項目が false の場合、isApplicableToImgSrc 項目が true に設定されます。API バージョン 49.0 以前では、すべての isApplicable 項目が false の場合、これらの項目はすべてデフォルトで true になります。 この項目は、API バージョン 48.0 以降で使用できます。 |
| isApplicableToStyleSrc | boolean | Lightning コンポーネント、サードパーティ API、WebSocket 接続で、この信頼済み URL のスタイルシートを読み込むことができるか (true)、否か (false) を示します。この項目のデフォルト値は false です。この項目は、API バージョン 48.0 以降で使用できます。 |
| mobileExtension | string | 将来の使用のために予約されています。 |
宣言的なメタデータの定義のサンプル
信頼済みサイトの XML 定義のサンプルを以下に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CspTrustedSite xmlns="http://soap.sforce.com/2006/04/metadata">
3 <canAccessCamera>false</canAccessCamera>
4 <canAccessMicrophone>true</canAccessMicrophone>
5 <description>Used for Lightning component callout to mapping web service</description>
6 <context>LEX</context>
7 <endpointUrl>https://www.maptestsite.net/</endpointUrl>
8 <isActive>true</isActive>
9 <isApplicableToConnectSrc>true</isApplicableToConnectSrc>
10 <isApplicableToFontSrc>true</isApplicableToFontSrc>
11 <isApplicableToFrameSrc>false</isApplicableToFrameSrc>
12 <isApplicableToImgSrc>true</isApplicableToImgSrc>
13 <isApplicableToMediaSrc>false</isApplicableToMediaSrc>
14 <isApplicableToStyleSrc>true</isApplicableToStyleSrc>
15</CspTrustedSite>使用方法
各 CSPTrustedSite コンポーネントについて、grantAccess または isApplicableTo で始まる少なくとも 1 つの項目を true に設定する必要があります。
API バージョン 50.0 ~ 58.0 以降では、すべての isApplicable 項目が false の場合、isApplicableToImgSrc 項目が true に設定されます。API バージョン 49.0 以前では、すべての isApplicable 項目が false の場合、これらの項目はすべてデフォルトで true になります。
Salesforce 製品間のスムーズな統合を実現するために、Salesforce では、isApplicable 項目に対応する URL が CspTrustedSite コンポーネントとして定義されていなくても、各 CSP ディレクティブにそれらの URL が含まれています。Salesforce は、最新の要件に基づいてそれらの URL を定期的に更新しています。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。