Obtenir les utilisateurs par courriel

Recherchez des utilisateurs par courriel. Si Auth0 est le fournisseur d’identité (IdP), l’adresse de courriel associée à un utilisateur est enregistrée en minuscules, quelle que soit la façon dont vous l’avez fournie initialement.

Par exemple, si vous inscrivez un utilisateur avec [e-mail], Auth0 enregistre l’adresse de courriel de l’utilisateur sous la forme [e-mail].

Par conséquent, lorsque vous utilisez ce point de terminaison, assurez-vous de rechercher les utilisateurs par adresse de courriel en respectant la casse.

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

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"
  }
]

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

Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez ce champ vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false). La valeur par défaut est true.

email · string · requis

Adresse de courriel à rechercher (respect de la casse).

Réponse

200

application/json

Utilisateurs trouvés avec succès.

app_metadata · object

Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture seule.

blocked · boolean

Indique si cet utilisateur a été bloqué par un administrateur (true) ou non (false).

created_at · string object

Date et heure de création de cet utilisateur (format ISO_8601).

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

Adresse de courriel de cet utilisateur.

email_verified · boolean · défaut: false

Indique si cette adresse de courriel est vérifiée (true) ou non (false).

family_name · string

Nom de famille de cet utilisateur.

given_name · string

Prénom de cet utilisateur.

identities · object[]

Tableau d’objets d’identité utilisateur lorsque des comptes sont liés.

Show child attributes

last_ip · string

Dernière adresse IP à partir de laquelle cet utilisateur s’est connecté.

last_login · string object

Date et heure de création de cet utilisateur (format ISO_8601).

last_password_reset · string object

Date et heure de création de cet utilisateur (format ISO_8601).

logins_count · integer

Nombre total de connexions effectuées par cet utilisateur.

multifactor · string[]

Liste des fournisseurs d’authentification multifacteur auprès desquels cet utilisateur est inscrit.

multifactor_last_modified · string object

Date et heure de création de cet utilisateur (format ISO_8601).

name · string

Nom de cet utilisateur.

nickname · string

Surnom ou alias préféré de cet utilisateur.

phone_number · string · défaut: [phone]

Numéro de téléphone de cet utilisateur. Il suit la recommandation E.164.

phone_verified · boolean · défaut: false

Indique si ce numéro de téléphone a été vérifié (true) ou non (false).

picture · string

URL de l’image, de la photo ou de l’avatar de cet utilisateur.

updated_at · string object

Date et heure de création de cet utilisateur (format ISO_8601).

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

ID utilisateur pouvant être utilisé lors d’interactions avec d’autres API.

user_metadata · object

Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture et en écriture.

username · string · défaut: johndoe

Nom d’utilisateur de cet utilisateur.