ユーザーを取得

ユーザーの詳細を取得します。次のことが可能です。

• ユーザーの検索条件を指定する
• 返されるユーザーを並べ替える
• 返されるフィールドを選択する
• 1 ページあたりに取得するユーザー数とページのインデックスを指定する

q クエリパラメータを使用すると、指定した条件に一致するユーザーを取得できます。クエリ文字列構文を使用します。

ユーザー検索の詳細はこちら。

ユーザーを取得する API エンドポイントを扱う際のベストプラクティスもご確認ください。

Auth0 では返すことができるユーザー数に制限があります。この上限を超える場合は、検索条件を見直すか、export job または User Import / Export extension を使用してください。

GET https://{tenantDomain}/api/v2/users

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.ListAsync(
            new ListUsersRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Sort = "sort",
                Connection = "connection",
                Fields = "fields",
                IncludeFields = true,
                Q = "q",
                SearchEngine = SearchEngineVersionsEnum.V1,
                PrimaryOrder = true
            }
        );
    }

}

200

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "2023-11-07T05:31:56Z",
    "email": "[e-mail]",
    "email_verified": false,
    "family_name": "<string>",
    "given_name": "<string>",
    "identities": [
      {
        "access_token": "<string>",
        "access_token_secret": "<string>",
        "connection": "<string>",
        "isSocial": true,
        "profileData": {
          "email": "<string>",
          "email_verified": true,
          "family_name": "<string>",
          "given_name": "<string>",
          "name": "<string>",
          "phone_number": "<string>",
          "phone_verified": true,
          "username": "johndoe"
        },
        "refresh_token": "<string>",
        "user_id": "abc"
      }
    ],
    "last_ip": "<string>",
    "last_login": "2023-11-07T05:31:56Z",
    "last_password_reset": "2023-11-07T05:31:56Z",
    "logins_count": 123,
    "multifactor": [
      "<string>"
    ],
    "multifactor_last_modified": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "nickname": "<string>",
    "phone_number": "[phone]",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "user_metadata": {},
    "username": "johndoe"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

page · integer

返す結果のページインデックス。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

1 ページあたりの結果数。

必須範囲: 0 <= x <= 100

include_totals · boolean

結果を、合計結果数を含むオブジェクトとして返すか（true）、結果の配列を直接返すか（false、デフォルト）を指定します。

sort · string

並べ替えに使用するフィールド。order には昇順なら 1、降順なら -1 を指定し、field:order の形式を使用します。例: created_at:1

connection · string

接続フィルター。search_engine=v1 を使用する場合にのみ適用されます。search_engine=v2|v3 で接続によるフィルタリングを行うには、q=identities.connection:"connection_name" を使用してください。

fields · string

結果に含める、または除外するフィールドのカンマ区切りリストです（include_fields に指定された値に基づきます）。すべてのフィールドを取得するには空のままにしてください。

include_fields · boolean

指定したフィールドを含めるか（true）、除外するか（false）を指定します。

q · string

Lucene クエリ文字列構文によるクエリです。一部のクエリタイプはメタデータフィールドでは使用できません。詳しくは Searchable Fields を参照してください。

search_engine · enum<string>

検索エンジンのバージョン

利用可能なオプション: v1, v2, v3

primary_order · boolean

true の場合（デフォルト）、結果は決定的な順序で返されます。false の場合、結果は非決定的な順序で返されることがあり、少数のユーザーを対象とする複雑なクエリではパフォーマンスが向上する可能性があります。一貫した並び順やページネーションが不要な場合にのみ false に設定してください。

レスポンス

200

application/json

ユーザーを正常に取得しました。

object[]

object

app_metadata · object

このユーザーが読み取り専用でアクセスできるユーザーメタデータ。

blocked · boolean

このユーザーが管理者によってブロックされている（true）か、されていない（false）か。

created_at · string<date-time>

このユーザーが作成された日時。

email · string<email> · デフォルト: [e-mail]

このユーザーのメールアドレス。

email_verified · boolean · デフォルト: false

このメールアドレスが確認済み（true）か未確認（false）か。

family_name · string

このユーザーの姓/ラストネーム。

given_name · string

このユーザーの名/ファーストネーム。

identities · object[]

アカウントがリンクされている場合の、ユーザー identity オブジェクトの配列。

Show child attributes

last_ip · string

このユーザーが最後にログインした際の IP アドレス。

last_login · string<date-time>

このユーザーが最後にログインした日時。

last_password_reset · string<date-time>

このユーザーのパスワードが最後にリセットされた日時。

logins_count · integer

このユーザーのログイン総回数。

multifactor · string[]

このユーザーが登録済みの多要素認証プロバイダーの一覧。

multifactor_last_modified · string<date-time>

このユーザーの多要素認証プロバイダーが最後に更新された日時。

name · string

このユーザーの名前。

nickname · string

このユーザーの希望するニックネームまたは別名。

phone_number · string · デフォルト: [phone]

このユーザーの電話番号。E.164 の推奨形式に従います。

phone_verified · boolean · デフォルト: false

この電話番号が確認済み（true）か未確認（false）か。

picture · string

このユーザーのプロフィール画像、写真、またはアバターの URL。

updated_at · string<date-time>

このユーザーが最後に更新または変更された日時。

user_id · string · デフォルト: auth0|507f1f77bcf86cd799439020

他の API と連携する際に使用できるユーザー ID。

user_metadata · object

このユーザーが読み取り/書き込みアクセス権を持つユーザーメタデータ。

username · string · デフォルト: johndoe

このユーザーのユーザー名。