mixi Developer Center (ミクシィ デベロッパーセンター)

UserInfo APIはOpenID Connectという認証連携の標準化プロトコルでUserInfo Endpointとして定義されている、ユーザの属性情報を提供するAPIです。
OpenID Connect Core 1.0 (http://openid.net/specs/openid-connect-core-1_0.html)

UserInfo APIによってユーザの識別子、mixiに蓄積されているプロフィール情報、ログイン時に利用しているメールアドレスなど、認可したユーザーの基本的な属性情報を標準化されたフォーマットで取得できます。あなたのアプリケーションの新規アカウント登録時などにこれらの情報を使うことで、ユーザの"いつもの情報"を入力する手間を省くことができ、使い勝手の向上へとつながるでしょう。

ここでは、UserInfo APIの使用方法について説明します。

事前に必要なもの

UserInfo APIを利用するためには、以下の情報をすでに入手している必要があります。

• "openid"スコープについて認可されたアクセストークン
• "openid"と"profile"、"email"スコープのいずれかもしくは両方の組み合わせについて認可されたアクセストークン

上記以外のスコープで認可されたアクセストークンを使用して、UserInfo APIにアクセスすることはできません。アクセストークンの入手方法については、認証認可手順のページをご覧ください。

属性情報の取得

認可したユーザ本人の属性情報を取得するためのURIは以下となります。メソッドはGETとPOSTの両方に対応しています。

https://api.mixi-platform.com/2/openid/userinfo

アクセストークン以外にリクエストパラメータ、リクエストボディには何も指定する必要はありません。
ユーザが認可したスコープの値により、取得できる属性情報が異なります。

"profile"、"email"の２つのスコープについては、ユーザが個別に属性情報へのアクセスを拒否することができます。拒否されたscopeに対してはUserInfo APIのレスポンスに対応する属性情報が含まれません。
以下はレスポンスの一例です。フォーマットはJSON形式となります。

{
    "sub":"qgjw87yg3djw",
    "name":"アヤコ",
    "given_name":"彩子",
    "family_name":"佐藤",
    "nickname":"アヤコ",
    "preferred_username" :"アヤコ",
    "profile" : "http://mixi.jp/redirect_friend_api.pl?puid=qgjw87yg3djw&client_id=xxxxx",
    "picture" : "http://mixi.jp/photo/user/rdqz7s6ew176q_2105834213.jpg",
    "gender":"female",
    "birthdate":"1980-04-10",
    "email":"ayako@example.com",
    "email_verified":true
}