Obtenir l’utilisateur associé au rôle

Récupérer la liste des utilisateurs associés à un rôle donné. Pour les instructions dans Auth0 Dashboard, consultez Afficher les utilisateurs attribués aux rôles.

Ce point de terminaison prend en charge deux types de pagination :

• Pagination par offset
• Pagination par checkpoint

La pagination par checkpoint doit être utilisée si vous devez récupérer plus de 1000 membres d’une organisation.

Pagination par checkpoint

Pour effectuer une recherche par checkpoint, utilisez les paramètres suivants :

• from : ID facultatif à partir duquel commencer la sélection.
• take : nombre total d’entrées à récupérer lors de l’utilisation du paramètre from. La valeur par défaut est 50.

Remarque : la première fois que vous appelez ce point de terminaison avec la pagination par checkpoint, omettez le paramètre from. S’il y a d’autres résultats, une valeur next est incluse dans la réponse. Vous pouvez l’utiliser pour les appels d’API suivants. Lorsque next n’est plus inclus dans la réponse, il n’y a plus de pages.

GET https://{tenantDomain}/api/v2/roles/{id}/users

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"
    roles "github.com/auth0/go-auth0/management/management/roles"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &roles.ListRoleUsersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    client.Roles.Users.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.roles.users.list("id", {
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.roles.users.list("id", {
        from: "from",
        take: 1,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/roles/{id}/users \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/roles/{id}/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/roles/{id}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/roles/{id}/users")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/roles/{id}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "email": "[e-mail]",
    "name": "<string>",
    "picture": "<string>",
    "user_id": "<string>"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

ID du rôle dont vous voulez récupérer la liste des utilisateurs associés.

Paramètres de requête

per_page · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

page · integer

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

Plage requise: x >= 0

include_totals · boolean

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

from · string

ID facultatif à partir duquel commencer la sélection.

take · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

Réponse

200

application/json

Utilisateurs du rôle récupérés avec succès.

Option 1 · object[]

Option 2 · object

Option 3 · object

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

Adresse de courriel de cet utilisateur.

name · string

Nom de cet utilisateur.

picture · string

URL de l’image de cet utilisateur.

user_id · string

ID de cet utilisateur.