属性取得API（UserInfoAPI）

2021年8月3日をもちましてYahoo! ID連携 v1の新規の登録を終了いたしました。
2022年4月27日にYahoo! ID連携 v1の利用を終了いたしますのでv2への移行が必要です。
v2の移行方法はこちらよりご確認ください。

属性取得API（UserInfoAPI）

UserInfo APIは、Yahoo! JAPAN ID に登録されているユーザーの属性情報を取得できる属性情報取得APIです。レスポンスはAuthorizationエンドポイントにて指定したscopeパラメータによって変化します。事前に必要な属性に対応するscopeを指定して、ユーザーに同意をとるようにしてください。
ウェブAPI共通で利用するアクセストークンのリクエスト方法およびエラーレスポンスの仕様については、APIアクセス実装方法を参照してください。

今後、属性取得API（UserInfoAPI）から一部情報を取得する場合、アプリケーション詳細画面より
開発するアプリケーションのサイトURLおよびプライバシーポリシーURL、利用規約URLが必須となります。
ご登録されたプライバシーポリシーURL、利用規約URLは、利用者同意画面に表示されます。
対象の属性情報、運用開始時期など詳細は追ってデベロッパーネットワークの更新履歴にてご案内いたします。

リクエスト

URL： https://userinfo.yahooapis.jp/yconnect/v1/attribute
サポートするHTTPメソッド： GET

リクエストパラメーター

サンプルリクエスト

GET /yconnect/v1/attribute?schema=openid HTTP/1.1
Host: userinfo.yahooapis.jp
Authorization: Bearer 2OBRckZjTT5a3aKD......(中略).........mT1oULUNOuUlw3

レスポンス

HTTPコード

200

レスポンスパラメーター

サンプルレスポンス

HTTP/1.1 200 OK
Content-Type: application/json

{
  "user_id": "43M63NAGMHBAYMXRMY3WODOWS4",
  "name": "矢風太郎",
  "given_name": "太郎",
  "given_name#ja-Kana-JP": "タロウ",
  "given_name#ja-Hani-JP": "太郎",
  "family_name": "矢風",
  "family_name#ja-Kana-JP": "ヤフウ",
  "family_name#ja-Hani-JP": "矢風",
  "gender": "male",
  "birthday": "2000",
  "locale": "ja-JP",
  "email": "your_email@example.com",
  "email_verified": true,
  "address": {
    "locality": "港区",
    "region": "東京都",
    "postal_code": "1076211",
    "country": "jp"
  }
}

エラーレスポンス

必須パラメーターがない場合は以下のレスポンスを返します。

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "error" : "invalid_request"
}

弊社サーバーが障害等により、データを返せない場合は以下のレスポンスを返します。

HTTP/1.1 503 Service Unavailable
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
    "error": "server_error",
    "error_description": ""
}

よくある質問（FAQ）

insufficient_scope エラーが返却されます。

アクセストークンを取得する前段階にてお客様の同意を得ていないためです。Authorization エンドポイン トにscope パラメータに含めて同意をとったときに取得できるアクセストークンをご利用ください。

属性情報が空で返却されます。

ユーザーが未登録のデータについては空文字列として返却されます。