認証
ユーザー管理
カスタマイズ
Auth0 AI
プラットフォームユーザーの取得
ユーザーの詳細を取得します。以下の操作が可能です。
- ユーザーの検索条件を指定する
- 返されるユーザーを並べ替える
- 返されるフィールドを選択する
- 1ページあたりに取得するユーザー数とページインデックスを指定する
q クエリパラメーターを使用すると、クエリ文字列構文を使用して、指定した条件に一致するユーザーを取得できます。
ユーザー取得用のAPIエンドポイントを使用する際のベストプラクティスを参照してください。
Auth0 では返すことができるユーザー数に制限があります。このしきい値を超える場合は、検索条件を見直すか、export job または User Import / Export 拡張機能を使用してください。
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
クエリパラメータ
返す結果のページインデックスです。最初のページは0です。
x >= 01ページあたりの結果数です。
0 <= x <= 100結果を、合計件数を含むオブジェクトとして返すか（true）、結果の配列を直接返すか（false、既定値）を指定します。
並べ替えに使用するフィールドです。order には昇順の場合は 1、降順の場合は -1 を指定し、field:order 形式を使用します。例: created_at:1
接続フィルターです。search_engine=v1 を使用する場合にのみ適用されます。search_engine=v2|v3 で接続によるフィルタリングを行うには、q=identities.connection:"connection_name" を使用してください。
結果に含める、または除外するフィールドのカンマ区切りリストです（include_fields に指定した値に基づきます）。すべてのフィールドを取得するには空のままにしてください。
指定したフィールドを含めるか（true）、除外するか（false）を指定します。
Luceneクエリ文字列構文で指定するクエリです。一部のクエリタイプはメタデータフィールドでは使用できません。詳細については、Searchable Fields を参照してください。
検索エンジンのバージョン
v1, v2, v3 true（既定値）の場合、結果は決定的な順序で返されます。false の場合、結果は非決定的な順序で返されることがあり、少数のユーザーを対象とする複雑なクエリではパフォーマンスが向上する可能性があります。一貫した順序付けやページネーションが不要な場合にのみ false に設定してください。
レスポンス
ユーザーを正常に取得しました。
- object[]
- object
このユーザーが読み取り専用でアクセスできるユーザーメタデータ。
このユーザーが管理者によってブロックされている（true）か、されていない（false）か。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーのメールアドレス。
このメールアドレスが確認済み（true）か未確認（false）か。
このユーザーの姓/ラストネーム/名字。
このユーザーの名/ファーストネーム/名。
アカウントがリンクされている場合の、ユーザーのアイデンティティオブジェクトの配列。
このユーザーが最後にログインした IP アドレス。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーのログイン総回数。
このユーザーが登録済みの多要素認証プロバイダーの一覧。
このユーザーが作成された日時（ISO_8601 形式）。
このユーザーの名前。
このユーザーが希望するニックネームまたは別名。
この電話番号が確認済み（true）か未確認（false）か。
このユーザーの picture、写真、またはアバターの URL。
このユーザーが作成された日時（ISO_8601 形式）。
他の API とやり取りする際に使用できる、このユーザーの ID。
このユーザーが読み取りおよび書き込みアクセス権を持つユーザーメタデータ。
このユーザーの username。