Postman で LINE WORKS API を試す (公式コレクションを Fork して users/me を呼ぶまで)

LINE WORKS API のコレクションが Postman API Network で公開されています。この記事では、コレクションを自分のワークスペースに Fork し、User Account 認証でアクセストークンを取得して、GET /users/me で自分の情報を取得するまでの手順を紹介します。

概要

LINE WORKS API のコレクションは、2026 年 5 月 15 日のリリースノートで Postman API Network への公開が告知されました。ワークスペース名は「LINE WORKS API」(公開者: WORKS API) です。

• コレクションには Bot / Directory / Calendar / Drive / Mail / AiNote など、サービスごとのフォルダにリクエストが並んでいます (Fork した時点で 605 件)
• 各リクエストには API ドキュメントの説明 (必要な scope、パラメータ) が付いています
• 認証は、コレクション全体で Bearer Token に変数 {{accessToken}} を使う設定になっています。アクセストークンを取得してこの変数に入れるか、コレクションの認証設定を自分の環境に合わせて変えて使います

この記事では、Postman の OAuth 2.0 機能を使って、Postman の画面の中でアクセストークンを取得します。

必要な準備

• Postman のアカウント。この記事ではコレクションの Fork とコレクション変数を使うため、サインインしてワークスペースを使う必要があります。デスクトップアプリはサインインしなくても「lightweight API Client」で単発のリクエストを送れますが、コレクションや変数は使えません (Postman のドキュメント)。この記事は Postman の Web 版 (ブラウザ) で確認しました
• Developer Console でアプリを作成できる権限。一般メンバーの権限では作成できないことが多いので、その場合は管理者にアプリの作成か権限の付与を依頼してください

手順

1. コレクションを Fork する

Postman API Network でコレクション「LINE WORKS API」を開き、Fork を選びます。Fork label (自分用の識別名) と、Fork 先のワークスペースを指定して Fork Collection を押します。この記事では個人用の Personal Workspace に Fork しました。

2. Developer Console でアプリを作成する

Developer Console でアプリを新規作成し、次の 2 つを設定します。

項目	設定値
OAuth Scopes	user.read (この記事で呼ぶ GET /users/me に必要な scope)
Redirect URL	https://oauth.pstmn.io/v1/browser-callback

Redirect URL の値は、Postman の OAuth 2.0 設定の Callback URL の既定値です。

Redirect URL は、入力欄に URL を入れたあと 「追加」ボタンで一覧に加えてから アプリを保存します。入力欄に入れただけで保存すると、Redirect URL は登録されません。

アプリの詳細画面に表示される Client ID と Client Secret は次の手順で使います。

3. コレクションの認証を OAuth 2.0 に変える

Fork したコレクションを開き、Variables タブに変数を 2 つ追加して、それぞれに Client ID と Client Secret を入れます。

Variable	Value
clientId	Developer Console の Client ID
clientSecret	Developer Console の Client Secret

変数の雛形を GitHub に置いています。postman/lineworks.postman_environment.json を Postman にインポートすると、clientId / clientSecret / userId などの変数が環境 (Environment) として用意されます。使い方はリポジトリの README を参照してください。

次に Authorization タブで、Auth type を OAuth 2.0 に変え、「Configure New Token」を次のように設定します。

項目	設定値
Token Name	任意 (例: LINE WORKS User Account)
Grant type	Authorization Code
Callback URL	https://oauth.pstmn.io/v1/browser-callback (既定値のまま)
Auth URL	https://auth.worksmobile.com/oauth2/v2.0/authorize
Access Token URL	https://auth.worksmobile.com/oauth2/v2.0/token
Client ID	{{clientId}}
Client Secret	{{clientSecret}}
Scope	user.read
State	任意の文字列
Client Authentication	Send client credentials in body

設定したら保存します (Ctrl+S)。コレクションの認証設定は、コレクション内の各リクエストに引き継がれます。

4. アクセストークンを取得する

Get new access token を押すと、LINE WORKS のログイン画面が別ウィンドウで開きます。ログインして同意すると、Postman にアクセストークンが登録されます。表示されるダイアログで Use Token を押すと、コレクションの認証にそのトークンが使われます。

取得したトークンは Authorization タブの「Current Token」に表示されます。有効期限もここで確認できます。アクセストークンの有効期限は、Developer Console のアプリの「Access Tokenの有効期限」の設定 (1 hour / 24 hours) で決まります。

5. GET /users/me を呼ぶ

コレクションのリクエストの URL は、パスの ID 部分が変数になっています。たとえば「Directory > ユーザー (メンバー) > ユーザーの取得」は次の URL です。

https://www.worksapis.com/v1.0/users/{{userId}}

{{userId}} の値を入れるため、コレクションの Variables に変数 userId を追加し、値を me にします。

me は、LINE WORKS API 共通仕様の「me キーワード」で説明されている指定方法です。一部の API ではパスの {userId} に me を指定でき、認証されたユーザー自身のリソースに対して API が呼び出されます。共通仕様では例として GET /v1.0/users/me が挙げられています。Service Account 認証 (JWT) で取得したトークンでは me は使えません。

Variable	Value
userId	me

「ユーザーの取得」を開いて Send を押すと、GET https://www.worksapis.com/v1.0/users/me が送られ、200 OK でログインしたユーザーの情報が返ります。

変数 userId がない状態で送ると、{{userId}} という文字列がそのまま URL エンコードされて送られ、404 Not Found になります。

{
    "code": "NOT_FOUND",
    "description": "User ({{userId}}) does not exist."
}

リクエストの Params タブの「Path Variables」には userId のサンプル値が表示されますが、このリクエストの送信には使われませんでした。

注意事項

• scope は呼ぶ API に合わせて追加します。 各リクエストの説明に必要な scope が書かれています。Developer Console のアプリに scope を追加したら、Postman の Scope 欄にも同じ scope を足し (複数ある場合は半角スペース区切り。User Account 認証のドキュメント)、アクセストークンを取得し直します
• 他の ID 変数も同じ要領で追加します。 {{botId}}、{{channelId}} などの変数も、使うリクエストに合わせてコレクション変数に追加します
• me は一部の API でだけ使えます。 コレクション変数 userId を me にしたまま別の API を呼ぶときは、その API のドキュメントで userId に指定できる値を確認します (共通仕様の「me キーワード」)
• Service Account 認証はこの記事では扱っていません。 この記事の手順は User Account 認証 (OAuth 2.0 の Authorization Code) です

続き

同じコレクションを使って、Bot の作成からメッセージの送信、削除までを API で行う手順を続きの記事で紹介しています。

確認した環境

• Postman Web 版 (2026 年 9 月 26 日時点)
• LINE WORKS (User Account 認証、scope user.read)