Documentation Index
Fetch the complete documentation index at: https://auth0-fix-auth-api-docs-migration-completion.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
GET /userinfo
ログイン時に取得したAuth0アクセストークンが指定されると、このエンドポイントはユーザーのプロファイルを返します。このエンドポイントは、openidがアクセストークンのスコープとして付与された場合にのみ機能します。応答に含まれるユーザープロファイル情報は要求されたスコープに応じて異なります。たとえば、スコープがopenidだけの場合は、スコープがopenid profile emailの場合よりも返される情報が少なくなります。
備考
- サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらのリファレンスガイドを参照してください。
-
auth0.js
parseHashメソッドでは、トークンがHS256ではなく、RS256で署名される必要があります。 -
このエンドポイントから
user_metadataまたは他のカスタム情報を返すには、IDトークンにアクションでカスタムクレームを追加します。詳細については、ユーザープロファイルのクレームとスコープを参照してください。 このエンドポイントは3つのHTTP応答ヘッダーを返して、レート制限に関するデータを提供します。 -
X-RateLimit-Limit:1分間に許可される要求の数です。 -
X-RateLimit-Remaining:現在のレート制限枠に残っている要求の数です。新しい要求のたびに、この数が1つ減少します。1分が経過するごとに、要求数が戻され、この数が1ずつ加算されます。 -
X-RateLimit-Reset:レート制限(X-RateLimit-Limit)がリセットされるまでの残り時間です。この値はUTCエポック秒単位です。 -
Emailクレームはログイン時のメールのスナップショットを返します。 -
標準クレーム(
email以外)は(値が外部IdPから来る場合を除き)最新の値を返します。 - カスタムクレームは常にクレームの最新の値を返します。
-
emailまたはカスタムクレームの最新の値にアクセスするには、新しいトークンを取得する必要があります。サイレント認証を使用してログインできます(authorizeエンドポイントへの呼び出しのpromptパラメーターがnoneの場合)。 - 外部IdPを使用して変更された(たとえば、ユーザーがFacebookでメールアドレスを変更するなど)標準クレームの最新の値にアクセスするには、新しいトークンを取得する必要があります。外部IdPを使用して再びログインしますが、サイレント認証は使用しません。
詳しい情報
Response
| Status | Description |
|---|---|
| 200 | ユーザープロファイルが正常に取得されました。 |
| 401 | 認可されていません。アクセストークンが無効か欠けています。 |