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

親種別

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

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

ExtlClntAppOauthConfigurablePolicies コンポーネントは .ecaOauthPlcy のサフィックスを持ち、extlClntAppOauthPolicies フォルダーに保存されます。

バージョン

ExtlClntAppOauthConfigurablePolicies コンポーネントは、API バージョン 59.0 以降で利用できます。

特別なアクセスルール

OAuth ポリシーを設定するための管理者ロールを持つユーザーには、「すべての外部クライアントアプリケーションの表示、その設定の表示、およびそのポリシーの編集」ユーザー権限が必要です。

項目

項目名	説明
clientCredentialsFlowUser	項目の型 string 説明 OAuth 2.0 クライアントのログイン情報フローの実行ユーザー。Salesforce は、このユーザーに変わってアクセストークンを返します。このユーザーは「API のみ」権限を持っている必要があります。API バージョン 60.0 以降で利用できます。
commaSeparatedPermissionSet	項目の型 string 説明権限セット ID のカンマ区切りのリスト。
customAttributes	項目の型 ExtlClntAppOauthPoliciesAttribute[] 説明管理者のデフォルトとして組み込まれる一意の属性。許容される最大数は 128 です。各カスタム属性では、一意のキーを保持し、有効な項目を使用する必要があります。
externalClientApplication	項目の型 string 説明必須。この OAuth ポリシーファイルに関連付けられた外部クライアントアプリケーションの名前。
ipRelaxationPolicyType	項目の型 string 説明 IP 制限を決定するポリシー。値は次のとおりです。 `Enforce` `Bypass` `Bypass_2factor` `Enforce_RelaxRefresh`
isClientCredentialsFlowEnabled	項目の型 boolean 説明 `true` の場合、クライアントのログイン情報フローが有効になります。デフォルト値は `false` です。API バージョン 60.0 以降で利用できます。
isTokenExchangeFlowEnabled	項目の型 boolean 説明 `true` の場合、トークン交換フローが有効になります。デフォルト値は `false` です。API バージョン 60.0 以降で利用できます。
label	項目の型 string 説明外部クライアントアプリケーションの OAuth ポリシー名。
permittedUsersPolicyType	項目の型 PermittedUsersPolicyType (string 型の列挙) 説明外部クライアントアプリケーションで許可されるユーザーを決定するポリシー。値は次のとおりです。 `AdminApprovedPreAuthorized` `AllSelfAuthorized`
policyAction	項目の型 PolicyAction (string 型の列挙) 説明ユーザーが外部クライアントアプリケーションにログインするときに 2 要素認証を使用して ID を検証することを要求します。`RaiseSessionLevel` と requiredSessionLevel を使用して、セキュリティ体制を決定します。値は次のとおりです。 `Block` `RaiseSessionLevel`
refreshTokenPolicyType	項目の型 RefreshTokenPolicyType (string 型の列挙) 説明トークンを更新するタイミングを決定するポリシーの種別。値は次のとおりです。 `Infinite` `SpecificInactivity` `SpecificLifetime` `Zero`
refreshTokenValidityPeriod	項目の型 int 説明更新トークンポリシー種別が `SpecificInactivity` または `SpecificLifetime` に設定されている場合に、有効性を指定するために使用される測定単位の数値。
refreshTokenValidityUnit	項目の型 string 説明更新トークンポリシー種別が `SpecificInactivity` または `SpecificLifetime` に設定されている場合に、有効性を指定するために使用される測定単位。値は次のとおりです。 `Days` `Hours` `Months`
requiredSessionLevel	項目の型 SessionSecurityLevel (string 型の列挙) 説明セキュリティ体制を定義します。値は次のとおりです。 `HIGH_ASSURANCE` `LOW` `STANDARD`
sessionTimeoutInMinutes	項目の型 int 説明外部クライアントアプリケーションのセッションが持続する時間の長さ。
singleLogoutUrl	項目の型 string 説明ユーザーが Salesforce からログアウトするときに Salesforce からログアウト要求が送信される URL。
startUrl	項目の型 string 説明ユーザーが認証後に移動する URL。

ExtlClntAppOauthPoliciesAttribute

システム管理者が定義する個人情報を提供する属性を表します。これは、外部クライアントアプリケーションを特定の使用事例に合わせてカスタマイズするために使用されます。

項目名	説明
formula	項目の型 string 説明必須。必要な情報を含む既存の項目。例、`Organization.Country`。
key	項目の型 string 説明必須。属性の一意の名前。例、`country`。

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

ExtlClntAppOauthConfigurablePolicies コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ExtlClntAppOauthConfigurablePolicies xmlns="http://soap.sforce.com/2006/04/metadata">
3    <externalClientApplication>myeca</externalClientApplication>
4    <label>myecapolicy</label>
5    <refreshTokenPolicyType>SpecificLifetime</refreshTokenPolicyType>
6    <refreshTokenValidityPeriod>1</refreshTokenValidityPeriod>
7    <refreshTokenValidityUnit>Days</refreshTokenValidityUnit>
8    <ipRelaxationPolicyType>Enforce</ipRelaxationPolicyType>
9    <permittedUsersPolicyType>AdminApprovedPreAuthorized</permittedUsersPolicyType>
10    <commaSeparatedPermissionSet></commaSeparatedPermissionSet>
11    <sessionTimeoutInMinutes>1</sessionTimeoutInMinutes>
12    <requiredSessionLevel>HIGH_ASSURANCE</requiredSessionLevel>
13    <policyAction>RaiseSessionLevel</policyAction>
14    <singleLogoutUrl>https://www.example.com</singleLogoutUrl>
15    <startUrl>https://www.example.com</startUrl>
16</ExtlClntAppOauthConfigurablePolicies>

この例の package.xml は、以前の定義を参照します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ExternalClientApplication</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>ExtlClntAppOauthSettings</name>
10    </types>
11    <types>
12        <members>*</members>
13        <name>ExtlClntAppGlobalOauthSettings</name>
14    </types>
15    <types>
16        <members>*</members>
17        <name>ExtlClntAppOauthConfigurablePolicies</name>
18    </types>
19    <types>
20        <members>*</members>
21        <name>ExtlClntAppConfigurablePolicies</name>
22    </types>
23    <version>60.0</version>
24</Package>

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

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。