検索クエリを使用してユーザーを一覧表示・検索する方法

Auth0 Dashboard または Management API を使用すると、ユーザー一覧を取得し、指定した検索条件で結果を絞り込むことができます。

ユーザーの一覧表示と検索

Auth0 Dashboard
Management API

ユーザーの一覧を表示するには、Auth0 Dashboard > User Management > Usersに移動します。

ページ上部の検索フィールドとドロップダウンメニューで、次のプロパティを指定して検索できます。

ユーザー
メール
アイデンティティプロバイダー
接続
組織ID
ログイン回数
最終ログイン
電話番号

Lucene Syntax (Advanced) を選択して、検索条件を指定することもできます。検索クエリ構文リファレンスでは、サポートされている検索機能とクエリの例について詳しく説明しています。

Management API ですべてのユーザーを一覧表示するには、List or Search Users endpoint (GET /users) を呼び出します。ユーザーを検索するには、q クエリパラメーターとLucene 検索クエリ文字列を使用して検索条件を指定します。

List または Search Users エンドポイントは、レイテンシーの影響を受けやすい処理や、正確性が重要な処理での使用には適していません。このエンドポイントは最終的整合性 (eventually consistent) であり、クエリの制限時間も短く設定されています。詳しくは、ユーザー検索の代替手段、制限、パフォーマンスのベストプラクティスを参照してください。

たとえば、名前が example と完全に一致するユーザーを検索するには:

Auth0 CLI をお使いですか？まだの場合は、このコマンドを実行する前にCLI セッションのセットアップと認証を行ってください。

検索クエリが2秒以内に完了しない場合、タイムアウトします (HTTP ステータスコード 503)。検索クエリがタイムアウトする場合、それは処理負荷の高いクエリであるか、時間内に完了しないエラーが含まれている可能性があります。エラー 414 Request-URI Too Large は、クエリ文字列がサポートされている最大長を超えていることを示します。この場合は、検索条件を絞り込んでください。検索クエリ構文リファレンスには、サポートされている検索機能とクエリの例に関する詳細が記載されています。

結果を並べ替える

Auth0 Dashboard
Management API

Auth0 Dashboard では、ユーザー一覧に表示される列を選択して、結果を並べ替えることができます。

名前
ユーザー ID
接続
ログイン数
最終ログイン

列の見出しを1回選択すると昇順に、もう一度選択すると降順に並べ替えられます。ほかのフィールドで結果を並べ替えるには、Management API を使用します。

ユーザー検索結果を並べ替えるには、sort クエリパラメータをfield:orderの値に設定します。各要素は次のとおりです。

field は並べ替えに使用するフィールド名です
order は昇順の場合は 1、降順の場合は -1 です。

たとえば、作成日時の昇順でユーザーを並べ替えるには、sort パラメータに created_at:1 を指定します。

概念

操作方法

リファレンス

ユースケース

検索クエリを使用してユーザーを一覧表示・検索する方法

ユーザーの一覧表示と検索

結果を並べ替える

​ユーザーの一覧表示と検索

​結果を並べ替える

ユーザーの一覧表示と検索

結果を並べ替える