WSOFTアカウントのIDトークン
この記事では、WSOFTアカウントのIDトークンについて説明します。
IDトークンとは、ユーザーが正常に認証されたことを証明するトークンです。 IDトークンには、電話帳のようにユーザーのIDや名前などユーザーについての情報を伝える「クレーム」を含んでいます。 IDトークンはJWT(JSON Web Token)形式で送信されます。
IDトークンは、認可の証明として機能するアクセストークンとは異なります。機密クライアントはIDトークンを検証する必要があります。APIを呼び出すことや認可を行うために、IDトークンを使用しないでください。
IDトークンの取得方法¶
WSOFTアカウントで取得できるIDトークンは、以下のエンドポイントから取得できます。
IDトークンの検証方法¶
IDトークンを受けとったら、クライアントアプリケーションは、トークンが改竄されていないかどうかを確認するべきです。IDトークンはJWT形式のため、トークンを検証する既存のライブラリを使用できます。検証処理は自分で実装せず、これらのライブラリを使用することをオススメします。
公開クライアント(たとえば、ユーザーのブラウザーでコードが実行される場合など)は、IDトークンを検証しても安全とは限りません。このシナリオでは、悪意のあるユーザーによって、トークンの検証に使用するための鍵が編集される可能性があります。
IDトークンに含まれる情報¶
IDトークンには、適切なスコープを要求していれば、以下の情報がクレームとして含まれます。
| クレーム | 必要なスコープ | 説明 |
|---|---|---|
sub |
openid |
ユーザーの識別子 |
email |
email |
メールアドレス |
email_verified |
email |
メールアドレスが検証済みかどうか |
name |
profile |
ユーザーが設定している表示名 |
preferred_username |
profile |
ユーザー名 |
picture |
profile |
ユーザーが設定しているアイコン画像へのUrl |
nickname |
profile |
ニックネーム |
locale |
profile |
言語設定 |
zoneinfo |
profile |
タイムゾーン |
gender |
gender |
性別 |
birthdate |
birthdate |
生年月日 |
roles |
roles |
アプリケーション内でのロール |
groups |
groups |
WSOFTグループへの参加状態 |