指定ログイン情報を使用するカスタムヘッダーの使用事例

指定ログイン情報は HTTP の世界で動作するため、パラメーターのプロビジョニングは、コールしているサービスで必要な追加の入力として機能するヘッダーを伴う HTTP 要求として実装されます。HTTP 要求にはヘッダーと本文があり、入力は両方に表示される可能性があります。また、入力がクエリ文字列として URL に表示されることもよくあります。3 つすべての方法にプラス面とマイナス面があります。ここではヘッダーのみについて説明します。

ユーザーごとのコールアウト

多くのシステムは、要求を行ったユーザーまたはロールに基づいて異なる方法で HTTP 要求に応答します。たとえば、会社とのインテグレーションにより個人の電話番号が返されることがありますが、その電話番号を持つ個人がコールアウト要求を行った場合に限られます。ただし、会社の HR 部門のコール元ユーザーはユーザーの給与を参照できますが、HR ロールが指定されている必要があります。

次に、カスタムヘッダーを使用してメールアドレスでユーザーを識別するユーザーごとのコールアウトの例を示します。

GET https://example.com/getInfo?personId=my_username%40example.com/HTTP/1.1
X-Calling-User:my_username@example.com

別の例として、Microsoft は企業全体の検索サービスを提供し、コール元の ID に基づいて異なる結果を返しています。ユーザーは表示が許可されていない結果を取得しません。Salesforce の指定ログイン情報ではこのサービスがサポートされます。システム管理者が X-Calling-User などのヘッダーを定義して、コールアウトを実行したユーザーの値 ({!$User.email} など) を置き換えることができるためです。ヘッダーは外部ログイン情報で定義されます。

ヒント 外部ログイン情報のカスタムヘッダーで数式を使用していて、[ID 種別] として [指定ユーザー] を選択した場合、数式で $User を使用しないでください。

API キー

API キーは、特定の API にアクセスしようとしているコール元アプリケーションを識別するために HTTP 要求で使用される、プログラムによるパスワードを指します。API キーには厳格な標準がないため、API を作成するすべてのユーザーが独自のヘッダーやルールなどを定義できます。

API キーを使用するコールアウトの例を次に示します。

GET https://example.com/api/11a5aea0?count=20 HTTP/1.1
X-API-Key: abc123

X-API-Key は任意であり、一部のベンダーでは Client-ID などのヘッダーを使用します。この例では、ランダムな写真を取得するために、Client-ID と標準の認証ヘッダーの組み合わせを使用します。

GET https://example.com/photos/random_HTTP/1.1
Authorization: Client-ID abc123

API キーを含むカスタムヘッダーを使用する外部ログイン情報は、次のようになります。

• このログイン情報ではカスタム認証プロトコルを使用しています。
• Load Stock Photos プリンシパルが使用されています。
• 独自のカスタムヘッダーを持つことができる指定ログイン情報 [Random Stock Photo] にリンクされています。
• AccessKey はプリンシパルで定義されています。

「指定ログイン情報を使用したカスタムヘッダーでの API キーの使用」を参照してください。

指定ログイン情報のカスタムヘッダー

ヘッダーが 1 つのエンドポイントに関係している場合、指定ログイン情報のレベルでカスタムヘッダーを定義します。指定ログイン情報でより適切に機能するヘッダーの例として、請求識別子があります。ほとんどの場合、この種別の識別子は認証やセキュリティとは無関係であり、エンドポイントごとに異なる可能性があります。

GET https://example.com/method?abc=def HTTP/1.1
X-Billing-Code: costCenter123