この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

OauthOidcSettings

OAuth OpenID Connect 認証フローを無効にするための組織設定を表します。

親種別およびマニフェストアクセス

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

パッケージマニフェストでは、「Settings」の名前を使用して組織のすべての設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所

OauthOidcSettings の値は、settings フォルダーの OauthOidc.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

OauthOidcSettings は API バージョン 56.0 以降で使用できます。

特別なアクセスルール

この種別に固有のアクセス要件は他にありません。

項目

項目名	説明
blockOAuthUnPwFlow	項目の型 boolean 説明ユーザー名パスワードフローがブロックされているか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
blockOAuthUsrAgtFlow	項目の型 boolean 説明ユーザーエージェントフローがブロックされているか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
enableHdlessFgtPswFlow	項目の型 boolean 説明組織内でのみ使用します。
isPkceRequired	項目の型 boolean 説明 OAuth 2.0 Proof Key for Code Exchange (PKCE) セキュリティ拡張が、この組織にアクセスする OAuth 認証コードフローのバリエーションに必要か (`true`)、否か (`false`) を示します。この設定では、Web サーバーフロー、認証コードとログイン情報フロー、それらの派生フローなど、サポートされるすべての認証コードフローのバリエーションに対して PKCE が必要です。デフォルト値は `false` です。この項目は、API バージョン 59.0 以降で利用できます。
oAuthCdCrdtFlowEnable	項目の型 boolean 説明認証コードとログイン情報フローが有効化されているか (`true`)、ブロックされているか (`false`) を示します。デフォルト値は、`false` です。

宣言的なメタデータの定義のサンプル

OauthOidcSettings ファイルの例を次に示します。

1<?xml version=“1.0” encoding=“UTF-8"?>
2<OauthOidcSettings xmlns=“http://soap.sforce.com/2006/04/metadata”>
3    <blockOAuthUnPwFlow>true</blockOAuthUnPwFlow>
4    <blockOAuthUsrAgtFlow>true</blockOAuthUsrAgtFlow>
5    <oAuthCdCrdtFlowEnable>false</oAuthCdCrdtFlowEnable>
6</OauthOidcSettings>

パッケージマニフェストの例

前の定義を参照する package.xml の例を次に示します。

1<?xml version=“1.0" encoding=“UTF-8”?>
2<Package xmlns=“http://soap.sforce.com/2006/04/metadata”>
3  <types>
4    <members>OauthOidc</members>
5    <name>Settings</name>
6  </types>
7  <version>56.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド