10
6

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

[Salesforce] OAuthを利甚する「認蚌プロバむダ」を䜜成しお、指定ログむン情報ず倖郚デヌタ゜ヌスを定矩したい

10
Posted at

Salesforce では、Apexなどで利甚できる指定ログむン情報をはじめ、倖郚オブゞェクト(Salesforce Connect)やFiles Connectなどなど、シングルサむンオンや倖郚Webシステムぞず接続するための認蚌プロバむダずいう機胜を提䟛しおいたす。認蚌に携わる郚分を集玄するこずで、管理の䞀元化ず単玔化に぀ながりお䟿利です。

なんですが、OAuth での接続をする堎合に少しだけくせがあるので、その蚭定に぀いお説明したす。今回は䟋ずしお、Salesforceクロス組織接続のケヌスです。無償で提䟛される、Salesforceの開発環境が二぀あれば実珟できたすよず蚀うこずです。みなさん、どうぞお䜿いください。

手順ずしおはこうなりたす。

  1. (接続される偎)接続アプリケヌションの䜜成
  2. (接続する偎)認蚌プロバむダの䜜成
  3. (接続される偎)接続アプリケヌションの線集
  4. (接続する偎)指定ログむン情報/倖郚デヌタ゜ヌスの䜜成

ずいう手順になりたす。行ったり来たりになるのは理由があるからなんですΩ ΩΩ< な、なんだっおヌ!!

1. (接続される偎)接続アプリケヌションの䜜成

たずは接続される偎で接続アプリケヌションを䜜成したす。デヌタアクセスを提䟛する偎のSalesforceが、アクセス可胜なナヌザの制埡や、利甚できるAPIなどの制埡を行うための蚭定です。たずこれがないず話になりたせん。

Salesforceの蚭定ペヌゞから操䜜したす。クむック怜玢から「アプリケヌション」ずかで怜玢するか、アプリケヌションカテゎリから、アプリケヌションマネヌゞャをクリックしたす。

Screen Shot 2020-12-30 at 10.59.33.png

おもむろに右䞊の新芏接続アプリケヌションをクリックしたしょう。もう䞀぀ある新芏Lightningアプリケヌションではありたせん。あしからず。新芏接続アプリケヌションです。右偎です。

Screen Shot 2020-12-30 at 11.01.49.png

新芏接続アプリケヌション䜜成時の入力項目

OAuthで接続される堎合には、基本情報の入力必須項目以倖にOAuth 蚭定の有効化が必芁です。逆に蚀えば、そこさえ蚭定すれば良いです。

蚭定項目 蚭定する内容
接続アプリケヌション名 人様が識別するための名前です。分かれば䜕でも良いです。識別できれば
API 参照名 APIで参照するずきに䜿う名前です。必ず英語です。アンスコも䜿えたす。数字もいけた気がしたす
取匕先責任者 メヌル この接続アプリを管理する人のメアド入れおおきたす。なんかあるず通知されたす
コヌルバック URL 今は䜕でもいいです。https:// で始たる䜕か適圓なURLをいれたす
遞択した OAuth 範囲 利甚させるOAuthのスコヌプを定矩したす。考えるのが面倒なテストの時はfullずrefresh_tokenがあれば良いです。refresh_tokenはfullに含たれないのでぜったに蚭定が必芁です

Screen Shot 2020-12-30 at 11.05.29.png

あずはひずたずデフォルトで良いです。なお、Salesforce Connectを利甚する堎合の最䜎限のOAuthスコヌプは、ここにもあるずおり次の四぀です。

  1. Web 経由のデヌタぞのアクセスを提䟛 (web)
  2. デヌタぞのアクセスず管理 (api)
  3. 基本情報ぞのアクセス (id, profile, email, address, phone)
  4. ナヌザに代わっおい぀でも芁求を実行 (refresh_token, offline_access)

refresh_token は重芁です。ここたで入力したら「保存」したす。サヌバ䞊で蚭定が有効になるたで2〜10分埅おず出おきたすが、倧抵すぐ䜿えたす。たたにめっちゃ時間かかりたす。

蚭定に必芁な項目のメモ(コピペする甚)

あずで、認蚌プロバむダを䜜成するずきに必芁な次の項目をメモしおおきたす。どっかに䞀時的にペヌストしおおいずきたしょう。䟿利なこずに、いずれもコピヌボタンが぀いおたす。玠晎らしい。

  1. コンシュヌマ鍵
  2. コンシュヌマの秘密 (クリックしないず出おきたせん)

Screen Shot 2020-12-30 at 11.14.24.png

アクセスするナヌザの远加

この「接続アプリケヌション」を通じおアクセス可胜なナヌザを定矩したす。Manageボタンをクリックしお「接続アプリケヌションの詳现」が衚瀺されたらポリシヌを線集`ボタンを抌したす。

この䞭の「OAuth ポリシヌ」ないの "蚱可されおいるナヌザ" を "管理者が承認したナヌザは事前承認枈み" ぞ倉曎しお保存したす。

Screen Shot 2020-12-30 at 11.18.31.png

するず、䞋の方に「プロファむル」ず「暩限セット」ずいう関連リストが远加されおいたす。ここで脇目も振らず䞀心䞍乱に「プロファむルを管理する」ボタンをクリックしたす。次のような「アプリケヌションプロファむルの割り圓お」画面が衚瀺されたす。ここで、この接続アプリケヌションを通じおアクセスさせたいナヌザの持぀プロファむルを遞択したす。䞀般的に専甚のAPIナヌザを準備したり、システム管理者を利甚するでしょう。そのナヌザに䞎えおいるプロファむルを遞択したす。そのプロファむルを持぀ナヌザしかアクセスできたせん。

Screen Shot 2020-12-30 at 11.20.55.png

2. (接続する偎)認蚌プロバむダの䜜成

さあお、今床は接続したい偎、先ほど接続アプリケヌションを䜜成したSalesforceの組織ぞアクセスする偎の組織で蚭定したす。Salesforceの蚭定画面から「認蚌プロバむダ」ぞアクセスしたす。蚭定の䞋、盞圓䞋、思ったよりも䞋にある「ID」カテゎリ内に「認蚌プロバむダ」がありたす。クむック怜玢した方が早いです。

Screen Shot 2020-12-30 at 11.26.04.png

そちらをクリックしたならば、すぐさた「新芏」です。プロバむダタむプの蚭定画面のみがありたすので、ここから「Salesforce」を遞択したす。ご芧いただければ分かるずおり、2020幎12月珟圚、次の10のプロバむダに察応しおいたす。これ以倖のプロバむダを利甚したい堎合は、カスタム認蚌プロバむダを自䜜するこずも可胜です。拙䜜[Salesforce] カスタム認蚌プロバむダの䜜り方 ~Client Credentials ç·š~もご芧いただけるず幞いです。これみお気が぀きたしたが、Azureどこいった。

Screen Shot 2020-12-30 at 11.28.16.png

蚭定項目 蚭定内容
名前 人様が認識するために必芁なだけの名前です。䜕でもいい
URL 接尟蟞 承認に必芁なさたざたなURLの最埌に付䞎されるものですが、これもAPI識別子みたいなものです。ナニヌクな英語なら䜕でもどうぞ
コンシュヌマ鍵 先ほどコピペしろずいったコンシュヌマ鍵です
コンシュヌマの秘密 同じくコンシュヌマの秘密です
承認゚ンドポむント URL 私のドメむンが蚭定されおいるはずなので、それを指定する方が連携は容易です。デフォルトのたたでもいけたすが、ホスト名の埌ろは必ず /services/oauth2/authorize です
トヌクン゚ンドポむント URL 䞊蚘通りですが、こちらはホスト名以埌は /services/oauth2/tokenに必ずなりたす
デフォルトの範囲 最重芁ポむントです。ここで必ずrefresh_tokenが入らねばなりたせん。それ以倖に必芁なOAuthスコヌプを入れたす

Screen Shot 2020-12-30 at 11.34.14.png

ここたで蚭定できたら「保存」したすね。この埌にも重芁なポむントがありたす。保存された埌の画面にある コヌルバック URL の URLをコピペしおメモしおおきたす。䞋の方の Salesforce 蚭定内にありたすよね。

Screen Shot 2020-12-30 at 11.34.39.png

デフォルトの範囲 に぀いお

Salesforce の認蚌プロバむダでは、デフォルトのOAuthスコヌプにrefresh_tokenの含たれないfullがハヌドコヌドされおいるようです。接続される偎でいくらrefresh_tokenずfullを指定しおあげおも、refresh tokenを取埗したせん。なので必ず、OAuth でrefresh tokenが必芁な堎合には、ここでrefresh_tokenを指定しなければなりたせん。これは、あなた方の矩務です。䜿呜です。

なおrefresh_tokenを指定せず、デフォルトの空欄にしたたた、「倖郚デヌタ゜ヌス」や「指定ログむン情報」を蚭定するずどうなるか。認蚌自䜓は通るのですが、このようなメッセヌゞが出おrefresh tokenが取埗できなかったこずが分かりたす。泚意勧告皋床のメッセヌゞに芋えたすが、はっきり蚀っお利甚できたせん。refresh_tokenを定矩しないず、この認蚌プロバむダは利甚できないに等しいです。

Screen Shot 2020-12-30 at 11.48.23.png

怜玢甚: 認蚌プロバむダが曎新トヌクンを提䟛したせんでした。アクセストヌクンの有効期限が切れるず、組織からこの倖郚デヌタ゜ヌスにアクセスできなくなりたす。

3. (接続される偎)接続アプリケヌションの線集

さお、たたアクセスされる偎に戻りたす。先ほど適圓に定矩したコヌルバックURLを蚭定したす。先ほど䜜成した「接続アプリケヌション」を開き盎しお「線集」したす。そしお、先ほど雑に入力した「コヌルバック URL」郚分を、認蚌プロバむダで定矩された「コヌルバック URL」で䞊曞きしお保存しおあげたす。これで、受け入れ完了です。

Screen Shot 2020-12-30 at 11.36.07.png

4. (接続する偎)指定ログむン情報/倖郚デヌタ゜ヌスの䜜成

あずは利甚するアプリケヌションに埓っお、認蚌プロバむダを利甚するように定矩したす。䞻に「指定ログむン情報」ず「倖郚デヌタ゜ヌス(Salesforce Connectを䜿甚する堎合)」でしょう。いずれも蚭定方法はだいたい同じです。いずれも蚭定を保存するず、Salesforce の認蚌画面が衚瀺されたすので、該圓するナヌザでログむンしおあげれば蚭定完了です。やったぜ(๑•̀ㅂ•́)و✧

なお、ログむン先のURLを指定しなかったり、蚭定しなかったりしおいるような堎合で、か぀ https://login.salesforce.com からのログむンが犁止されおいるずログむンできたせん。URLを指定するか、認蚌時に「カスタムドメむンを䜿甚」ずしお、ドメむンを指定しおログむンしたしょう。

Screen Shot 2020-12-30 at 12.04.54.png

指定ログむン情報の堎合

蚭定名 蚭定内容
衚瀺ラベル なんでもいい(ry
名前 APIずは曞いおたせんが、これもAPIでアクセスする際の識別子なので、英語で指定したす
URL 接続する先のSalesforceのログむンURLを指定したす。login.salesforce.comでもいける気がするけど、私のドメむンで蚭定したカスタムドメむンの方が悔いがありたせん
ID 皮別 ナヌザずするずこのプロバむダを利甚するナヌザごずにログむンするナヌザを指定できたす。指定ナヌザにするず、ここで指定したナヌザですべおのナヌザは倖郚システムぞアクセスするようになりたす
認蚌プロトコル 今回のケヌスでは、もちろんOAuth 2.0を指定したす
認蚌プロバむダ さきほど䜜成した認蚌プロバむダにしたす。倉な名前にするず、こんなこずになるのでオススメしたせん
範囲 認蚌プロバむダで指定した範囲をより狭めお利甚したい堎合にはここで定矩したす

Screen Shot 2020-12-30 at 11.57.24.png

指定ログむン情報を蚭定するず、Apexでのコヌルアりトや倖郚サヌビスで利甚できたす。

倖郚デヌタ゜ヌスの堎合

蚭定名 蚭定内容
倖郚デヌタ゜ヌス なんでもいい(ry
名前 APIずは曞いおたせんが、これもAPIでアクセスする際の識別子なので、英語で指定したす
皮別 Salesforce Connect が利甚する盞手先の皮類を指定したす。今回のケヌスだずSalesforce Connect: クロス組織䞀択です
接続先 察象ずなるSalesforceの環境に合わせお、Production や Sandbox を指定したす。カスタムドメむンを利甚しおいる堎合には、このようにCustom URLにしおURLを定矩するが吉です
URL Custom URLずした堎合には、接続先のURLを指定したす
APIバヌゞョン なるべく最新を。あえお昔のAPIを利甚したい堎合などには、ここで制埡したす
ID 皮別 ナヌザずするずこのプロバむダを利甚するナヌザごずにログむンするナヌザを指定できたす。指定ナヌザにするず、ここで指定したナヌザですべおのナヌザは倖郚システムぞアクセスするようになりたす
認蚌プロトコル 今回のケヌスでは、もちろんOAuth 2.0を指定したす
認蚌プロバむダ さきほど䜜成した認蚌プロバむダにしたす。倉な名前にするず、こんなこずになるのでオススメしたせん
範囲 認蚌プロバむダで指定した範囲をより狭めお利甚したい堎合にはここで定矩したす

Screen Shot 2020-12-30 at 12.02.11.png

倖郚デヌタ゜ヌスを蚭定するず、接続されおいる偎のSalesforceのオブゞェクトぞアクセスが可胜になりたす。保存した埌、「怜蚌しお同期」ボタンをクリックするず「倖郚オブゞェクト」ずしお利甚したいオブゞェクトの遞択画面になりたす。次のように「Account(取匕先)」オブゞェクトを遞択しお「同期」するず倖郚オブゞェクトずしお、盞手先の取匕先オブゞェクトをカスタムオブゞェクトのように利甚できるようになりたす。

Screen Shot 2020-12-30 at 12.24.24.png

ぞぇ.

10
6
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
10
6

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?