OIDC 1.0ユーザー情報の取得
OIDC 1.0で定められたユーザー情報(UserInfo)を返却する
📬 リクエスト
Section titled “📬 リクエスト”GET {userinfo_endpoint}
リクエストヘッダ
Section titled “リクエストヘッダ”| キー | 値 |
|---|---|
| Authorization | Bearer {アクセストークン} |
パスパラメータ
Section titled “パスパラメータ”なし
クエリパラメータ
Section titled “クエリパラメータ”なし
✨ 成功レスポンス
Section titled “✨ 成功レスポンス”ステータスコード
Section titled “ステータスコード”200 : OK
レスポンスヘッダ
Section titled “レスポンスヘッダ”| キー | 値 |
|---|---|
| Content-Type | application/json |
レスポンスボディ
Section titled “レスポンスボディ”| フィールド | 形式 | 必須 | 説明 | 値の例 |
|---|---|---|---|---|
| sub | 文字列 | YES | subjectクレーム | https://example.com/users/user-00000001 |
| user_id | 文字列 | YES | システムユーザーID(非標準クレーム) | user-00000001 |
| user_name | 文字列 | YES | システム内でユニークな値となるシステムユーザー名(非標準クレーム、ログイン時に使用するシステムユーザー名等) | yosuke-tahara@example.com |
| name | 文字列 | YES | 表示用のフルネーム | 田原 陽介 |
| given_name | 文字列 | YES | 名 | 陽介 |
| family_name | 文字列 | NO | 姓 | 田原 |
| 文字列 | NO | メールアドレス | yosuke-tahara@example.com | |
| zoneinfo | 文字列 | YES | タイムゾーン文字列 | Asia/Tokyo |
| locale | 文字列 | YES | ロケール識別子 | ja-JP |
レスポンスボディのサンプル
Section titled “レスポンスボディのサンプル”💬 具体的な要求事項
Section titled “💬 具体的な要求事項”- OIDC 1.0 UserInfoエンドポイント仕様に従い実装してください
その他(補足等)
Section titled “その他(補足等)”- UPWARDからはGETメソッドを用いてUserInfoエンドポイントへリクエストを行います。そのため、POSTメソッドをサポートする必要はありません
- アクセストークンに紐づけられたユーザー識別子を用いてユーザー検索を行ってください
- subフィールド / user_idフィールド
- subフィールドは、貴社システム内で一意になる文字列(例: システムユーザーID)、もしくは、他システムも含めて一意になる文字列(例: ドメインとシステムユーザーIDを組み合わせた文字列)である必要があり、文字列形式の指定はありません
- 対して、user_idフィールドは必ず貴社システムにおけるシステムユーザーIDを設定してください
📚 参考資料
Section titled “📚 参考資料”- OpenID Connect Core 1.0