3.2 スコープ｜SPIRAL PLACE API

スコープは、アプリがアクセスできるSPIRAL PLACEの情報の範囲を定めたものです。

アプリは認証時にユーザーに対してアクセスするスコープを提示し、ユーザーはスコープの情報も
含めてアプリを許可します。

アプリはユーザーに許可されたスコープ外の情報にアクセスすることはできません。
スコープを変更する場合は、ユーザーに再度アプリのアクセスを求める必要があります。

スコープの適用範囲

基本的にはそのスコープの対象とするリソースを操作するAPIのみを利用可能です。

ただし、関連リソースについては、関連リソースのスコープを許可されていなくてもアクセスすることができます。

例：
「profile」スコープで認可ユーザーの参加しているグループリストを取得可能
「group」スコープでグループに参加しているスタッフリストを取得可能

ユーザー権限とスコープ

アプリが指定するスコープが対象とする操作の権限をユーザーが持っていない場合、アプリ認証時に
エラー画面が表示されます。

例えば、アドミン権限のないユーザーは「staff.manage」や「facility.manage」などのスコープを要求するアプリを利用することはできません。

また、既に許可済みのアプリであっても、許可後にユーザーの権限が変更され許可されたスコープに
対する権限がなくなった場合はAPIリクエスト時にエラーレスポンスを返します。

スコープ一覧

スコープ	説明	権限ユーザー	リソース
user	全ユーザーの情報へのアクセス（閲覧のみ）	スタッフ	スタッフ
facility	施設情報へのアクセス	スタッフ	設備・施設
facility.manage	施設情報へのアクセス・管理	アドミン	設備・施設
group	グループ情報へのアクセス（閲覧のみ）	アドミン	グループ
group.manage	グループ情報へのアクセス・管理	アドミン	グループ
event	予定情報へのアクセス（閲覧のみ）	スタッフ	予定
event.manage	予定情報へのアクセス・管理	スタッフ	予定
message	あなたのトピック情報へのアクセス（参照のみ）	スタッフ	トピック
message.manage	あなたのトピック情報へのアクセス・管理	スタッフ	トピック
message.manage(関連リソース)	あなたのトピック情報へのアクセス・管理（コメントなどの関連リソース）	スタッフ	トピック
task	あなたのタスク情報へのアクセス（参照のみ）	スタッフ	タスク
task.manage	あなたのタスク情報へのアクセス・管理	スタッフ	タスク
telephone_memo	電話メモの作成	スタッフ	タスク
notification	新着通知情報へのアクセス	スタッフ	新着通知
service_info	スパイラル株式会社からのお知らせへのアクセス	スタッフ	スパイラル株式会社からのお知らせ

スコープの競合

権限が競合する以下のスコープを同時に指定することはできません。