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
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListUsersRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
        Connection: management.String(
            "connection",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Q: management.String(
            "q",
        ),
        SearchEngine: management.SearchEngineVersionsEnumV1.Ptr(),
        PrimaryOrder: management.Bool(
            true,
        ),
    }
    mgmt.Users.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUsersRequestParameters;
import com.auth0.client.mgmt.types.SearchEngineVersionsEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().list(
            ListUsersRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .sort("sort")
                .connection("connection")
                .fields("fields")
                .includeFields(true)
                .q("q")
                .searchEngine(SearchEngineVersionsEnum.V_1)
                .primaryOrder(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\Requests\ListUsersRequestParameters;
use Auth0\SDK\API\Management\Types\SearchEngineVersionsEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->list(
    new ListUsersRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'sort' => 'sort',
        'connection' => 'connection',
        'fields' => 'fields',
        'includeFields' => true,
        'q' => 'q',
        'searchEngine' => SearchEngineVersionsEnum::V1->value,
        'primaryOrder' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.list(
    page=1,
    per_page=1,
    include_totals=True,
    sort="sort",
    connection="connection",
    fields="fields",
    include_fields=True,
    q="q",
    search_engine="v1",
    primary_order=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  sort: "sort",
  connection: "connection",
  fields: "fields",
  include_fields: true,
  q: "q",
  search_engine: "v1",
  primary_order: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

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

ユーザーを一覧表示または検索

このエンドポイントはユーザーの詳細を取得します。多少古い結果でも問題にならない、対話的な検索やベストエフォートでの照会に適しています。次のことが可能です。

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

このエンドポイントは重要な処理経路での使用には適していません。データの整合性が最終的に確保される仕組みで、クエリの実行時間も短時間（約 2 秒）に制限されています。そのため、結果が古かったり、負荷の高いクエリでは 503 が返されたりする場合があります。

このエンドポイントを認証、アカウントの連携、ログインフロー内のアクションのロジックに使用しないでください。代わりに、ID またはメールアドレスでユーザーを直接検索して、現在の状態を取得してください。
このエンドポイントを使用して外部システムとユーザーデータを同期しないでください。代わりに、Event Streams を購読し、変更が発生するたびに受信してください。
このエンドポイントを使用してすべてのユーザーを列挙またはエクスポートしないでください。代わりに、ユーザーの一括エクスポートを実行して、全件を取得してください。

q クエリパラメーターを使用すると、クエリ文字列構文で条件に一致するユーザーを検索できます。詳しい手順とガイダンスについては、ユーザーの一覧表示と検索方法を参照してください。

効率よく検索するには、インデックスが付いたトップレベルのフィールドを使い、完全一致で検索してください。自由形式のフィールドや複数値フィールド（app_metadata や user_metadata のユーザー定義属性など）での絞り込みや、先頭にワイルドカードを付けた検索は処理に時間がかかり、タイムアウトする場合があります。

GET

https://{tenantDomain}/api/v2

users

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
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListUsersRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
        Connection: management.String(
            "connection",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Q: management.String(
            "q",
        ),
        SearchEngine: management.SearchEngineVersionsEnumV1.Ptr(),
        PrimaryOrder: management.Bool(
            true,
        ),
    }
    mgmt.Users.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUsersRequestParameters;
import com.auth0.client.mgmt.types.SearchEngineVersionsEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().list(
            ListUsersRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .sort("sort")
                .connection("connection")
                .fields("fields")
                .includeFields(true)
                .q("q")
                .searchEngine(SearchEngineVersionsEnum.V_1)
                .primaryOrder(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\Requests\ListUsersRequestParameters;
use Auth0\SDK\API\Management\Types\SearchEngineVersionsEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->list(
    new ListUsersRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'sort' => 'sort',
        'connection' => 'connection',
        'fields' => 'fields',
        'includeFields' => true,
        'q' => 'q',
        'searchEngine' => SearchEngineVersionsEnum::V1->value,
        'primaryOrder' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.list(
    page=1,
    per_page=1,
    include_totals=True,
    sort="sort",
    connection="connection",
    fields="fields",
    include_fields=True,
    q="q",
    search_engine="v1",
    primary_order=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  sort: "sort",
  connection: "connection",
  fields: "fields",
  include_fields: true,
  q: "q",
  search_engine: "v1",
  primary_order: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

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

承認

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）を指定します。

string

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

search_engine

enum<string>

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

利用可能なオプション:

v1,

v2,

v3

primary_order

boolean

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

レスポンス

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

object[]
object

user_id

string

デフォルト:auth0|507f1f77bcf86cd799439020

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

string<email>

デフォルト:john.doe@gmail.com

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

email_verified

boolean

デフォルト:false

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

username

string

デフォルト:johndoe

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

phone_number

string

デフォルト:+199999999999999

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

phone_verified

boolean

デフォルト:false

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

created_at

string<date-time>

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

updated_at

string<date-time>

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

identities

object[]

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

Show child attributes

app_metadata

object

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

user_metadata

object

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

picture

string

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

name

string

このユーザーの名前。

nickname

string

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

multifactor

string[]

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

multifactor_last_modified

string<date-time>

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

last_ip

string

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

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

last_password_reset

string<date-time>

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

logins_count

integer

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

blocked

boolean

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

given_name

string

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

family_name

string

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