Obtener usuarios por correo electrónico

Busque usuarios por correo electrónico. Si Auth0 es el Proveedor de identidad (IdP), la dirección de correo electrónico asociada a un usuario se guarda en minúsculas, independientemente de cómo se haya proporcionado inicialmente.

Por ejemplo, si registra un usuario como [e-mail], Auth0 guarda el correo electrónico del usuario como [e-mail].

Por lo tanto, al usar este endpoint, asegúrese de buscar usuarios por dirección de correo electrónico usando la capitalización correcta.

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

fields · string

Lista de campos separados por comas para incluir o excluir (según el valor proporcionado para include_fields) en el resultado. Déjelo vacío para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false). El valor predeterminado es true.

email · string · requerido

Dirección de correo electrónico que se va a buscar (distingue entre mayúsculas y minúsculas).

Respuesta

200

application/json

Usuarios buscados correctamente.

app_metadata · object

Metadatos de usuario a los que este usuario tiene acceso de solo lectura.

blocked · boolean

Indica si este usuario fue bloqueado por un administrador (true) o no (false).

created_at · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

email · string<email> · predeterminado: [e-mail]

Dirección de correo electrónico de este usuario.

email_verified · boolean · predeterminado: false

Indica si esta dirección de correo electrónico está verificada (true) o no (false).

family_name · string

Apellido de este usuario.

given_name · string

Nombre de pila/primer nombre de este usuario.

identities · object[]

Array de objetos de identidad de usuario cuando las cuentas están vinculadas.

Show child attributes

last_ip · string

Última dirección IP desde la que este usuario inició sesión.

last_login · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

last_password_reset · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

logins_count · integer

Número total de inicios de sesión realizados por este usuario.

multifactor · string[]

Lista de proveedores de autenticación multifactor en los que este usuario se ha inscrito.

multifactor_last_modified · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

name · string

Nombre de este usuario.

nickname · string

Apodo o alias preferido de este usuario.

phone_number · string · predeterminado: [phone]

Número de teléfono de este usuario. Sigue la recomendación E.164.

phone_verified · boolean · predeterminado: false

Indica si este número de teléfono ha sido verificado (true) o no (false).

picture · string

URL de la imagen, foto o avatar de este usuario.

updated_at · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

user_id · string · predeterminado: auth0|507f1f77bcf86cd799439020

ID del usuario que se puede usar al interactuar con otras API.

user_metadata · object

Metadatos del usuario a los que este usuario tiene acceso de lectura y escritura.

username · string · predeterminado: johndoe

Username de este usuario.