GET /api/v2/users-by-email
エンドポイントを使うと、メールアドレスを使用してユーザーを検索できます。この検索では指定したメールアドレスとの完全一致を探し、小文字と大文字を区別します。
このエンドポイントには即時整合性 があるため、次の場合にこのエンドポイントを使用することをお勧めします。
- 認証プロセス中にユーザー検索を実行する
- アカウントリンクプロセスの一部としてユーザー検索を実行する
要求例
必要なスコープ:read:users
get-users-by-emailエンドポイントを使用してユーザーのリストを取得する方法を説明します。
GET /api/v2/users-by-email
エンドポイントを使うと、メールアドレスを使用してユーザーを検索できます。この検索では指定したメールアドレスとの完全一致を探し、小文字と大文字を区別します。
このエンドポイントには即時整合性 があるため、次の場合にこのエンドポイントを使用することをお勧めします。
read:users