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.ListUsersByEmailAsync(
            new ListUsersByEmailRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                Email = "email"
            }
        );
    }

}

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUsersByEmailRequestParameters;

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

        client.users().listUsersByEmail(
            ListUsersByEmailRequestParameters
                .builder()
                .email("email")
                .fields("fields")
                .includeFields(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\ListUsersByEmailRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->listUsersByEmail(
    new ListUsersByEmailRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'email' => 'email',
    ]),
);

from auth0.management import ManagementClient

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

client.users.list_users_by_email(
    fields="fields",
    include_fields=True,
    email="email",
)

require "auth0"

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

client.users.list_users_by_email(
  fields: "fields",
  include_fields: true,
  email: "email"
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "2023-11-07T05:31:56Z",
    "email": "john.doe@gmail.com",
    "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": "+199999999999999",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "user_metadata": {},
    "username": "johndoe"
  }
]

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

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

たとえば、JohnSmith@example.com としてユーザー登録すると、Auth0 はそのユーザーのメールアドレスを johnsmith@example.com として保存します。

そのため、この endpoint を使用する場合は、正しい大文字と小文字でメールアドレスを使ってユーザーを検索していることを確認してください。

GET

https://{tenantDomain}/api/v2

users-by-email

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.ListUsersByEmailAsync(
            new ListUsersByEmailRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                Email = "email"
            }
        );
    }

}

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUsersByEmailRequestParameters;

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

        client.users().listUsersByEmail(
            ListUsersByEmailRequestParameters
                .builder()
                .email("email")
                .fields("fields")
                .includeFields(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\ListUsersByEmailRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->listUsersByEmail(
    new ListUsersByEmailRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'email' => 'email',
    ]),
);

from auth0.management import ManagementClient

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

client.users.list_users_by_email(
    fields="fields",
    include_fields=True,
    email="email",
)

require "auth0"

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

client.users.list_users_by_email(
  fields: "fields",
  include_fields: true,
  email: "email"
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "2023-11-07T05:31:56Z",
    "email": "john.doe@gmail.com",
    "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": "+199999999999999",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "user_metadata": {},
    "username": "johndoe"
  }
]

承認

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 です。

string

必須

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

レスポンス

ユーザーを正常に検索しました。

app_metadata

object

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

blocked

boolean

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

created_at

string<date-time>

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

string<email>

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

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

email_verified

boolean

デフォルト:false

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

family_name

string

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

given_name

string

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

identities

object[]

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

Show child attributes

last_ip

string

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

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

last_password_reset

string<date-time>

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

logins_count

integer

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

multifactor

string[]

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

multifactor_last_modified

string<date-time>

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

name

string

このユーザーの名前。

nickname

string

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

phone_number

string

デフォルト:+199999999999999

このユーザーの電話番号。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

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