---
schema_version: "1"
id: efb65cbc084f59d5fb423ede164af88f0f792c947c2cf6e0157ceae44bd49ec9
title: IframeWhiteListUrlSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_iframewhitelisturlsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_iframewhitelisturlsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b70e8c56e76666797cd2137534e1c350733e09cfc8057a8feff6026e27d1255e
description: Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.
---
# IframeWhiteListUrlSettings

Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

## File Suffix and Directory Location

IframeWhiteListUrlSettings values are stored in the IframeWhiteListUrlSettings.settings file in the iframeWhiteListUrlSettings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

## Version

[IframeWhiteListUrlSettings](#meta_iframewhitelisturlsettings "Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.") components are available in API version 49.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| iframeWhiteListUrls | [IframeWhiteListUrl](#IframeWhiteListUrl)\[\] | The list of external domains that you allow to frame your Visualforce pages or surveys. |

## IframeWhiteListUrl

Represents the external domains that you allow to frame your Visualforce pages or surveys.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d573721e160">Field Name</th>

              <th class="featureTableHeader  " id="d573721e163">Field Type</th>

              <th class="featureTableHeader  " id="d573721e166">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d573721e160" data-title="Field Name"><span class="keyword parmname">context</span></td>

              <td class="entry" headers="d573721e163" data-title="Field Type">IFrameWhitelistContext (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d573721e166" data-title="Description">Required. The type of content in the iframe. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">LightningOut</samp>—Reserved for future use.
                    Available in API version 60.0 and later
                  </li>

                  <li class="li"><samp class="codeph nolang">Surveys</samp></li>

                  <li class="li"><samp class="codeph nolang">VisualforcePages</samp></li>

                  <li class="li"><samp class="codeph nolang">DisclosureAndComplianceHubConnector</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d573721e160" data-title="Field Name"><span class="keyword parmname">url</span></td>

              <td class="entry" headers="d573721e163" data-title="Field Type">string</td>

              <td class="entry" headers="d573721e166" data-title="Description">The unique domain that is allowed to frame your Visualforce pages, surveys, or
                Disclosure and Compliance Hub Connector. Accepts these formats: <samp class="codeph nolang">example.com</samp>, <samp class="codeph nolang">*example.com</samp>, and <samp class="codeph nolang">https://example.com</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a [IframeWhiteListUrlSettings](#meta_iframewhitelisturlsettings "Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. This type extends the Metadata metadata type and inherits its fullName field.") component.

<?xml version="1.0" encoding="UTF-8"?>
<IframeWhiteListUrlSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <iframeWhiteListUrl\>
      <context\>Surveys></context\>
      <url\>example1.com</url\>
    </iframeWhiteListUrl\>
    <iframeWhiteListUrl\>
      <context\>VisualforcePages</context\>
      <url\>example2.com</url\>
     </iframeWhiteListUrl\>
     <iframeWhiteListUrl\>
        <context\>DisclosureAndComplianceHubConnector</context\>
        <url\>example3.com</url\>
     </iframeWhiteListUrl\>
</IframeWhiteListUrlSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
      <members\>IframeWhiteListUrlSettings</members\>
      <name\>IframeWhiteListUrlSettings</name\>
   </types\>
    <version\>62.0</version\>
</Package\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).