メタデータ API 開発者ガイド
jNamedCredential
指定ログイン情報を表します。指定ログイン情報では、コールアウトエンドポイントの URL と必要な認証パラメータを 1 つの定義内に指定します。指定ログイン情報は、エンドポイントとして指定できるため、認証コールアウトの設定が簡略化されます。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
NamedCredential コンポーネントのサフィックスは .namedCredential で、namedCredentials フォルダに保存されます。
バージョン
NamedCredential コンポーネントは、API バージョン 33.0 以降で使用できます。
特別なアクセスルール
Spring '20 以降、この型にアクセスできるのは、「設定・定義を参照する」権限を持つユーザのみとなります。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| awsAccessKey | string | プログラムによる AWS への要求の署名に使用されるアクセスキーの 1 つ目のパート。AWS 署名バージョン 4 が認証プロトコルの場合に使用します。この項目は、API バージョン 46.0 以降で使用できます。 |
| awsAccessSecret | string | AWS に対するプログラムを使用した要求に署名するために使用されるアクセスキーの 2 番目の部分。AWS 署名バージョン 4 が認証プロトコルの場合に使用します。この項目は、API バージョン 46.0 以降で使用できます。 |
| awsRegion | string | 指定ログイン情報でアクセスする AWS リージョンを指定します。この項目は、API バージョン 46.0 以降で使用できます。 |
| awsService | string | 指定ログイン情報でアクセスする AWS リソースを指定します。この項目は、API バージョン 46.0 以降で使用できます。 |
| allowMergeFieldsInBody | boolean | コールアウトが行われたときに HTTP リクエストボディに組織データを入力する差し込み項目を Apex コードで使用できるかどうかを指定します。ユーザインターフェースの [HTTP 本文の差し込み項目を許可] に対応します。デフォルトは false です。 この項目は、API バージョン 41.0 以降で使用できます。 |
| allowMergeFieldsInHeader | boolean | コールアウトが行われたときに HTTP ヘッダーに組織データを入力する差し込み項目を Apex コードで使用できるかどうかを指定します。ユーザインターフェースの [HTTP ヘッダーの差し込み項目を許可] に対応します。デフォルトは false です。 この項目は、API バージョン 41.0 以降で使用できます。 |
| authProvider | string | AuthProvider コンポーネントで表される認証プロバイダ。 |
| authTokenEndpointUrl | string | JWT をアクセストークンと交換する場所の URL。この項目は、API バージョン 46.0 以降で使用できます。 |
| certificate | string | 証明書を指定する場合、Salesforce 組織が、各外部システムとの双方向 SSL 接続確立時に証明書を提供します。この証明書は、要求がユーザの Salesforce 組織からのものであることを確認するデジタル署名に使用されます。 |
| endpoint | string | コールアウトエンドポイントの URL またはルート URL。ユーザインターフェースの URL に対応します。 |
| generateAuthorizationHeader | boolean | Salesforce で認証ヘッダーが生成され、指定ログイン情報を参照する各コールアウトに適用されるかどうかを指定します。ユーザインターフェースの [認証ヘッダーを生成] に対応します。デフォルトは true です。 この項目は、API バージョン 41.0 以降で使用できます。 |
| jwtAudience | string | JWT の外部サービスまたはその他の許可された受信者。JSON として記述され、単一の利用者では文字列が引用符で囲まれ、複数の利用者では文字列が引用符で囲まれて配列となります。単一の利用者の例: “aud1”、複数の利用者の例: [“aud1”, “aud2”, “aud3”] |
| jwtFormulaSubject | string | JWT の件名を計算する数式文字列。単一引用符付きの API 参照名と定数文字列を含めることができます。トークンを要求するユーザごとに一意な動的な件名が使用できます。たとえば、'User='+$User.Id です。この項目は、principalType が PerUser に設定されている場合に使用します。ユーザインターフェースの [ユーザごとの件名] に対応します。この項目は API バージョン 46.0 以降で使用できます。 |
| jwtIssuer | string | 大文字と小文字を区別する文字列を使用して JWT の発行者を指定します。この項目は、API バージョン 46.0 以降で使用できます。 |
| jwtSigningCertificate | string | 外部サイトに対する JWT の認証を検証する証明書。この項目は、API バージョン 46.0 以降で使用できます。 |
| jwtTextSubject | string | JWT の件名を指定する引用符なしの静的テキスト。この項目は、principalType が NamedUser に設定されている場合に使用します。ユーザインターフェースの [指定ユーザの件名] に対応します。この項目は API バージョン 46.0 以降で使用できます。 |
| jwtValidityPeriodSeconds | string | トークンが有効な秒数を指定します。この項目は、API バージョン 46.0 以降で使用できます。 |
| label | string | リストビューなどの Salesforce ユーザインターフェースに表示される、指定ログイン情報のわかりやすい名前。 |
| oauthRefreshToken | string | OAuth 更新トークン。トークンの期限が切れたときに、エンドユーザの新しいアクセストークンを取得するために使用します。 |
| oauthScope | string | アクセストークンを要求するための権限の範囲を指定します。ユーザインターフェースの [範囲] に対応します。 |
| oauthToken | string | 認証サーバによって発行されるアクセストークン。 |
| outboundNetworkConnection | string | 指定ログイン情報を使用してコールアウトを AWS に送信する発信ネットワーク接続を指定します。API バージョン 49.0 以降で利用できます。 |
| password | string | 外部システムにアクセスするために組織で使用するパスワード。外部システムにアクセスするための十分な権限がログイン情報にあることを確認します。アクセスの設定方法によっては、システム管理者のパスワードの指定が必要になる場合があります。 |
| principalType | ExternalPrincipalType (string 型の列挙) | 外部システムへのアクセスに 1 セットのログイン情報と複数セットのログイン情報のどちらを使用するかを決定します。ユーザインターフェースの [ID 種別] に対応します。有効な値は、次のとおりです。
|
| protocol | AuthenticationProtocol (string 型の列挙) | 外部システムへのアクセスに必要な認証プロトコル。有効な値は、次のとおりです。
署名バージョン 4 使用する Amazon Web Services への接続には、AwsSig4 を使用します。 直接トークンシステムを使用した接続には、Jwt を選択します。JWT を処理してアクセストークンを返すために中間認証プロバイダを使用している場合は、JwtExchange を使用します。 単純な URL データソースには、NoAuthentication を選択します。 クラウドベースの Files Connect 外部システムにアクセスするには、Oauth を選択します。社内システムには、Password. を選択します。 |
| username | string | 外部システムにアクセスするために組織で使用するユーザ名。外部システムへのコールアウトを実行するための十分な権限がログイン情報にあることを確認します。アクセスの設定方法によっては、システム管理者のユーザ名の指定が必要になる場合があります。 |
宣言的なメタデータの定義のサンプル
NamedCredential コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<NamedCredential xmlns="http://soap.sforce.com/2006/04/metadata">
3 <allowMergeFieldsInBody>false</allowMergeFieldsInBody>
4 <allowMergeFieldsInHeader>false</allowMergeFieldsInHeader>
5 <endpoint>https://my_endpoint.example.com</endpoint>
6 <generateAuthorizationHeader>true</generateAuthorizationHeader>
7 <label>My Named Credential</label>
8 <principalType>Anonymous</principalType>
9 <protocol>NoAuthentication</protocol>
10</NamedCredential>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。