Skip to main content
GET
認証済みユーザーのプロフィールを取得します。

承認

Authorization
string
header
必須

Bearer トークンと DPoP トークンは、API の設定に応じてサポートされます

ヘッダー

x-correlation-id
string

Auth0システム全体でリクエストを関連付けるために使用する、クライアントが指定する1回の操作の一意識別子です。この値はテナントログのreferences.correlation_idに表示され、レスポンスのx-correlation-idヘッダーで返されます。無効または大きすぎる値は通知なく破棄され、生成されたUUID v4に置き換えられます。個人を特定できる情報(PII)は含めないでください。

traceparent
string

分散トレース全体でリクエストを関連付けるために使用するW3C Trace Contextヘッダーです。指定された場合は受信トレースが継続され、新しい子スパンがレスポンスのtraceparentヘッダーで返されます。トレースIDはテナントログのreferences.trace_idにも表示されます。形式が不正な値は無視されます。

クエリパラメータ

fields
enum<string>[]

含める、または除外するフィールド名のカンマ区切りの一覧(include_fieldsの値によって決まります)。

利用可能なオプション:
given_name,
family_name,
name,
nickname,
picture,
email,
phone_number,
username,
user_metadata,
created_at,
updated_at,
profile_policy
include_fields
enum<string>
デフォルト:true

true(デフォルト)の場合、fieldsで指定されたフィールドのみを返します。falseの場合、fieldsで指定されたフィールド以外のすべてのフィールドを返します。

利用可能なオプション:
true,
false

レスポンス

プロフィールを正常に取得しました。

フィールドごとの読み取り・書き込み可否を示すアクセス ポリシーを含む、セルフサービスで管理可能な認証済みユーザーのプロフィール属性。

given_name
string

このユーザーの名(ファーストネーム/下の名前)。

family_name
string

このユーザーの姓(ラストネーム/名字)。

name
string

このユーザーの名前。

nickname
string

このユーザーが希望するニックネームまたは別名。

picture
string

このユーザーの画像、写真、またはアバターのURL。

email
string<email>
read-only

読み取り専用。メールアドレスの管理には、/me/v1/identifiersを使用してください。

phone_number
string
read-only

読み取り専用。電話番号の管理には、/me/v1/identifiersを使用してください。

username
string
read-only

読み取り専用。ユーザー名の管理には、/me/v1/identifiersを使用してください。

user_metadata
object
read-only

このバージョンでは読み取り専用です。user_metadataへの書き込みは、今後のリリースで対応予定です。

created_at
string<date-time>
read-only

このユーザーが作成された日時。

updated_at
string<date-time>
read-only

このユーザーが最後に更新または変更された日時。

profile_policy
object
read-only

RFC 6901 JSON Pointer(例: /email)をキーとするフィールドごとの書き込み可否。