RedirectWhitelistUrl

Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true.

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.

This type extends Metadata and inherits its fields.

RedirectWhitelistUrl components have the suffix .redirectWhitelistUrl and are stored in the redirectWhitelistUrls folder.

Introduced in API version 48.0.

Only authenticated internal and external users with the View Setup and Customize Application permissions can access or edit this type.

  • Type: string

  • Required: Yes

  • Description: Required. The trusted URL.

    These formats are accepted: example.com, *.example.com, and https://example.com.

    The host section of the URL can include an asterisk (*) as a wildcard. Otherwise, the URL cannot be malformed. Examples of malformed URLs that fail a syntax check are malformed^url.example.com, and https://{subdomain}.example.com.

    To add a URL based on parameters, build the URL before you add it to this Metadata Type.

This metadata type supports 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.