メールアドレスでユーザーを取得する

メールアドレスでユーザーを検索します。Auth0 が IDプロバイダー（IdP）である場合、ユーザーに関連付けられたメールアドレスは、最初にどのような大文字・小文字で指定したかにかかわらず、小文字で保存されます。

たとえば、[e-mail] でユーザーを登録すると、Auth0 はそのユーザーのメールアドレスを [e-mail] として保存します。

そのため、このエンドポイントを使用する場合は、正しい大文字・小文字のメールアドレスでユーザーを検索してください。

GET https://{tenantDomain}/api/v2/users-by-email

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.ListUsersByEmailRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Email: "email",
    }
    client.Users.ListUsersByEmail(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.listUsersByEmail({
        fields: "fields",
        includeFields: true,
        email: "email",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.listUsersByEmail({
        fields: "fields",
        includeFields: true,
        email: "email",
    });
}
main();

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

import requests

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

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-by-email",
  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-by-email")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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.

クエリパラメータ

fields · string

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

include_fields · boolean

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

email · string · 必須

検索するメールアドレス（大文字・小文字を区別）。

レスポンス

200

application/json

ユーザーの検索に成功しました。

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。