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

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

メモ

親種別

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

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

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

バージョン

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

特別なアクセスルール

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

項目

項目名	説明
authenticationProtocol	項目の型 AuthenticationProtocol (string 型の列挙) 説明必須。外部システムへのアクセスに必要な認証プロトコル。値は次のとおりです。 `AwsSv4` `Custom` — ユーザ作成の認証。権限セット、連番、認証パラメータを指定します。各認証パラメータには名前と値が必要です。 `Jwt` — 今後の使用のために予約されています `JwtExchange` — 今後の使用のために予約されています `NoAuthentication` — 今後の使用のために予約されています `Oauth` `Password` — 今後の使用のために予約されています署名バージョン 4 使用する Amazon Web Services への接続には、`AwsSv4` を使用します。直接トークンシステムを使用した接続には、`Jwt` を選択します。単純な URL データソースの場合、パラメータなしで `Custom` を選択します。クラウドベースの Files Connect 外部システムにアクセスするには、`Oauth` を選択します。社内システムには、`Password`. を選択します。
description	項目の型 string 説明外部ログイン情報のわかりやすい説明。
externalCredentialParameters	項目の型 ExternalCredentialParameter[] 説明外部ログイン情報を詳細に設定する 1 つ以上のパラメータセット。
label	項目の型 string 説明必須。外部ログイン情報の名前。

ExternalCredentialParameter

外部ログイン情報を設定するパラメータを表します。外部ログイン情報パラメータは、種別、名前、値/参照項目の組み合わせで外部ログイン情報コールアウトを設定するために使用されます。API バージョン 56.0 以降で利用できます。

このパラメータは、柔軟なアーキテクチャの提供のために内部的に使用されます。ここでは、パッケージ化の理由で公開しています。

項目名	説明
authProvider	項目の型 string 説明 AuthProvider コンポーネントが表現する認証プロバイダの参照。ログインプロセスを提供し、外部システムへのアクセスを承認するサービスを定義します。
certificate	型 string 説明 parameterType 項目の値が `SigningCertificate` の場合、この項目は証明書を参照します。
description	項目の型 string 説明人間が見てわかる、この外部ログイン情報パラメータの説明。
parameterGroup	項目の型 string 説明パラメータをそれぞれのプリンシパルとともにグループ化します。たとえば、動的な範囲を使用する場合、ユーザが範囲 `AuthParameter` を適用できるのは、parameterGroup 値が一致する特定のプリンシパルに対して認証されたときのみです。 parameterGroup の値が指定されていない場合、parameterGroup はデフォルトで PER_USER と NAMED_PRINCIPAL の parameterName の値に設定されます。それ以外のパラメータの場合、parameterGroup はデフォルトで DEFAULT_GROUP に設定されます。
parameterName	項目の型 string 説明必須。外部ログイン情報パラメータの名前。
parameterType	項目の型 ExternalCredentialParamType (string 型の列挙) 説明必須。外部ログイン情報パラメータの種別。この項目の値によってパラメータの動作が決まります。値は次のとおりです。 `AuthHeader`: ユーザは、実行時にコールアウトに追加されるカスタム認証ヘッダーを指定できます。`AuthHeader` を使用する場合、parameterName 項目は文字列のヘッダー名にし、parameterValue は実行時に評価されるヘッダー値の数式にする必要があります。sequenceNumber はコールアウトでヘッダーを送信する順序を決定します。最初に番号の低いヘッダーから送信されます。 `AuthParameter`: ユーザによる認証設定の追加を許可します。parameterName は、設定するパラメータを定義します。たとえば、`AwsRegion` は AWS Signature V4 認証プロトコルに適用する AWS Region パラメータを設定し、parameterValue は AWS リージョンの値です。 `AuthProtocolVariant`: 認証プロトコルのバリエーションを指定するために使用します。たとえば、ParameterName が `AwsSv4` で ParameterValue が `AwsSv4_STS` の場合、`Aws Sts` がバリエーションになります。 `AuthProvider`: authProvider 項目で参照される認証プロバイダをこのパラメータで設定することを指定します。 `AuthProviderUrl`: 認証エンドポイント URL を指定します。たとえば、認証種別が OAuth with JWT Bearer Flow の場合、parameterValue が認証トークンエンドポイントになります。 `AuthProviderUrlQueryParameter`: ユーザは、実行時に認証プロバイダのコールアウトに追加されるカスタムクエリパラメータを指定できます。現在、STS を使用した AWS Signature V4 のみをサポートしています。`AuthProviderUrlQueryParameter` で使用可能な値は、AWS STS で使用する `AwsExternalId` と `AwsDuration` です。 `AwsStsPrincipal`: AWS Signature V4 を STS とともに設定します。parameterName は `AwsStsPrincipal` で、parameterValue は未指定です。 `JwtBodyClaim`: JWT (JSON Web トークン) ボディクレームを指定します。parameterName はキーで、parameterValue は値です。たとえば、JWT 利用者のパラメータ名は `aud` です。 `JwtHeaderClaim`: JWT ヘッダークレームを指定します。parameterName はキーで、parameterValue は値です。たとえば、JWT 鍵識別子のパラメータ名は `kid` です。 `NamedPrincipal`: パラメータで使用するユーザログイン情報のセットを、外部システムにアクセスするすべてのユーザに対して同じにすることを指定します。 `PerUserPrincipal`: 個人ユーザレベルでのアクセス制御を提供します。 `SigningCertificate`: 認証の署名に使用する証明書を指定します。certificate 項目を使用して、証明書名を指定します。OAuth with JWT Bearer Flow と RolesAnywhere を使用した AwsSv4 STS の認証に使用します。
parameterValue	項目の型 string 説明 parameterType 項目がリテラル値を示している場合、この項目にはリテラル値が保存されます。
principal	項目の型 string 説明 parameterType 項目の値が `NamedPrincipal` または `PerUserPrincipal` の場合、この項目は権限セットを参照します。ログイン情報プロバイダから提供されるログイン情報が使用可能な一連のユーザは、その値によって決定されます。parameterName 項目の値は、このプリンシパルの名前を指定します。この項目は API バージョン 56.0 で初めて使用可能になりましたが、API バージョン 58.0 以降では削除されました。
sequenceNumber	項目の型 int 説明ユーザが参加しているプリンシパルが複数あるときに適用するプリンシパルの順序を指定します。たとえば、ユーザは、ログイン情報プロバイダで適用される複数の権限セットに割り当てることができます。優先度は、番号の小さい方が高くなります。この項目を設定できるのは、parameterType が `NamedPrincipal` の場合のみです。

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

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

1<ExternalCredential xmlns="http://soap.sforce.com/2006/04/metadata">
2    <label>SampleExternalCredential</label>
3    <authenticationProtocol>AwsSv4</authenticationProtocol>
4    <externalCredentialParameters>
5        <parameterName>Principal</parameterName>
6        <parameterType>NamedPrincipal</parameterType>
7        <sequenceNumber>1</sequenceNumber>
8    </externalCredentialParameters>
9    <externalCredentialParameters>
10        <parameterName>AwsService</parameterName>
11        <parameterValue>iam</parameterValue>
12        <parameterType>AuthParameter</parameterType>
13    </externalCredentialParameters>
14    <externalCredentialParameters>
15        <parameterName>AwsRegion</parameterName>
16        <parameterValue>us-east-1</parameterValue>
17        <parameterType>AuthParameter</parameterType>
18    </externalCredentialParameters>
19</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>56.0</version>
8</Package>

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

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