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

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

メモ

親種別

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

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

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

バージョン

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

特別なアクセスルール

Spring '20 以降、この型にアクセスできるのは、「設定・定義を参照する」権限を持つユーザーのみとなります。

項目

項目名	説明
allowMergeFieldsInBody	項目の型 boolean 説明コールアウトが行われたときに HTTP リクエストボディに組織データを入力する差し込み項目を Apex コードで使用できるかどうかを指定します。ユーザーインターフェースの [HTTP 本文の差し込み項目を許可] に対応します。デフォルトは `false` です。この項目は、API バージョン 41.0 以降で使用できます。
allowMergeFieldsInHeader	項目の型 boolean 説明コールアウトが行われたときに HTTP ヘッダーに組織データを入力する差し込み項目を Apex コードで使用できるかどうかを指定します。ユーザーインターフェースの [HTTP ヘッダーの差し込み項目を許可] に対応します。デフォルトは `false` です。この項目は、API バージョン 41.0 以降で使用できます。
authProvider	項目の型 string 説明 AuthProvider コンポーネントで表される認証プロバイダー。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
authTokenEndpointUrl	項目の型 string 説明 JWT をアクセストークンと交換する場所の URL。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
awsAccessKey	項目の型 string 説明プログラムによる AWS への要求の署名に使用されるアクセスキーの 1 つ目のパート。AWS 署名バージョン 4 が認証プロトコルの場合に使用します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
awsAccessSecret	項目の型 string 説明 AWS に対するプログラムを使用した要求に署名するために使用されるアクセスキーの 2 番目の部分。AWS 署名バージョン 4 が認証プロトコルの場合に使用します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
awsRegion	項目の型 string 説明指定ログイン情報でアクセスする AWS リージョンを指定します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
awsService	項目の型 string 説明指定ログイン情報でアクセスする AWS リソースを指定します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
certificate	項目の型 string 説明証明書を指定する場合、Salesforce 組織が、各外部システムとの双方向 SSL 接続確立時に証明書を提供します。この証明書は、要求がユーザーの Salesforce 組織からのものであることを確認するデジタル署名に使用されます。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
endpoint	項目の型 string 説明コールアウトエンドポイントの URL またはルート URL。ユーザーインターフェースの URL に対応します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
generateAuthorizationHeader	項目の型 boolean 説明 Salesforce で認証ヘッダーが生成され、指定ログイン情報を参照する各コールアウトに適用されるかどうかを指定します。ユーザーインターフェースの [認証ヘッダーを生成] に対応します。デフォルトは `true` です。この項目は、API バージョン 41.0 以降で使用できます。
jwtAudience	項目の型 string 説明 JWT の外部サービスまたはその他の許可された受信者。JSON として記述され、単一の利用者では文字列が引用符で囲まれ、複数の利用者では文字列が引用符で囲まれて配列となります。単一の利用者の例: “aud1”、複数の利用者の例: [“aud1”, “aud2”, “aud3”]。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
jwtFormulaSubject	項目の型 string 説明 JWT の件名を計算する数式文字列。単一引用符付きの API 参照名と定数文字列を含めることができます。トークンを要求するユーザーごとに一意な動的な件名が使用できます。たとえば、`'User='+$User.Id` です。この項目は、principalType が `PerUser` に設定されている場合に使用します。ユーザーインターフェースの [ユーザーごとの件名] に対応します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
jwtIssuer	項目の型 string 説明大文字と小文字を区別する文字列を使用して JWT の発行者を指定します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
jwtSigningCertificate	項目の型 string 説明外部サイトに対する JWT の認証を検証する証明書。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
jwtTextSubject	項目の型 string 説明 JWT の件名を指定する引用符なしの静的テキスト。この項目は、principalType が `NamedUser` に設定されている場合に使用します。ユーザーインターフェースの [指定ユーザーの件名] に対応します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
jwtValidityPeriodSeconds	項目の型 int 説明トークンが有効な秒数を指定します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
label	項目の型 string 説明必須。リストビューなどの Salesforce ユーザーインターフェースに表示される、指定ログイン情報のわかりやすい名前。
namedCredentialParameters	項目の型 NamedCredentialParameter[] 説明指定ログイン情報の設定に使用される 1 つ以上の NamedCredentialParameter を参照します。この項目は、API バージョン 56.0 以降で使用できます。
namedCredentialType	項目の型 NamedCredentialType (string 型の列挙) 説明この指定ログイン情報の種別または動作を指定します。有効な値は、次のとおりです。 `Legacy`: 指定ログイン情報は従来の種別です。つまり、Winter ‘23 リリースで導入されたスキーマは使用されません。後方互換性のために使用されます。 `PrivateEndpoint`: 指定ログイン情報ではトラフィックがプライベート接続を介して送信され、公開インターネットはスキップされます。ログイン情報種別が `PrivateEndpoint` の場合、OutboundNetworkConnection の値を指定する必要があります。 `SecuredEndpoint`: 指定ログイン情報は拡張性があり、外部ログイン情報を使用して認証と権限を制御します。この項目は、API バージョン 56.0 以降で使用できます。
oauthRefreshToken	項目の型 string 説明 OAuth 更新トークン。トークンの期限が切れたときに、エンドユーザーの新しいアクセストークンを取得するために使用します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
oauthScope	項目の型 string 説明アクセストークンを要求するための権限の範囲を指定します。ユーザーインターフェースの [範囲] に対応します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
oauthToken	項目の型 string 説明認証サーバーによって発行されるアクセストークン。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
outboundNetworkConnection	項目の型 string 説明指定ログイン情報を使用してコールアウトを AWS に送信する発信ネットワーク接続を指定します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 49.0 で初めて使用可能になりましたが、API バージョン 56.0 以降では非推奨になりました。
password	項目の型 string 説明外部システムにアクセスするために組織で使用するパスワード。外部システムにアクセスするための十分な権限がログイン情報にあることを確認します。アクセスの設定方法によっては、システム管理者のパスワードの指定が必要になる場合があります。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
principalType	項目の型 ExternalPrincipalType (string 型の列挙) 説明外部システムへのアクセスに 1 セットのログイン情報と複数セットのログイン情報のどちらを使用するかを決定します。ユーザーインターフェースの [ID 種別] に対応します。値は次のとおりです。 `Anonymous` `NamedUser` `PerUser` この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
protocol	項目の型 AuthenticationProtocol (string 型の列挙) 説明外部システムへのアクセスに必要な認証プロトコル。有効な値は、次のとおりです。 `AwsSv4` `Jwt` `JwtExchange` `NoAuthentication` `Oauth` `Password` 署名バージョン 4 使用する Amazon Web Services への接続には、`AwsSv4` を使用します。直接トークンシステムを使用した接続には、`Jwt` を選択します。JWT を処理してアクセストークンを返すために中間認証プロバイダーを使用している場合は、`JwtExchange` を使用します。単純な URL データソースには、`NoAuthentication` を選択します。クラウドベースの Files Connect 外部システムにアクセスするには、`Oauth` を選択します。社内システムには、`Password`. を選択します。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。
username	項目の型 string 説明外部システムにアクセスするために組織で使用するユーザー名。外部システムへのコールアウトを実行するための十分な権限がログイン情報にあることを確認します。アクセスの設定方法によっては、システム管理者のユーザー名の指定が必要になる場合があります。この項目は、NamedCredentialType が `Legacy` に設定されている場合にのみ有効になります。この項目は API バージョン 56.0 では非推奨です。

NamedCredentialParameter

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

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

項目名	説明
certificate	項目の型 string 説明 parameterType 項目の値が `ClientCertificate` の場合、この項目は証明書を参照します。
description	項目の型 string 説明人が判読可能な、この指定ログイン情報パラメーターの説明。
externalCredential	項目の型 string 説明 parameterType 項目の値が `Authentication` の場合、この項目は、一連の認証済みユーザーログイン情報を参照する外部ログイン情報を参照します。
outboundNetworkConnection	項目の型 string 説明 `OutboundNetworkConnection` パラメーター種別の参照項目です。namedCredentialType が `PrivateEndpoint` の場合に使用されます。
parameterName	項目の型 string 説明必須。指定ログイン情報パラメーターの名前。
parameterType	項目の型 NamedCredentialParamType (string 型の列挙) 説明必須。指定ログイン情報パラメーターの種別。有効な値は、次のとおりです。 `AllowedManagedPackageNamespaces`: 管理パッケージを名前空間の指定によって識別して、指定ログイン情報を使用し、その情報でコールアウトを行うことが許可されます。 `Authentication`: このパラメーターで認証を設定するときに、externalCredential 項目で参照される外部ログイン情報に指定されたログイン情報を使用することを指定します。 `ClientCertificate`: certificate 項目で参照されるクライアント証明書をこのパラメーターで設定することを指定します。 `HttpHeader`: ユーザーは、実行時にコールアウトに追加されるカスタムヘッダーを指定できます。`HttpHeader` を使用する場合、parameterName 項目は文字列のヘッダー名にし、parameterValue は実行時に評価されるヘッダー値の数式にする必要があります。 `OutboundNetworkConnection`: 参照を発信ネットワーク接続に指定します。このパラメーター種別を使用する場合、outboundNetworkConnection 項目は、参照を表す文字列です。namedCredentialType が `PrivateEndpoint` の場合に使用されます。 `Url`: エンドポイントの URL をこのパラメーターで設定することを指定します。実際の URL は parameterValue 項目に保存します。
parameterValue	項目の型 string 説明 parameterType 項目が `Url` などのリテラル値を示している場合、リテラル値はこの項目に保存されます (`https://iam.amazonaws.com/` など)。
sequenceNumber	項目の型 int 説明 `HttpHeader` パラメーターを並べ替えるために使用されます。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<NamedCredential xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>SampleNamedCredential</label>
4    <namedCredentialType>SecuredEndpoint</namedCredentialType>
5    <namedCredentialParameters>
6        <description>IAM Endpoint</description>
7        <parameterName>DefaultEndpoint</parameterName>
8        <parameterType>Url</parameterType>
9        <parameterValue>https://iam.amazonaws.com/</parameterValue>
10    </namedCredentialParameters>
11    <namedCredentialParameters>
12        <description>AWS Auth</description>
13        <parameterName>DefaultAuth</parameterName>
14        <parameterType>Authentication</parameterType>
15        <externalCredential>SampleExternalCredential</externalCredential>
16    </namedCredentialParameters>
17    <namedCredentialParameters>
18        <description>Cert</description>
19        <parameterName>DefaultCert</parameterName>
20        <parameterType>ClientCertificate</parameterType>
21        <certificate>MyCertificate</certificate>
22    </namedCredentialParameters>
23    <allowMergeFieldsInBody>true</allowMergeFieldsInBody>
24    <allowMergeFieldsInHeader>true</allowMergeFieldsInHeader>
25    <generateAuthorizationHeader>true</generateAuthorizationHeader>
26</NamedCredential>

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

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

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