アプリ
アプリとは、リソース(組織やユーザー、カレンダー、Botなど)を操作する際の、OAuth認証に必要な情報(Client ID、OAuth Scope)やアプリ専用の仮想管理者アカウント(Service Account)など、APIの利用に必要な情報を管理する単位です。
LINE WORKS API 2.0 を利用するには、事前にDevelopers Consoleでアプリを登録する必要があります。
LINE WORKS API 2.0 を利用するにはアプリ情報をもとに認証を行い、取得したAccess TokenでAPIを呼び出します。
アプリを登録する際、設定/発行する情報は下記の通りです。
- アプリ名
- アプリの説明
- Client ID
- Client Secret
- Redirect URL
- Service Account
- Private Key
- OAuth Scope
アプリ名
アプリの名前です。
アプリの説明
アプリの説明です。
Client ID
アプリを識別するIDです。
Authorization Code(認可コード)を発行する際とAccess Tokenを取得する際に使用します。
Client Secret
Access Tokenを取得する際に使用します。
Redirect URL
認証に成功し、Authorization Codeを送付する際のリダイレクト先のURLです。
Authorization Codeを発行する際のRequest Bodyに含まれるredirect_uriパラメータとアプリに登録したRedirect URLが一致するか検証が行われます。
User Account認証を行う場合、Redirect URLの登録は必須です。
- httpsのURLを登録する必要があります。
- サブドメインも個別に登録する必要があります。(例: https://sub.domain).
- 最大100個まで登録可能です。
Service Account
アプリ専用の仮想管理者アカウントです。
Service Accountを発行し、使用することによって、User Account(管理者やメンバーなどを含む、LINE WORKSを利用するすべてのユーザー)の代わりにAccess Tokenを取得することが可能になります。
詳細は「Service Account認証 (JWT)」と「User Account認証 (OAuth)」を参照してください。
Private Key
Service Accountを使用してAccess Tokenを取得する際に必要な認証キーです。
OAuth Scope
OAuth Scopeは、アプリが利用するリソースとその操作権限です。
詳細は「OAuth Scope」を参照してください。