Obtener usuarios del rol

Recupere la lista de usuarios asociados con un rol específico. Para obtener instrucciones del Dashboard, consulte Ver usuarios asignados a roles.

Este endpoint admite dos tipos de paginación:

• Paginación por offset
• Paginación por punto de control

La paginación por punto de control debe usarse si necesita recuperar más de 1000 miembros de una organización.

Paginación por punto de control

Para buscar por punto de control, use los siguientes parámetros:

• from: id opcional a partir del cual iniciar la selección.
• take: La cantidad total de entradas que se recuperarán al usar el parámetro from. El valor predeterminado es 50.

Nota: La primera vez que llame a este endpoint con paginación por punto de control, omita el parámetro from. Si hay más resultados, se incluirá un valor next en la respuesta. Puede usarlo en llamadas posteriores a la API. Cuando next ya no se incluya en la respuesta, no quedarán más páginas.

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

id · string · requerido

ID del rol del que se recuperará la lista de usuarios asociados.

Parámetros de consulta

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

page · integer

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

Rango requerido: x >= 0

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

from · string

Id opcional a partir del cual iniciar la selección.

take · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

Respuesta

200

application/json

Los usuarios del rol se recuperaron correctamente.

Option 1 · object[]

Option 2 · object

Option 3 · object

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

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

name · string

Nombre de este usuario.

picture · string

URL de una imagen de este usuario.

user_id · string

ID de este usuario.