ユーザーの取得

ユーザーの詳細を取得します。以下の操作が可能です。

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

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

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

ユーザー取得用のAPIエンドポイントを使用する際のベストプラクティスを参照してください。

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

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    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,
        ),
    }
    client.Users.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        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({
        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();

curl --request GET \
  --url https://{tenantDomain}/api/v2/users \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/users")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "<string>",
    "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": "<string>"
      }
    ],
    "last_ip": "<string>",
    "last_login": "<string>",
    "last_password_reset": "<string>",
    "logins_count": 123,
    "multifactor": [
      "<string>"
    ],
    "multifactor_last_modified": "<string>",
    "name": "<string>",
    "nickname": "<string>",
    "phone_number": "[phone]",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "<string>",
    "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 object

このユーザーが作成された日時（ISO_8601 形式）。

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

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

email_verified · boolean · デフォルト: false

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

family_name · string

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

given_name · string

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

identities · object[]

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

Show child attributes

last_ip · string

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

last_login · string object

このユーザーが作成された日時（ISO_8601 形式）。

last_password_reset · string object

このユーザーが作成された日時（ISO_8601 形式）。

logins_count · integer

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

multifactor · string[]

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

multifactor_last_modified · string object

このユーザーが作成された日時（ISO_8601 形式）。

name · string

このユーザーの名前。

nickname · string

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

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

このユーザーの電話番号。E.164 の勧告 に準拠します。

phone_verified · boolean · デフォルト: false

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

picture · string

このユーザーの picture、写真、またはアバターの URL。

updated_at · string object

このユーザーが作成された日時（ISO_8601 形式）。

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

他の API とやり取りする際に使用できる、このユーザーの ID。

user_metadata · object

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

username · string · デフォルト: johndoe

このユーザーの username。