この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

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

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

NamedCredential

指定ログイン情報を表します。指定ログイン情報では、コールアウトエンドポイントの URL と必要な認証パラメータを 1 つの定義内に指定します。指定ログイン情報は、エンドポイントとして指定できるため、認証コールアウトの設定が簡略化されます。

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

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

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

バージョン

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

項目

項目名 データ型 説明
authProvider string AuthProvider コンポーネントで表される認証プロバイダ。
certificate string 証明書を指定する場合、Salesforce が、各外部システムへの接続確立時に、指定された認証方式に加えて証明書を提供します。この証明書は、要求がユーザの組織からのものであることを確認するデジタル署名に使用されます。
endpoint string コールアウトエンドポイントの URL またはルート URL。ユーザインターフェースの URL に対応します。
label string リストビューなどの Salesforce ユーザインターフェースに表示される、指定ログイン情報のわかりやすい名前。
oauthRefreshToken string OAuth 更新トークン。古いトークンの期限が切れたときに、エンドユーザの新しいアクセストークンを取得するために使用します。
oauthScope string アクセストークンを要求するための権限の範囲を指定します。ユーザインターフェースの [範囲] に対応します。
oauthToken string 認証サーバによって発行されるアクセストークン。
password string 外部システムにアクセスするために組織で使用するパスワード。外部システムにアクセスするための十分な権限がログイン情報にあることを確認します。アクセスの設定方法によっては、システム管理者のパスワードの指定が必要になる場合があります。
principalType External​PrincipalType​ (string 型の列挙) 外部システムの認証用の ID 種別。ユーザインターフェースの [ID 種別] に対応します。有効な値は、次のとおりです。
  • Anonymous
  • PerUser
  • NamedUser
protocol Authentication​Protocol​ (string 型の列挙) 外部システムにアクセスするための認証プロトコル。有効な値は、次のとおりです。
  • NoAuthentication
  • Oauth
  • Password
username string 外部システムにアクセスするために組織で使用するユーザ名。外部システムへのコールアウトを実行するための十分な権限がログイン情報にあることを確認します。アクセスの設定方法によっては、システム管理者のユーザ名の指定が必要になる場合があります。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<NamedCredential xmlns="http://soap.sforce.com/2006/04/metadata">
3<endpoint>https://my_endpoint.example.com</endpoint>
4<label>My Named Credential</label>
5<principalType>PerUser</principalType>
6<protocol>NoAuthentication</protocol>
7</NamedCredential>