LINEログイン v2.0 APIリファレンス

# LINEログイン v2.0 APIリファレンス

LINEログイン v2.0は非推奨です

このページは旧バージョンのLINEログイン v2.0のAPIリファレンスです。LINEログイン v2.0は非推奨であり、時期は未定ですが廃止を予定しているため、現行バージョン（LINEログイン v2.1）の利用を推奨します。なお廃止時期の告知から、実際の廃止までは一定の猶予期間を置く予定です。LINEログイン v2.1のAPIリファレンスは、「LINEログイン v2.1 APIリファレンス」を参照してください。

# 共通仕様

# レート制限

LINEログインのAPIに対して短時間に大量のリクエストを送信し、LINEプラットフォームの動作に影響を与えると判断された場合、一時的にリクエストを制限することがあります。負荷テストを含め、いかなる目的でも大量のリクエストを送信しないでください。

レート制限のしきい値について

LINEログインのAPIにおけるレート制限のしきい値は開示していません。

# ステータスコード

APIコールの後で、以下のHTTPステータスコードが返されます。ステータスコードの説明は、特に断りがない限り、HTTP status code specification (opens new window)に準拠しています。

ステータスコード 説明
200 OK リクエストが成功しました。
400 Bad Request リクエストに問題があります。リクエストパラメータとJSONの形式を確認してください。
401 Unauthorized Authorizationヘッダーを正しく送信していることを確認してください。
403 Forbidden APIを使用する権限がありません。ご契約中のプランやアカウントに付与されている権限を確認してください。
413 Payload Too Large リクエストのサイズが上限の2MBを超えています。リクエストのサイズを2MB以下にしてリクエストしなおしてください。
429 Too Many Requests 大量のリクエストでレート制限を超過したため、一時的にリクエストを制限しています。
500 Internal Server Error APIサーバーの一時的なエラーです。

# OAuth

# アクセストークンを発行する

アクセストークンを発行します。

LINEログインAPIで管理するアクセストークンは、LINEプラットフォームに保存されているユーザー情報（例：ユーザーID、表示名、プロフィール画像、およびステータスメッセージ）を利用することを、アプリが許可されていることを示します。

レスポンスに含まれるアクセストークンとリフレッシュトークンは、LINEログインAPIを呼び出す際に必要です。

注意

ここでは、LINEログイン v2.0のエンドポイントについて解説します。v2.1については、v2.1の「アクセストークンを発行する」を参照してください。

リクエストの例

# HTTPリクエスト

POST https://api.line.me/v2/oauth/accessToken

# リクエストヘッダー

Content-Type

必須

application/x-www-form-urlencoded

# リクエストボディ

grant_type

String

必須

authorization_code

code

String

必須

LINEプラットフォームから受け取った認可コード

redirect_uri

String

必須

コールバックURL

client_id

String

必須

チャネルID。LINE Developersコンソールで確認できます。

client_secret

String

必須

チャネルシークレット。LINE Developersコンソールで確認できます。

# レスポンス

ステータスコード200と以下の情報を含むJSONオブジェクトを返します。

access_token

String

アクセストークン。有効期間は30日です。

expires_in

Number

アクセストークンの有効期限が切れるまでの秒数

refresh_token

String

新しいアクセストークンを取得するためのトークン（リフレッシュトークン）。アクセストークンの有効期限が切れてから最長10日間有効です。

詳しくは、「アクセストークンを更新する」を参照してください。

scope

String

アクセストークンに付与されている権限

  • P：ユーザーのプロフィール情報にアクセスできます。

token_type

String

Bearer

レスポンスの例

# アクセストークンの有効性を検証する

アクセストークンの有効性を検証します。

アクセストークンを利用して、安全にユーザー登録およびログインを処理する方法については、『LINEログインドキュメント』の「アクセストークンを検証する」を参照してください。

注意

ここでは、LINEログイン v2.0のエンドポイントについて解説します。v2.1については、v2.1の「アクセストークンの有効性を検証する」を参照してください。

リクエストの例

# HTTPリクエスト

POST https://api.line.me/v2/oauth/verify

# リクエストヘッダー

Content-Type

必須

application/x-www-form-urlencoded

# リクエストボディ

access_token

String

アクセストークン

# レスポンス

アクセストークンが有効である場合は、HTTPステータスコード 200 OK と、以下の情報を含むJSONオブジェクトが返されます。

scope

String

アクセストークンに付与されている権限

  • P：ユーザーのプロフィール情報にアクセスできます。

client_id

String

アクセストークンが発行されたチャネルID

expires_in

Number

アクセストークンの有効期限が切れるまでの秒数

レスポンスの例

# エラーレスポンス

アクセストークンの有効期限が切れている場合は、HTTPステータスコード 400 Bad Request と、JSONオブジェクトが返されます。

エラーレスポンスの例

# アクセストークンを更新する

リフレッシュトークンを使って新しいアクセストークンを取得できます。 ユーザーの認証が終わったときに、アクセストークンと共にリフレッシュトークンが返されます。

注意
  • ここでは、LINEログイン v2.0のエンドポイントについて解説します。v2.1については、v2.1の「アクセストークンを更新する」を参照してください。
  • Messaging APIで使用されるチャネルアクセストークンの更新には使用できません。

リクエストの例

# HTTPリクエスト

POST https://api.line.me/v2/oauth/accessToken

# リクエストヘッダー

Content-Type

必須

application/x-www-form-urlencoded

# リクエストボディ

grant_type

String

refresh_token

refresh_token

String

再発行するアクセストークンに対応するリフレッシュトークン。アクセストークンの有効期限が切れてから最長10日間有効です。リフレッシュトークンの有効期限が切れた場合は、ユーザーに再度ログインを要求して新しいアクセストークンを生成する必要があります。

client_id

String

チャネルID。LINE Developersコンソールで確認できます。

client_secret

String

チャネルシークレット。LINE Developersコンソールで確認できます。

# レスポンス

アクセストークンの更新が成功すると、新しいアクセストークンとリフレッシュトークンが返されます。

token_type

String

Bearer

scope

String

アクセストークンに付与されている権限

  • P：ユーザーのプロフィール情報にアクセスできます。

access_token

String

アクセストークン

expires_in

Number

アクセストークンの有効期限が切れるまでの秒数

refresh_token

String

新しいアクセストークンを取得するためのトークン（リフレッシュトークン）。アクセストークンの有効期限が切れてから最長10日間有効です。

レスポンスの例

# エラーレスポンス

リフレッシュトークンの有効期限が切れている場合は、HTTPステータスコード 400 Bad Request と、JSONオブジェクトが返されます。

エラーレスポンスの例

# アクセストークンを取り消す

ユーザーのアクセストークンを無効にします。

注意
  • ここでは、LINEログイン v2.0のエンドポイントについて解説します。v2.1については、v2.1の「アクセストークンを取り消す」を参照してください。
  • Messaging APIで使用されるチャネルアクセストークンの無効化には使用できません。

リクエストの例

# HTTP request

POST https://api.line.me/v2/oauth/revoke

# Request headers

Content-Type

必須

application/x-www-form-urlencoded

# Request body

Request body は form-urlencoded フォーマットになります。

refresh_token

String

無効化するアクセストークンのリフレッシュトークン

# Response

ステータスコード200と空のレスポンスボディを返します。

# プロフィール

# ユーザープロフィールを取得する

ユーザーのユーザーID、表示名、プロフィール画像、およびステータスメッセージを取得します。

リクエストの例

# HTTPリクエスト

GET https://api.line.me/v2/profile

# リクエストヘッダー

Authorization

必須

Bearer {access token}

# レスポンス

userId

String

ユーザーID

displayName

String

ユーザーの表示名

pictureUrl

String

プロフィール画像のURL。スキームはhttpsです。ユーザーがプロフィール画像を設定していない場合はレスポンスに含まれません。

プロフィール画像のサムネイル：

プロフィール画像のURLに、以下のサフィックスを付加すると、プロフィール画像のサムネイルを取得できます。

サフィックス サムネイルサイズ
/large 200 x 200
/small 51 x 51

例：https://profile.line-scdn.net/abcdefghijklmn/large

statusMessage

String

ユーザーのステータスメッセージ。ユーザーがステータスメッセージを設定していない場合はレスポンスに含まれません。

レスポンスの例