Salesforceでは、2027年夏のリリースにて、APIバージョン31.0から64.0までのSOAP API login() が廃止される予定です。API バージョン 65.0 以降ではすでに利用できません。また、新規組織ではデフォルトで無効化されています。
参考:プラットフォームの SOAP API login() の廃止
上記に該当する場合は、マルチセレクトオプションの Salesforce アダプターを OAuth 認証による接続に切り替えてください。本記事では、認証方式ごとの設定手順を説明します。
エラーが発生した場合は、本記事の後半の「トラブルシューティング」をご確認ください。
■ 認証方式の選び方
「認証スキーム」には、複数の認証方法で設定できます。本記事では、主な例として以下の 3 つの方式を説明します。ほかの値については、CData 社のヘルプ「AuthScheme」をご参照ください。
| 方式(認証スキーム) | ブラウザーでの認証 | 特徴 |
|---|---|---|
| 方法1:OAuthPKCE(2608 以降) | 初回のみ必要 | 方法3 の OAuth に、Salesforce が推奨するセキュリティの仕組みである PKCE を加えた方式です。 |
| 方法2:OAuthJWT | 不要 | 証明書で認証します。ブラウザーで認証できない環境に向いています。 |
| 方法3:OAuth | 初回のみ必要 | PKCE を使わない従来の方式です。Salesforce 側で PKCE の必須を外す必要がありますが、新しく作成したアプリケーションでは基本的に外せません。 |
<共通の注意>
- Salesforce の画面は変更される場合があります。本記事と異なる場合は、Salesforce の公式ドキュメント「外部クライアントアプリケーションの作成」をご確認ください。
- Salesforce でアプリケーションを作成・変更してから反映されるまで、最大 10 分ほどかかります。
- 2512 以前は、コネクションの「ユーザー」と「パスワード」が必須項目です。OAuth 認証では使用しないため、任意の値を入力してください。2608 以降は空欄で保存できます。
- 「サンドボックスを使用」は、接続先の組織が本番かサンドボックスかに合わせて設定してください。
■ 方法1:OAuthPKCE で接続する(2608 以降)
2608 から、マルチセレクトオプションのコネクションの OAuth 認証で、PKCE に対応しました。HTTP・SMTP・POP3・IMAP4 などのコネクションの OAuth 認証は対象外です。
Salesforce 側の設定
- Salesforce に管理者権限を持つユーザーでログインし、「設定」-「アプリケーション」-「外部クライアントアプリケーション」-「外部クライアントアプリケーションマネージャー」で「新規外部クライアントアプリケーション」をクリックします。
- アプリケーション名と取引先責任者メールを入力します。
- 「OAuth を有効化」をオンにし、コールバック URL に
http://localhost:33333を入力します。フローサービス管理コンソールから認証する場合は、<補足>もご参照ください。 - OAuth 範囲に、少なくとも「API を使用してユーザーデータを管理 (api)」と「いつでも要求を実行 (refresh_token, offline_access)」を追加します。
- 「サポートされる認証フローに Proof Key for Code Exchange (PKCE) 拡張を要求」はオンのまま、「作成」をクリックします。
- 「設定」タブの「OAuth 設定」で「コンシューマー鍵と秘密」をクリックし、コンシューマー鍵とコンシューマーの秘密を控えます。
ASTERIA Warp 側の設定
[基本] タブ
| 項目 | 設定値 |
|---|---|
| ユーザー/パスワード | 空欄 |
| イニシエートOAuth | REFRESH |
| OAuthクライアントID | コンシューマー鍵 |
| OAuthクライアントシークレット | コンシューマーの秘密 |
| コールバックUrl | http://localhost:33333 |
[詳細] タブ:「認証スキーム」に "OAuthPKCE" を設定します。
フローデザイナーで接続テストを実行するとブラウザーが起動します。Salesforce にログインして「許可」をクリックし、接続テストが成功すれば完了です。以降はブラウザーを使わずに接続します。
<補足>
- フローサービス管理コンソールの接続テストで認証する場合は、Salesforce のコールバック URL に、フローサービス管理コンソール用の URL も追加してください。URL の形式は、「マルチセレクトオプションにおける注意事項」の「OAuth認証」をご参照ください。コネクションの「コールバックUrl」は
http://localhost:33333のままで構いません。ASTERIA Warp のサーバーとは別の端末からフローサービス管理コンソールを開いて認証する場合は、フローサービス管理コンソールで HTTPS 通信を有効にしてください。 -
30 日間使用されなかった更新トークンは失効します。失効した場合は、接続テストを再度実行してブラウザーで認証し直してください。
■ 方法2:OAuthJWT(証明書認証)で接続する
2608 の設定画面をもとに記載しています。2512 以前は一部の項目が [詳細] タブにあるなど画面が異なります。
証明書の準備
Salesforce にアップロードする証明書ファイル .crt と、ASTERIA Warp のサーバーに配置する PFX ファイル .pfx を作成します。OpenSSL を使用する場合の例を以下に記載します。<パスワード> は任意の値に置き換えてください。
openssl genrsa -out salesforce.pem 2048 openssl req -new -x509 -key salesforce.pem -out salesforce.crt -days 3650 -subj "/CN=asteria-warp-jwt" openssl pkcs12 -export -in salesforce.crt -inkey salesforce.pem -out salesforce.pfx -keypbe PBE-SHA1-3DES -certpbe PBE-SHA1-3DES -macalg sha1 -passout pass:<パスワード>
詳細は Salesforce の公式ドキュメント「非公開鍵と自己署名デジタル証明書の作成」をご参照ください。証明書の有効期限が切れると接続できなくなるため、期限を管理してください。上記の例では、有効期限を 3650 日にしています。秘密鍵と PFX ファイルは厳重に管理してください。
Salesforce 側の設定
- 方法1 の手順 1〜4 と同様に、新しい外部クライアントアプリケーションを作成します。コールバック URL は使用しませんが入力が必須のため、
https://の URL か、http://localhostで始まる URL を入力してください。 - 「JWT ベアラーフローを有効化」をオンにし、証明書ファイル
.crtをアップロードして「作成」をクリックします。 - 「ポリシー」タブの「編集」で、「許可されているユーザー」を「管理者が承認したユーザーは事前承認済み」に変更します。
- 「アプリケーションポリシー」で、接続に使用するユーザーのプロファイルを「選択済みプロファイル」に追加して保存します。
- 「設定」タブの「OAuth 設定」で、コンシューマー鍵を控えます。
ASTERIA Warp 側の設定
PFX ファイルを ASTERIA Warp のサーバーに配置してから、コネクションを設定します。
[基本] タブ:「ユーザー」「パスワード」「OAuthクライアントID」「OAuthクライアントシークレット」は空欄にし、「イニシエートOAuth」に "GETANDREFRESH" を設定します。
[詳細] タブ
| オプション名 | 値 |
|---|---|
| 認証スキーム | OAuthJWT |
| OAuth JWT Cert | PFX ファイルの絶対パス。例:C:\cert\salesforce.pfx |
| OAuth JWT Cert Type | PFXFILE |
| OAuth JWT Cert Password | PFX ファイルのパスワード |
| OAuth JWT Issuer | コンシューマー鍵 |
| OAuth JWT Subject | Salesforce の「ユーザー」の「ユーザー名」。メールアドレスとは異なる場合があります。 |
<注意>
- 「OAuth JWT Cert Subject」「SSL Client Cert Type」など、名前が似たオプションと取り違えないようご注意ください。
- PFX 以外の形式を使用する場合は、ご利用のバージョンに対応した CData 社のヘルプで「OAuth JWT Cert Type」の値をご確認ください。バージョンごとの CData 社のヘルプは、「Salesforceアダプターにおける注意事項」の表からご確認いただけます。
接続テストを実行し、ブラウザーが起動せずに成功すれば完了です。
■ 方法3:OAuth で接続する
Salesforce で新しく作成したアプリケーションでは、基本的に PKCE の必須を外すことはできません。外せない場合は、方法1 の OAuthPKCE(2608 以降)または方法2 の OAuthJWT で接続してください。
Salesforce 側:方法1 と同様にアプリケーションを作成し、「PKCE 拡張を要求」のチェックを外します。
ASTERIA Warp 側:以下のとおり設定します。2512 以前は表の項目がすべて [詳細] タブにあり、「ユーザー」と「パスワード」には任意の値を入力します。2608 では、「イニシエートOAuth」「OAuthクライアントID」「OAuthクライアントシークレット」「コールバックUrl」は [基本] タブにあります。
| 項目 | 設定値 |
|---|---|
| 認証スキーム | OAuth |
| コールバック URL | Salesforce 側で設定したコールバック URL |
| イニシエート OAuth | GETANDREFRESH |
| Login URL | カスタムログインエンドポイントを使用している場合のみ設定 |
| OAuth クライアント ID | コンシューマー鍵 |
| OAuth クライアントシークレット | コンシューマーの秘密 |
接続テストを実行してブラウザーで認証します。初回の認証でタイムアウトする場合は、「マルチセレクトオプションで接続テストを実施したときにタイムアウトエラーになります」をご参照ください。更新トークンの失効は、方法1 の<補足>と同じです。
■ トラブルシューティング
Salesforce でコールバック URL を保存するときに「HTTP URL を使用することはできません」と表示される
ASTERIA Warp のサーバーとは別の端末からフローサービス管理コンソールを http:// で開いている場合、その URL はコールバック URL に登録できません。フローサービス管理コンソールで HTTPS 通信を有効にしてください。
ブラウザーに「missing required code challenge」と表示され、接続テストがタイムアウトする
Salesforce 側で PKCE が必須になっているアプリケーションに、認証スキーム "OAuth" で接続しようとしていることが考えられます。2608 以降は方法1 の OAuthPKCE で接続してください。
「invalid_client_id」と表示される
Salesforce でアプリケーションを作成・変更してから、設定が反映される前に接続テストを行ったことが考えられます。10 分ほど待ってから再度お試しください。あわせて、以下をご確認ください。
- コネクションに設定したコンシューマー鍵に誤りがないか
- 「サンドボックスを使用」が接続先の組織に合っているか
「expired access/refresh token」と表示される(方法1・方法3)
更新トークンが失効していることが考えられます。30 日間使用されなかった更新トークンは失効します。接続テストを再度実行し、ブラウザーで認証し直してください。
接続テストの結果に「OAUTH [30004] Failed to retrieve OAuth token information. [invalid_client] invalid client credentials.」と表示される(方法2)
Salesforce にアップロードした証明書と、「OAuth JWT Cert」に指定した PFX ファイルの組み合わせが一致していないことが考えられます。同じときに作成した証明書ファイルと PFX ファイルを使用しているかご確認ください。
「invalid assertion」と表示される(方法2)
以下のいずれかが考えられます。
- 「OAuth JWT Subject」のユーザー名に誤りがある
- Salesforce にアップロードした証明書と PFX ファイルの組み合わせが一致していない
- 「サンドボックスを使用」が接続先の組織に合っていない
接続テストの結果に「OAUTH Could not sign the JWT assertion: Cannot open certificate store: <パス> (指定されたパスが見つかりません。)」と表示される(方法2)
「OAuth JWT Cert」に指定したパスに、PFX ファイルが見つからないことが考えられます。パスに誤りがないか、PFX ファイルを ASTERIA Warp のサーバーに配置したかをご確認ください。
接続テストの結果に「OAUTH Could not sign the JWT assertion: Cannot open certificate store: keystore password was incorrect」と表示される(方法2)
「OAuth JWT Cert Password」が、PFX ファイルのパスワードと一致していないことが考えられます。PFX ファイルを作成したときに指定したパスワードをご確認ください。
「user hasn't approved this consumer」と表示される(方法2)
接続に使用するユーザーのプロファイルが、アプリケーションの「アプリケーションポリシー」に追加されていないことが考えられます。