ユーザーを一覧表示または検索
このエンドポイントはユーザーの詳細を取得します。多少古い結果でも問題にならない、対話的な検索やベストエフォートでの照会に適しています。次のことが可能です。
- ユーザーの検索条件を指定する
- 返されるユーザーを並べ替える
- 返されるフィールドを選択する
- 1 ページあたりに取得するユーザー数とページのインデックスを指定する
このエンドポイントは重要な処理経路での使用には適していません。データの整合性が最終的に確保される仕組みで、クエリの実行時間も短時間(約 2 秒)に制限されています。そのため、結果が古かったり、負荷の高いクエリでは 503 が返されたりする場合があります。
- このエンドポイントを認証、アカウントの連携、ログインフロー内のアクションのロジックに使用しないでください。代わりに、ID またはメールアドレスでユーザーを直接検索して、現在の状態を取得してください。
- このエンドポイントを使用して外部システムとユーザーデータを同期しないでください。代わりに、Event Streams を購読し、変更が発生するたびに受信してください。
- このエンドポイントを使用してすべてのユーザーを列挙またはエクスポートしないでください。代わりに、ユーザーの一括エクスポートを実行して、全件を取得してください。
q クエリパラメーターを使用すると、クエリ文字列構文で条件に一致するユーザーを検索できます。詳しい手順とガイダンスについては、ユーザーの一覧表示と検索方法を参照してください。
効率よく検索するには、インデックスが付いたトップレベルのフィールドを使い、完全一致で検索してください。自由形式のフィールドや複数値フィールド(app_metadata や user_metadata のユーザー定義属性など)での絞り込みや、先頭にワイルドカードを付けた検索は処理に時間がかかり、タイムアウトする場合があります。
GET
TypeScript
承認
レスポンス
ユーザーを正常に取得しました。
- object[]
- object
このユーザーの電話番号。E.164 の推奨形式に従います。