OAuth Scopes

OAuth Scope (以降、Scope) とは、アプリが利用するリソース (resource) と、その操作権限 (operation) の組み合わせです。
アプリで必要となる Scope を、Developer Console でアプリごとに設定します。 アプリで設定した Scope の中から必要な Scope を指定して認証を行うことで、取得した Access Token に Scope が反映されます。

API の呼び出しには、呼び出す API に対して必要な Scope が反映された Access Token を使用する必要があります。API が必要とする Scope は、各 API のドキュメントを参照してください。

Scope の形式 {#scope-format}

Scope は resource.operation の形式で表現します。

リソース (resource) とは、LINE WORKS が提供する機能や管理データを意味します。例えば、user はユーザー情報を、group はグループ情報、bot は Bot 機能を示します。
オペレーション (operation) とは、該当するリソースの操作権限です。例えば、user リソースは 2 つのオペレーションを選択できます。

• user : Read / Write
• user.read : Read

user Scope では、ユーザーリソースの Read / Write API を呼び出すことが可能です。一方、user.read Scope では、ユーザーリソースを参照する Read API は利用できますが、新規ユーザーを追加したり、既存ユーザーを削除する Write API は利用はできません。
リソースとオペレーションからなる Scope により、アプリが操作するデータと操作内容を制御できます。アプリの動作に必要のない Scope を付与しないことを推奨します。

アプリで利用する Scope は、アプリ単位で指定します。アプリで利用できる Scope は、利用プランなどにより、ドメインごとに異なります。
API の Scope は、HTTP メソッドから推測できます。例えば、user resource に関する Scope で利用できる HTTP メソッドは以下の通りです。

• user : GET / POST / PUT / PATCH / DELETE
• user.read : GET

Scope リスト {#scope-list}

Developer Console のアプリ設定で提供する Scope と、利用可能なプランは以下のとおりです。

LINE WORKSサービス {#line-works}

※ パートナードメインでのみ利用可能

LINE WORKS AiNote サービス {#ainote}

LINE WORKSラジャーサービス {#roger}

LINE WORKS PaperOnサービス {#paperon}

LINE WORKS AiStudioサービス {#aistudio}