Userinfo エンドポイント
Access Token を用いてソーシャルPLUS のユーザー認証情報を取得できるエンドポイント。
GET /oauth2/userinfo
リクエスト
HTTP の Authorization ヘッダーに Token エンドポイント で発行された Access Token を指定します。
Authorization: Bearer {access_token}
リクエストサンプル
curl -X GET https://api.socialplus.jp/oauth2/userinfo \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: Bearer 0fe9cfe59efca93d602abaf8d1a378afd2b1a05e'
共通仕様: FQDN
エラーレスポンス
関連: 共通エラー定義
Authorization ヘッダーが存在しない、または Bearer 形式で指定されていない場合
HTTP ステータスコード 401 Unauthorized とともに、エラーコード（error）を含む JSON オブジェクトを返します。
エラーレスポンス例
HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"error": "unauthorized",
}
指定された Access Token の値が正しくないとき
HTTP ステータスコード 401 Unauthorized とともに、エラーコード（error）を含む JSON オブジェクトを返します。
HTTP レスポンスヘッダーに WWW-Authenticate フィールドを含めて返します。
この形式は以下の仕様に準拠しています。
エラーレスポンス例
HTTP/1.1 401 Unauthorized
Content-Type: application/json
WWW-Authenticate: Bearer error="invalid_token", error_description="The access token is invalid."
{
"error": "unauthorized",
}
成功レスポンス
リクエストに成功すると、HTTP ステータスコード 200 OK と、ユーザー認証情報を含む JSON オブジェクトを返します。
成功時のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"sub": "7b256cf6c3e378d354153d446d2efcc1b3028a8c",
"primary_key": "user_0001",
"provider": "line",
"provider_uid": "dffeaec8592ce668d72b"
}
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sub | string | ○ | ソーシャルPLUS ID |
| primary_key | string | ※ | お客様サービス側ユーザID ※お客様サービス側ユーザID の紐付け が完了している場合のみ返します。値がない場合はパラメータ自体返却されません。 |
| provider | string | ○ | ログインプロバイダ（line, apple, yahoo, google） |
| provider_uid | string | ○ | プロバイダ設定の識別子 |