---
schema_version: "1"
id: 5fbf675bd09251061955046c12bb0a9a2ad99b4fee4091795b9d9cf3481d84b3
title: OauthOidcSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_oauthoidcsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_oauthoidcsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 65fed283a6b5bb31e40d0980a81a8f0654ff1ddaaeba4922e267f5be46e66e86
description: Represents org settings for disabling OAuth OpenID Connect authorization flows.
---
# OauthOidcSettings

Represents org settings for disabling OAuth OpenID Connect authorization flows.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details.

## 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 |
| --- | --- |
| agentAuthLinking | 
Field Type

boolean

Description

For internal use only.



 |
| blockOAuthUnPwFlow | 

Field Type

boolean

Description

Indicates whether the username-password flow is blocked (true) or not blocked (false). The default value is false.



 |
| blockOAuthUsrAgtFlow | 

Field Type

boolean

Description

Indicates whether the user-agent flow is blocked (true) or not blocked (false). The default value is false.



 |
| enableHdlessFgtPswFlow | 

Field Type

boolean

Description

For internal use only.



 |
| isPkceRequired | 

Field Type

boolean

Description

Indicates whether the OAuth 2.0 Proof Key for Code Exchange (PKCE) security extension is required for variations of the OAuth authorization code flow that access this org (true) or not (false). This setting requires PKCE for all supported variations of the authorization code flow, including the web server flow, the Authorization Code and Credentials Flow, and their derivatives. The default value is false. This field is available in API version 59.0 and later.



 |
| oAuthCdCrdtFlowEnable | 

Field Type

boolean

Description

Indicates whether the Authorization Code and Credentials Flow is enabled (true) or blocked (false). The default value is false.



 |

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). 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).