OauthOidcSettings
Parent Type and Manifest Access
File Suffix and Directory Location
OauthOidcSettings values are stored in the OauthOidc.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
OauthOidcSettings is available in API version 56.0 and later.
Special Access Rules
There are no additional access requirements that are specific to this type.
Fields
Field Name | Description |
---|---|
blockOAuthUnPwFlow |
|
blockOAuthUsrAgtFlow |
|
enableHdlessFgtPswFlow |
|
isPkceRequired |
|
oAuthCdCrdtFlowEnable |
|
Declarative Metadata Sample Definition
The following is an example of the OauthOidcSettings file.
<?xml version=“1.0” encoding=“UTF-8"?>
<OauthOidcSettings xmlns=“http://soap.sforce.com/2006/04/metadata”>
<blockOAuthUnPwFlow>true</blockOAuthUnPwFlow>
<blockOAuthUsrAgtFlow>true</blockOAuthUsrAgtFlow>
<oAuthCdCrdtFlowEnable>false</oAuthCdCrdtFlowEnable>
</OauthOidcSettings>
Example Package Manifest
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>OauthOidc</members>
<name>Settings</name>
</types>
<version>56.0</version>
</Package>
Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.