ユーザー取得エンドポイントを使用してユーザーを取得する

get_usersエンドポイントを使用してユーザーのリストを取得する方法を説明します。

GET /api/v2/usersエンドポイントを使うと、ユーザーのリストを取得できます。このエンドポイントを使用すると、次の操作を実行できます。

• さまざまな基準に基づいて検索する
• 返されるフィールドを選択する
• 返された結果を並べ替える

このエンドポイントは結果整合性がある ため、既存のユーザーの表示名を変更するなどのバックオフィスプロセスにはこのエンドポイントを使用することをお勧めします。

​

要求例

ユーザーを検索するには、/api/v2/usersエンドポイントにGET要求を送信します。要求にはManagement APIのアクセストークンが含まれている必要があります。検索クエリをqパラメータに渡し、search_engineパラメータをv3に設定します。

たとえば、メールアドレスが[e-mail]と完全一致するユーザーを検索するには、q=email:"[e-mail]"を使用します。

cURL

curl --request GET \
  --url 'https://{yourDomain}/api/v2/users?q=email%3A%22jane%40exampleco.com%22&search_engine=v3' \
  --header 'authorization: Bearer {yourMgmtApiAccessToken}'

成功すると、次のような応答を受け取ります。

[
  {
    "email": "[e-mail]",
    "email_verified": false,
    "username": "janedoe",
    "phone_number": "[phone]",
    "phone_verified": false,
    "user_id": "auth0|5457edea1b8f22891a000004",
    "created_at": "",
    "updated_at": "",
    "identities": [
      {
        "connection": "Initial-Connection",
        "user_id": "5457edea1b8f22891a000004",
        "provider": "auth0",
        "isSocial": false
      }
    ],
    "app_metadata": {},
    "user_metadata": {},
    "picture": "",
    "name": "",
    "nickname": "",
    "multifactor": [
      ""
    ],
    "last_ip": "",
    "last_login": "",
    "logins_count": 0,
    "blocked": false,
    "given_name": "",
    "family_name": ""
  }
]

​

クエリの例

以下の例は、Management APIを使用して実行できるクエリの種類を紹介するものです。

ユースケース	クエリ
名前に「john」を含むすべてのユーザーを検索する	name:*john*
名前が「jane」と一致するすべてのユーザーを検索する	name:"jane"
名前が「john」で始まるすべてのユーザーを検索する	name:john*
名前が「jane」で始まり「smith」で終わるすべてのユーザーを検索する	name:jane*smith
メールアドレスが「[e-mail]」と一致するすべてのユーザーを検索する	email:"[e-mail]"
ORを使用して、メールアドレスが「[e-mail]」または「[e-mail]」と一致するすべてのユーザーを検索する	email:("[e-mail]" OR "[e-mail]")
メール検証されていないユーザーを検索する	email_verified:false OR NOT _exists_:email_verified
user_metadataのフィールド名がfull_nameで値が「John Smith」のユーザーを検索する	user_metadata.full_name:"John Smith"
指定された接続からのユーザーを検索する	identities.connection:"google-oauth2"
ログインしたことのないすべてのユーザーを検索する	(NOT _exists_:logins_count OR logins_count:0)
2018年よりも前にログインしたすべてのユーザーを検索する	last_login:[* TO 2017-12-31]
最終ログインが2017年12月であるすべてのユーザーを検索する	last_login:{2017-11 TO 2017-12], last_login:[2017-12-01 TO 2017-12-31]
ログイン回数が>= 100、かつ、<= 200であるすべてのユーザーを検索する	logins_count:[100 TO 200]
ログイン回数が>= 100であるすべてのユーザーを検索する	logins_count:[100 TO *]
ログイン回数が>100、かつ、<200であるすべてのユーザーを検索する	logins_count:{100 TO 200}
メールドメインが「xampleco.com」と一致するすべてのユーザーを検索する	email.domain:"exampleco.com"

​

制限事項

エンドポイントは、クエリに一致するユーザーがさらにいる場合でも、最大50人のユーザーを返します。

50人を超えるユーザーを返す必要がある場合は、pageパラメータを使用して、より多くの結果ページを表示します。各ページには50人のユーザーが含まれます。たとえば、&page=2を指定して51～100人目の結果を表示し、&page=3を指定して101～150人目の結果を表示するなどできます。ただし、このエンドポイントは、ページを使用しても、同じ検索条件で合計1000人を超えるユーザーを返すことはありません。

ユーザー検索エンドポイントでインデックス作成、クエリ、返却できるユーザーデータには1ユーザーあたり1MBの制限があります。1MBを超えるカスタムメタデータにこれがどのように影響するかについては、「メタデータフィールド名とデータタイプ」を参照してください。オーバーサイズのユーザープロファイルについては、すべてのユーザー属性を取得するために、ユーザー取得エンドポイントを使用する必要があります。

すべてのユーザーを完全にエクスポートする必要がある場合は、エクスポートジョブまたはユーザーインポート/エクスポート拡張機能を使用します。

エラー414 Request-URI Too Large（要求のURIが長すぎる）が発生した場合は、クエリ文字列がサポートされている長さを超過していることを意味します。その場合には、検索を絞り込みます。

このエンドポイントを次の目的に使用することはお勧めしません 。

• 即時一貫性が必要な操作。代わりに、メールでのユーザー取得エンドポイントまたはIDでのユーザー取得エンドポイントを使用してください。
• ユーザーのエクスポート。代わりに、ユーザーエクスポートエンドポイントを使用してください。
• 認証プロセスの一部としてユーザー検索が必要な操作。代わりに、メールでのユーザー取得エンドポイントまたはIDでのユーザー取得エンドポイントを使用してください。
• メールでのアカウントリンクのユーザー検索。代わりに、メールでのユーザー取得エンドポイントを使用してください。

​

もっと詳しく

• ユーザー検索のクエリ構文
• 検索結果を並べ替える
• ページ毎に検索結果を表示
• 一括ユーザーエクスポート
• APIの呼び出しをチェックする