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

Obtenir les utilisateurs

Récupérez les détails des utilisateurs. Vous pouvez :

spécifier des critères de recherche pour les utilisateurs
trier les utilisateurs à renvoyer
sélectionner les champs à renvoyer
spécifier le nombre d’utilisateurs à récupérer par page ainsi que l’indice de la page

Le paramètre de requête q peut être utilisé pour obtenir les utilisateurs qui correspondent aux critères indiqués à l’aide de la syntaxe de chaîne de requête.

En savoir plus sur la recherche d’utilisateurs.

Consultez les bonnes pratiques lorsque vous utilisez les points de terminaison de l’API pour récupérer des utilisateurs.

Auth0 limite le nombre d’utilisateurs que vous pouvez renvoyer. Si vous dépassez ce seuil, veuillez redéfinir votre recherche, utiliser la tâche d’exportation ou l’extension 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"
  }
]

Autorisations

Authorization

string

header

requis

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

Paramètres de requête

page

integer

Indice de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

per_page

integer

Nombre de résultats par page.

Plage requise: 0 <= x <= 100

include_totals

boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau de résultats direct (false, par défaut).

sort

string

Champ de tri. Utilisez field:order, où order vaut 1 pour l’ordre croissant et -1 pour l’ordre décroissant. Par ex. created_at:1

connection

string

Filtre de connexion. S’applique uniquement lorsque vous utilisez search_engine=v1. Pour filtrer par connexion avec search_engine=v2|v3, utilisez q=identities.connection:"connection_name"

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 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).

string

Requête utilisant la syntaxe de chaîne de requête Lucene. Certains types de requêtes ne peuvent pas être utilisés sur les champs de métadonnées. Pour en savoir plus, consultez Champs interrogeables.

search_engine

enum<string>

La version du moteur de recherche

Options disponibles:

v1,

v2,

v3

primary_order

boolean

Si true (par défaut), les résultats sont renvoyés dans un ordre déterministe. Si false, les résultats peuvent être renvoyés dans un ordre non déterministe, ce qui peut améliorer les performances pour les requêtes complexes ciblant un petit nombre d’utilisateurs. Définissez cette valeur sur false uniquement lorsqu’un ordre cohérent et la pagination ne sont pas requis.

Réponse

Utilisateurs récupérés avec succès.

object[]
object

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

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

string<email>

défaut:john.doe@gmail.com

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é.

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

last_password_reset

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

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

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

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.

Supprimer les blocages d’un utilisateur par id

Créer un utilisateur