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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.ListAsync(
            new ListUsersRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Sort = "sort",
                Connection = "connection",
                Fields = "fields",
                IncludeFields = true,
                Q = "q",
                SearchEngine = SearchEngineVersionsEnum.V1,
                PrimaryOrder = true
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.Users.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUsersRequestParameters;
import com.auth0.client.mgmt.types.SearchEngineVersionsEnum;

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

        client.users().list(
            ListUsersRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .sort("sort")
                .connection("connection")
                .fields("fields")
                .includeFields(true)
                .q("q")
                .searchEngine(SearchEngineVersionsEnum.V_1)
                .primaryOrder(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\Requests\ListUsersRequestParameters;
use Auth0\SDK\API\Management\Types\SearchEngineVersionsEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->list(
    new ListUsersRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'sort' => 'sort',
        'connection' => 'connection',
        'fields' => 'fields',
        'includeFields' => true,
        'q' => 'q',
        'searchEngine' => SearchEngineVersionsEnum::V1->value,
        'primaryOrder' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.list(
    page=1,
    per_page=1,
    include_totals=True,
    sort="sort",
    connection="connection",
    fields="fields",
    include_fields=True,
    q="q",
    search_engine="v1",
    primary_order=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  sort: "sort",
  connection: "connection",
  fields: "fields",
  include_fields: true,
  q: "q",
  search_engine: "v1",
  primary_order: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "2023-11-07T05:31:56Z",
    "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": "abc"
      }
    ],
    "last_ip": "<string>",
    "last_login": "2023-11-07T05:31:56Z",
    "last_password_reset": "2023-11-07T05:31:56Z",
    "logins_count": 123,
    "multifactor": [
      "<string>"
    ],
    "multifactor_last_modified": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "nickname": "<string>",
    "phone_number": "+199999999999999",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "auth0|507f1f77bcf86cd799439020",
    "user_metadata": {},
    "username": "johndoe"
  }
]

Obtenir les utilisateurs

deprecated

Récupère les détails des utilisateurs. Il est possible de :

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

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

En savoir plus sur la recherche d’utilisateurs.

Consultez les pratiques exemplaires 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 retourner. 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

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.ListAsync(
            new ListUsersRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Sort = "sort",
                Connection = "connection",
                Fields = "fields",
                IncludeFields = true,
                Q = "q",
                SearchEngine = SearchEngineVersionsEnum.V1,
                PrimaryOrder = true
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.Users.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUsersRequestParameters;
import com.auth0.client.mgmt.types.SearchEngineVersionsEnum;

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

        client.users().list(
            ListUsersRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .sort("sort")
                .connection("connection")
                .fields("fields")
                .includeFields(true)
                .q("q")
                .searchEngine(SearchEngineVersionsEnum.V_1)
                .primaryOrder(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\Requests\ListUsersRequestParameters;
use Auth0\SDK\API\Management\Types\SearchEngineVersionsEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->list(
    new ListUsersRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'sort' => 'sort',
        'connection' => 'connection',
        'fields' => 'fields',
        'includeFields' => true,
        'q' => 'q',
        'searchEngine' => SearchEngineVersionsEnum::V1->value,
        'primaryOrder' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.list(
    page=1,
    per_page=1,
    include_totals=True,
    sort="sort",
    connection="connection",
    fields="fields",
    include_fields=True,
    q="q",
    search_engine="v1",
    primary_order=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  sort: "sort",
  connection: "connection",
  fields: "fields",
  include_fields: true,
  q: "q",
  search_engine: "v1",
  primary_order: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        sort: "sort",
        connection: "connection",
        fields: "fields",
        includeFields: true,
        q: "q",
        searchEngine: "v1",
        primaryOrder: true,
    });
}
main();

[
  {
    "app_metadata": {},
    "blocked": true,
    "created_at": "2023-11-07T05:31:56Z",
    "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": "abc"
      }
    ],
    "last_ip": "<string>",
    "last_login": "2023-11-07T05:31:56Z",
    "last_password_reset": "2023-11-07T05:31:56Z",
    "logins_count": 123,
    "multifactor": [
      "<string>"
    ],
    "multifactor_last_modified": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "nickname": "<string>",
    "phone_number": "+199999999999999",
    "phone_verified": false,
    "picture": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "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

Index de la page de résultats à retourner. 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

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

sort

string

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

connection

string

Filtre de connexion. S’applique uniquement lors de l’utilisation de 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 ce paramètre 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 en 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 search engine

Options disponibles:

v1,

v2,

v3

primary_order

boolean

Si true (par défaut), les résultats sont retournés dans un ordre déterministe. Si false, les résultats peuvent être retourné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

Les 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<date-time>

Date et heure de création de cet utilisateur.

string<email>

défaut:john.doe@gmail.com

Adresse courriel de cet utilisateur.

email_verified

boolean

défaut:false

Indique si cette adresse 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 la dernière connexion de cet utilisateur.

last_password_reset

string<date-time>

Date et heure de la dernière réinitialisation du mot de passe de cet utilisateur.

logins_count

integer

Nombre total de connexions effectuées par cet utilisateur.

multifactor

string[]

Liste des fournisseurs d’authentification multifacteur auxquels cet utilisateur s’est inscrit.

multifactor_last_modified

string<date-time>

Date et heure de la dernière mise à jour des fournisseurs d’authentification multifacteur de cet utilisateur.

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. Respecte 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<date-time>

Date et heure de la dernière mise à jour/modification de cet utilisateur.

user_id

string

défaut:auth0|507f1f77bcf86cd799439020

ID de l’utilisateur pouvant être utilisé pour interagir 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.