ご利用可能なスコープ
MT LINK APIのOAuth 2.0上のスコープ（scope）について
スコープについて
MT LINK APIは、OAuth 2.0のスコープ機能（アクセスが可能な範囲を制限機能）により、利用者のデータへのアクセスを制限しております。例えば、利用者がポイント残高の情報だけを認可している場合、points_readのスコープが紐づいているアクセストークンがクライアント様に発行されます。
MT LINK APIに対してアクセストークンを設定しリクエストをする際、トークンに紐づいているスコープと当該APIのスコープが比較され、利用可否が判定されます。原則として該当するスコープがない場合、HTTPのステータスコードの403 Forbiddenが返されます（ここでの説明は参考情報であり、各API仕様と相違がある場合、各API仕様を優先する仕様です）。
MT LINKにおいてアクセスしたいデータを特定し、それに沿ってスコープを認可フロー時に要求します。
スコープの一覧
| スコープ名 | 認可画面上の利用者への説明 |
|---|---|
guest_read | Moneytreeアカウントの基本情報（メールアドレス、言語、地域）の閲覧 |
accounts_read | Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの名称、口座の種別、残高の閲覧 |
transactions_read | Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの明細の閲覧 |
transactions_write | Moneytreeに登録している銀行口座、クレジットカード、デビットカード、電子マネーの明細のカテゴリやメモの編集 |
request_refresh | Moneytreeに登録している金融サービスの資産情報の取得 |
investment_accounts_read | Moneytreeに登録している投資用口座（投資信託、株式、確定拠出年金）の名称、口座の種別、残高の閲覧 |
investment_transactions_read | Moneytreeに登録している保有銘柄の明細の閲覧 |
points_read | Moneytreeに登録しているポイントの名称、残高、明細の閲覧 |
life_insurance_read | Moneytreeに登録している生命保険の契約内容の閲覧 |
life_insurance_readについて
life_insurance_readはスコープとして存在しますが、正式なMT LINK APIとして一般公開はしておりません。ご利用される場合、営業またはカスタマーサクセスチームにご連絡ください。
認可要求時の例
直接認可（Authorize）URLを呼び出す場合、スコープは、スペースを使って一つの文字列にし、URLをエンコード（RFC1866に参照）します。
?client_id=abc&response_type=code&state=xyz&redirect_uri=https%3A%2F%2Ffoo.bar%2F&scope=guest_read+accounts_read+transactions_read
Updated 18 days ago