GET /userinfo
ログイン時に取得した Auth0 アクセストークンを指定すると、このエンドポイントはユーザープロフィールを返します。このエンドポイントは、アクセストークンに openid スコープが付与されている場合にのみ機能します。レスポンスに含まれるユーザープロフィール情報は、要求したスコープによって異なります。たとえば、スコープが openid のみの場合、openid profile email の場合より返される情報が少なくなることがあります。
注記
- サンプルの auth0.js スクリプトでは、ライブラリのバージョン 8 を使用しています。auth0.js バージョン 7 を使用している場合は、このリファレンスガイドを参照してください。
- auth0.js の
parseHashメソッドでは、トークンがHS256ではなくRS256で署名されている必要があります。 - このエンドポイントから
user_metadataやその他のカスタム情報を返すには、Action を使用して IDトークンにカスタムクレームを追加します。詳細については、ユーザープロファイルのクレームとスコープを参照してください。 - このエンドポイントは、レート制限に関する情報を提供する 3 つの HTTP レスポンスヘッダーを返します。
X-RateLimit-Limit: 1 分あたりに許可されるリクエスト数。X-RateLimit-Remaining: 利用可能なリクエスト数。リクエストを 1 回送信するたびに、この値は 1 減少します。1 分経過するごとにリクエスト数が 1 回分復元されるため、そのたびにこの値は 1 増加します。X-RateLimit-Reset: レート制限 (X-RateLimit-Limit) がリセットされるまでの残り時間。値は UTC エポック秒です。
Emailクレームは、ログイン時点のメールアドレスの値を返します。- 標準クレーム (
emailを除く) は最新の値を返します (ただし、その値が外部 IdP に由来する場合を除きます) 。 - カスタムクレームは常に最新の値を返します。
emailまたはカスタムクレームの最新の値にアクセスするには、新しいトークンを取得する必要があります。サイレント認証を使用してログインできます (authorizeendpoint の呼び出しでpromptパラメーターをnoneに設定します) 。- 外部 IdP によって変更された標準クレームの最新の値にアクセスするには (たとえば、ユーザーが Facebook でメールアドレスを変更した場合) 、新しいトークンを取得する必要があります。サイレント認証は使用せず、外部 IdP を使って再度ログインしてください。
詳細情報
パラメーター
リクエストの DPoP 証明です。省略可能で、アプリケーションで所有証明 (DPoP) を使用している場合にのみ必要です。
レスポンス
| ステータス | 説明 |
|---|---|
| 200 | ユーザープロフィールを正常に取得しました。 |
| 401 | 認証されていません。アクセストークンが無効か、指定されていません。 |