IdentityProviderSettings

Represents the settings used to enable or disable Salesforce as a SAML identity provider for single sign-on (SSO).

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

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

Version

IdentityProviderSettings components are available in API version 57.0 and later.

Special Access Rules

To access IdentityProviderSettings, a user must have the Customize Application user permission.

Fields

Field Name	Description
certificateName	Field Type string Description Required. The certificate that Salesforce uses to communicate with SAML SSO service providers, such as third-party service providers or another Salesforce org acting as a service provider. You can enter the name of a self-signed certificate or a certificate signed by a certificate authority.
enableIdentityProvider	Field Type boolean Description Required. Indicates whether Salesforce can be used as a SAML identity provider (`true`) or not (`false`).

Declarative Metadata Sample Definition

The following is an example of an IdentityProviderSettings component. In this example, Salesforce is enabled as a SAML identity provider.

1<?xml version="1.0" encoding="UTF-8"?>
2<IdentityProviderSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <certificateName>Certificate Name</certificateName>
4    <enableIdentityProvider>true</enableIdentityProvider>
5</IdentityProviderSettings>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>IdentityProvider</members>
5        <name>Settings</name>
6    </types>
7    <version>57.0</version>
8</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.

Metadata API Developer Guide