エンドポイント
GET /userinfo
ログイン時に取得した Auth0 アクセストークン を使って、このエンドポイントからユーザーのプロファイルを取得できます。このエンドポイントを利用できるのは、アクセストークン に openid がスコープとして付与されている場合のみです。レスポンスに含まれるユーザープロファイル情報は、要求したスコープによって異なります。たとえば、openid のみをスコープとして指定した場合は、openid profile email をスコープとして指定した場合より返される情報が少ないことがあります。
注記
- auth0.js スクリプトのサンプルでは、ライブラリのバージョン 8 を使用しています。auth0.js バージョン 7 を使用している場合は、こちらのリファレンスガイドを参照してください。
- auth0.js の
parseHashメソッドを使用するには、トークンがHS256ではなくRS256で署名されている必要があります。 - このエンドポイントから
user_metadataやその他のカスタム情報を返すには、Action を使用して ID Token にカスタムクレームを追加します。詳しくは、User profile claims and scope を参照してください。 - このエンドポイントは、rate limits に関するデータを示す 3 つの HTTP レスポンスヘッダーを返します。
X-RateLimit-Limit: 1 分あたりに許可されるリクエスト数。X-RateLimit-Remaining: 利用可能なリクエスト数。新しいリクエストがあるたびに、この数は 1 ずつ減ります。1 分経過するごとにリクエスト数が回復するため、この数はそのたびに 1 ずつ増えます。X-RateLimit-Reset: rate limit (X-RateLimit-Limit) がリセットされるまでの残り時間。値は UTC epoch seconds で表されます。
Emailクレームは、ログイン時点のメールアドレスのスナップショットを返します。- 標準クレーム (
emailを除く) は最新の値を返します (ただし、その値が外部 IdP から取得されたものである場合を除きます) 。 - カスタムクレームは常に、そのクレームの最新の値を返します。
emailまたはカスタムクレームの最新の値にアクセスするには、新しいトークンを取得する必要があります。サイレント authentication (authorizeエンドポイント の呼び出し時にpromptパラメーターをnoneに設定) を使用してログインできます。- 外部 IdP によって変更された標準クレームの最新の値にアクセスするには (たとえば、ユーザーが Facebook でメールアドレスを変更した場合) 、新しいトークンを取得する必要があります。サイレント authentication は使用せず、外部 IdP を使って再度ログインしてください。
詳細はこちら
ヘッダー
string
必須
string
リクエスト用の DPoP プルーフです。これは任意で、アプリケーションで Demonstrating Proof-of-Possession を使用している場合にのみ必要です。