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.ListUsersRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
        Connection: management.String(
            "connection",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Q: management.String(
            "q",
        ),
        SearchEngine: management.SearchEngineVersionsEnumV1.Ptr(),
        PrimaryOrder: management.Bool(
            true,
        ),
    }
    client.Users.List(
        context.TODO(),
        request,
    )
}

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "<string>",
    "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": "<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": "+199999999999999",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "<string>",
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "user_metadata": {},
    "username": "johndoe"
  }
]

Obtener usuarios

Recupere los detalles de los usuarios. Puede:

Especificar criterios de búsqueda para los usuarios
Ordenar los usuarios que se devolverán
Seleccionar los campos que se devolverán
Especificar el número de usuarios que se recuperarán por página y el índice de la página

El parámetro de cadena de consulta q puede usarse para obtener usuarios que coincidan con los criterios especificados mediante la sintaxis de cadena de consulta.

Obtenga más información sobre la búsqueda de usuarios.

Consulte las prácticas recomendadas al trabajar con los endpoint de API para recuperar usuarios.

Auth0 limita la cantidad de usuarios que puede devolver. Si supera este umbral, redefina la búsqueda, use el trabajo de exportación o la extensión User Import / Export.

GET

https://{tenantDomain}/api/v2

users

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.ListUsersRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
        Connection: management.String(
            "connection",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Q: management.String(
            "q",
        ),
        SearchEngine: management.SearchEngineVersionsEnumV1.Ptr(),
        PrimaryOrder: management.Bool(
            true,
        ),
    }
    client.Users.List(
        context.TODO(),
        request,
    )
}

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "<string>",
    "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": "<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": "+199999999999999",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "<string>",
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "user_metadata": {},
    "username": "johndoe"
  }
]

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de consulta

page

integer

Índice de la página de resultados que se devolverá. La primera página es 0.

Rango requerido: x >= 0

per_page

integer

Número de resultados por página.

Rango requerido: 0 <= x <= 100

include_totals

boolean

Devuelva los resultados dentro de un objeto que contenga el recuento total de resultados (true) o como un array directo de resultados (false, valor predeterminado).

sort

string

Campo por el que se ordenará. Use field:order, donde order es 1 para orden ascendente y -1 para orden descendente. Por ejemplo, created_at:1

connection

string

Filtro de conexión. Solo se aplica cuando se usa search_engine=v1. Para filtrar por conexión con search_engine=v2|v3, use q=identities.connection:"connection_name"

fields

string

Lista de campos separados por comas que se incluirán o excluirán (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 se incluirán (true) o excluirán (false).

string

Consulta en sintaxis de cadena de consulta de Lucene. Algunos tipos de consulta no pueden usarse en campos de metadata; para obtener más información, consulte Campos consultables.

search_engine

enum<string>

La versión del motor de búsqueda

Opciones disponibles:

v1,

v2,

v3

primary_order

boolean

Si es true (valor predeterminado), los resultados se devuelven en un orden determinista. Si es false, los resultados pueden devolverse en un orden no determinista, lo que puede mejorar el rendimiento de consultas complejas dirigidas a un número reducido de usuarios. Establézcalo en false solo cuando no se requieran un orden coherente ni paginación.

Respuesta

Usuarios recuperados correctamente.

object[]
object

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

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

string<email>

predeterminado:john.doe@gmail.com

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.

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

last_password_reset

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

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:+199999999999999

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

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.

Eliminar bloqueos de usuario por ID

Crear usuarios