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

このエンティティ内に保存されているログイン情報はすべて、プラットフォーム上のほかの暗号化フレームワークと一貫性のあるフレームワークで暗号化されます。Salesforce は、組織固有の鍵を自動作成してログイン情報を暗号化します。以前の暗号化スキームを使用して暗号化されたログイン情報は、新しいフレームワークに移行されました。

メモ

親種別

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

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

ExternalCredential コンポーネントのサフィックスは .externalCredential で、externalCredentials フォルダに保存されます。

バージョン

ExternalCredential コンポーネントは、API バージョン 54.0 以降で使用できます。

特別なアクセスルール

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

項目

項目名	説明
authenticationProtocol	項目の型 AuthenticationProtocol (string 型の列挙) 説明必須。外部システムへのアクセスに必要な認証プロトコル。値は次のとおりです。 `AwsSig4` `Jwt` (このリリースではサポートされていません。) `JwtExchange`(このリリースではサポートされていません。) `NoAuthentication` (このリリースではサポートされていません。) `Oauth` (このリリースではサポートされていません。) `Password` (このリリースではサポートされていません。) 署名バージョン 4 使用する Amazon Web Services への接続には、`AwsSv4` を使用します。直接トークンシステムを使用した接続には、`Jwt` を選択します。JWT を処理してアクセストークンを返すために中間認証プロバイダを使用している場合は、`JwtExchange` を使用します。単純な URL データソースには、`NoAuthentication` を選択します。クラウドベースの Files Connect 外部システムにアクセスするには、`Oauth` を選択します。社内システムには、`Password`. を選択します。
description	項目の型 string 説明外部ログイン情報のわかりやすい説明。
externalCredentialParameters	項目の型 ExternalCredentialParameter[] 説明外部ログイン情報を詳細に設定する 1 つ以上のパラメータセット。
masterLabel	項目の型 string 説明必須。外部ログイン情報の名前。

ExternalCredentialParameter

外部ログイン情報を設定するパラメータをカプセル化します。パラメータは、動作を決定するパラメータ種別として識別されます。パラメータ名は、識別子として識別されるか、種別とその値に基づいて解釈されます。関連するパラメータは、同じパラメータグループ名でグループ化されます。API バージョン 54.0 以降で利用できます。

項目名	説明
authProvider	項目の型 string 説明認証プロバイダオブジェクトの参照。ログインプロセスを提供し、外部システムへのアクセスを承認するサービスを定義します。
description	項目の型 string 説明人間が見てわかる、この外部ログイン情報パラメータの説明。
parameterName	項目の型 string 説明必須。外部ログイン情報パラメータの名前。
parameterType	項目の型 ExternalCredentialParamType (string 型の列挙) 説明必須。外部ログイン情報パラメータの種別。この項目の値によってパラメータの動作が決まります。値は次のとおりです。 `AuthHeader` テキスト TBA `AuthParameter` テキスト TBA `AuthProtocolVariant` テキスト TBA `AuthProvider` テキスト TBA `AuthProviderQueryParameter` テキスト TBA `NamedPrincipal`: パラメータで使用するユーザログイン情報のセットを、外部システムにアクセスするすべてのユーザに対して同じにすることを指定します。principal 項目は、ユーザ、ユーザロール、グループ、権限セット、または権限セットグループを指定する場合に使用します。(このリリースでサポートされるのは、権限セットのみです。) `PerUserPrincipal` テキスト TBA
parameterValue	項目の型 string 説明 parameterType 項目がリテラル値を示している場合、この項目にはリテラル値が保存されます。
principal	項目の型 string 説明 parameterType 項目の値が `NamedPrincipal` の場合、この項目はユーザ、ユーザロール、グループ、権限セット、または権限セットグループを指します。(このリリースでサポートされるのは、権限セットのみです。)ログイン情報プロバイダから提供されるログイン情報が使用可能な一連のユーザは、その値によって決定されます。parameterName 項目の値は、このプリンシパルの名前を指定します。UserExternalCredential オブジェクトのレコードでは、この名前を使用して、一連の有効なユーザログイン情報を指定できます。
sequenceNumber	項目の型 int 説明ユーザが参加しているプリンシパルが複数あるときに適用するプリンシパルの順序を指定します。たとえば、ユーザは、ログイン情報プロバイダで適用される複数の権限セットに割り当てることができます。優先度は、番号の小さい方が高くなります。この項目を設定できるのは、parameterType が `NamedPrincipal` の場合のみです。

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

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

1<ExternalCredential xmlns="http://soap.sforce.com/2006/04/metadata">
2    <masterLabel>SampleExternalCredential</masterLabel>
3    <authenticationProtocol>AwsSv4</authenticationProtocol>
4    <externalCredentialParameters>
5        <parameterName>FirstAuthUserGroup</parameterName>
6        <parameterType>NamedPrincipal</parameterType>
7        <parameterGroup>Default</parameterGroup>
8        <principal>FirstSamplePermSet</principal>
9        <sequenceNumber>1</sequenceNumber>
10    </externalCredentialParameters>
11    <externalCredentialParameters>
12        <parameterName>SecondAuthUserGroup</parameterName>
13        <parameterType>NamedPrincipal</parameterType>
14        <parameterGroup>Default</parameterGroup>
15        <principal>SecondSamplePermSet</principal>
16        <sequenceNumber>2</sequenceNumber>
17    </externalCredentialParameters>
18</ExternalCredential>

前の定義を参照する 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>ExternalCredential</name>
6    </types>
7    <version>54.0</version>
8</Package>

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

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