Search Users by Email

Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.

For example, if you register a user as [e-mail], Auth0 saves the user’s email as [e-mail].

Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Users.ListUsersByEmailAsync(
            new ListUsersByEmailRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                Email = "email"
            }
        );
    }

}

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.users.requests.ListUsersByEmailRequestParameters;

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

        client.users().listUsersByEmail(
            ListUsersByEmailRequestParameters
                .builder()
                .email("email")
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Users\Requests\ListUsersByEmailRequestParameters;

$client = new Management(
    token: '<token>',
);
$client->users->listUsersByEmail(
    new ListUsersByEmailRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'email' => 'email',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

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

require "auth0"

client = Auth0::Management.new(token: "<token>")

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

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>'

200

[
  {
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "email": "[e-mail]",
    "email_verified": false,
    "username": "johndoe",
    "phone_number": "[phone]",
    "phone_verified": false,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "identities": [
      {
        "connection": "<string>",
        "user_id": "abc",
        "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>"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields · boolean

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

email · string · requis

Email address to search for (case-sensitive).

Réponse

200

application/json

Users successfully searched.

user_id · string · défaut: auth0|507f1f77bcf86cd799439020

ID of the user which can be used when interacting with other APIs.

email · string<email> · défaut: [e-mail]

Email address of this user.

email_verified · boolean · défaut: false

Whether this email address is verified (true) or unverified (false).

username · string · défaut: johndoe

Username of this user.

phone_number · string · défaut: [phone]

Phone number for this user. Follows the E.164 recommendation.

phone_verified · boolean · défaut: false

Whether this phone number has been verified (true) or not (false).

created_at · string<date-time>

Date and time when this user was created.

updated_at · string<date-time>

Date and time when this user was last updated/modified.

identities · object[]

Array of user identity objects when accounts are linked.

Show child attributes

app_metadata · object

User metadata to which this user has read-only access.

user_metadata · object

User metadata to which this user has read/write access.

picture · string

URL to picture, photo, or avatar of this user.

name · string

Name of this user.

nickname · string

Preferred nickname or alias of this user.

multifactor · string[]

List of multi-factor authentication providers with which this user has enrolled.

multifactor_last_modified · string<date-time>

Last date and time this user's multi-factor authentication providers were updated.

last_ip · string

Last IP address from which this user logged in.

last_login · string<date-time>

Last date and time this user logged in.

last_password_reset · string<date-time>

Last date and time this user had their password reset.

logins_count · integer

Total number of logins this user has performed.

blocked · boolean

Whether this user was blocked by an administrator (true) or is not (false).

given_name · string

Given name/first name/forename of this user.

family_name · string

Family name/last name/surname of this user.